🍀

【Shopify.dev和訳】API usage/Access scopes

2021/09/09に公開約10,300字

この記事について

この記事は、API usage/Access scopesの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Shopify API のアクセススコープ | Shopify API Access scopes

アプリケーションの承認過程の一部では、アプリケーションがショップのどの部分にアクセスするのかを指定する必要があります。アプリケーションでは、以下にリスト化されている認証済みまたは未認証のアクセススコープのいずれかを要求できます。

GraphQLRESTの両方で Admin API 介して利用可能なAccessScopeリソースを使用してアプリケーションに付与されたアクセススコープを確認できます。

認証されたアクセススコープ | Authenticated access scopes

認証されたアクセススコープは、REST Admin APIおよびGraphQL Admin APIでリソースへのアクセスをコントロールします。認証されたアクセスは、マーチャントに代わってストアと相互作用し、商品を作成したり、割引コードの管理をしたりなどのアクションを実行することを目的としています。

  • read_content,write_content
    ArticleBlogCommentPageRedirectにアクセスできます。
  • read_themes, write_themes
    AssetThemeにアクセスできます。
  • read_products, write_products
    ProductProduct VariantProduct ImageCollectCustom CollectionSmart Collectionにアクセスできます。
  • read_product_listings
    Product ListingCollection Listingにアクセスできます。
  • read_customers, write_customers
    CustomerSaved Searchにアクセスできます。
  • read_orders, write_orders
    Abandoned checkoutsCustomerFulfillmentOrderTransactionにアクセスできます。
  • read_all_orders
    60 日分の注文のデフォルトウィンドウではなく、全ての注文へのアクセスを許可します。この OAuth スコープは、read_ordersまたはwrite_ordersと組み合わせて使用されます。このスコープをアプリケーションに追加する前に、Partner Dashboard からこのスコープをリクエストする必要があります。
  • write_order_edits
    GraphQL Admin API のorder editing機能にアクセスできます。
  • read_draft_orders, write_draft_orders
    Draft Orderにアクセスできます。
  • read_inventory, write_inventory
    Inventory LevelInventory Itemにアクセスできます。
  • read_locations
    Locationにアクセスできます。
  • read_script_tags, write_script_tags
    Script Tagにアクセスできます。
  • read_fulfillments, write_fulfillments
    Fulfillment Serviceにアクセスできます。
  • read_assigned_fulfillment_orders, write_assigned_fulfillment_orders
    fulfillment serviceによって管理された場所に割り当てられたFulfillmentOrderリソースへのアクセスができます。
  • read_merchant_managed_fulfillment_orders, write_merchant_managed_fulfillment_orders
    マーチャントが管理する場所に割り当てられたFulfillmentOrderリソースにアクセスできます。
  • read_third_party_fulfillment_orders, write_third_party_fulfillment_orders
    fulfillment serviceによって管理される場所に割り当てられたFulfillmentOrderリソースへのアクセスができます。
  • read_shipping, write_shipping
    Carrier ServiceCountryProvinceにアクセスできます。
  • read_gift_cards, write_gift_cards
    Gift Cardにアクセスできます。(SHOPIFY PLUN の場合)
  • read_users, write_users
    Userにアクセスできます。(SHOPIFY PLUN の場合)
  • read_checkouts, write_checkouts
    Checkoutsにアクセスできます。
  • read_reports, write_reports
    Reportsにアクセスできます。
  • read_price_rules, write_price_rules
    Price Rulesにアクセスできます。
  • read_discounts, write_discounts
    GraphQL Admin API のDiscounts features.にアクセスできます。
  • read_marketing_events, write_marketing_events
    Marketing Eventにアクセスできます。
  • read_resource_feedbacks, write_resource_feedbacks
    ResourceFeedbackにアクセスできます。
  • read_shopify_payments_payouts
    Shopify Payments のPayoutBalanceTransactionにアクセスできます。
  • read_shopify_payments_disputes
    Shopify Payments のDisputeリソースへのアクセスができます。
  • read_translations, write_translations
    Translatable Resourceにアクセスできます。
  • read_locales, write_locales
    Shop Localeにアクセスできます。

認証されていないアクセススコープ | Unauthenticated access scopes

認証されていないアクセススコープは、Storefront APIのオブジェクトへのアクセスをコントロールします。認証されていないアクセスは、カスタマーに代わって店舗とやり取りし、商品の表示やチェックアウトの開始などのアクションを実行することを目的としています。

アプリケーションは、Storefront API にリクエストをするために Storefront API トークン(Admin API アクセストークンとは分けて)を必要とします。

プライベートアプリケーションの場合、Storefront API アクセスを有効にした後、プライベートアプリケーションのセットアップページからアクセストークンをコピーして貼り付けることができます。パブリックアプリケーションとカスタムアプリケーションは、インストール後に Admin API を使用してStorefrontAccess Token REST リソースまたはstoreFrontAccess Token Create GraphQL ミューテーションを使用して Storefront API アクセストークンを作成できます。アプリケーションが作成するアクセストークンは、そのアプリケーションに付与された認証されていないアクセススコープを自動的に継承します。

アプリケーションは、次の認証されていないスコープをリクエストできます:

  • unauthenticated_read_product_listings
    ProductCollectionオブジェクトの読み取りに認証されていないアクセスができます。
  • unauthenticated_read_product_tags
    Productオブジェクトのtagsフィールドの読み取りに認証されていないアクセスができます。
  • unauthenticated_write_checkouts,unauthenticated_read_checkouts
    Checkoutオブジェクトに認証されていないアクセスができます。
  • unauthenticated_write_customers,unauthenticated_read_customers
    Customerオブジェクトに認証されていないアクセスができます。
  • unauthenticated_read_customer_tags
    Customer オブジェクトのtagsフィールドの読み取りに認証されていないアクセスができます。
  • unauthenticated_read_content
    ArticleBlogCommentオブジェクトなどの storefront content の読み取りに認証されていないアクセスができます。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Discussion

ログインするとコメントできます