記事のサマリー(TL;DR)
- 本日より、アプリがGraphQL Admin APIでバルククエリ(
bulkOperationRunQuery)やバルクミューテーション(bulkOperationRunMutation)を実行するには、事前にバルク操作へのアクセスをPartner Dashboardで有効化する必要があります。 - 対象は、パートナーが構築する公開アプリおよびカスタムアプリです。マーチャントがShopify管理画面やDev Dashboardで作成するアプリは現時点では対象外です。
- 過去31日間にバルククエリまたはバルクミューテーションを実行していないアプリは、該当する操作タイプへのアクセスを失います。その場合はPartner Dashboardから再度有効化する必要があります。
変更内容が適用される条件
バルククエリとバルクミューテーションは、それぞれ個別に有効化する仕組みです。bulkOperationRunQuery を実行するにはバルククエリへのアクセスが、bulkOperationRunMutation を実行するにはバルクミューテーションへのアクセスが必要です。アクセスがない状態でバルク操作を開始すると、リクエストはアクセス拒否エラーを返します。この要件は、GraphQL Admin APIの全バージョンに適用されます。
詳細
何が変更されたか
これまでとは異なり、バルククエリとバルクミューテーションの実行には、事前にPartner Dashboardでのアクセス許可が必要になりました。アクセスが有効化されていない状態でバルク操作を開始した場合、リクエストはアクセス拒否エラーとなります。この要件はGraphQL Admin APIのすべてのバージョンに適用されます。
対象となるアプリ
対象は、パートナーが構築する公開アプリおよびカスタムアプリのうち、バルク操作を実行するものです。マーチャントがShopify管理画面またはDev Dashboardで作成するアプリは、現時点では影響を受けません。
すでにバルク操作を実行しているアプリについては、Shopify側であらかじめアクセスを有効化済みです。この状態はPartner Dashboardで確認できます。
ただし、過去31日間にバルククエリまたはバルクミューテーションを一度も実行していないアプリは、該当する操作タイプへのアクセスを失います。アクセスを失った場合は、以下の手順で再度有効化する必要があります。
対応方法
アプリのアクセス状況を確認し、実行する操作タイプを有効化する手順は次のとおりです。
- Partner Dashboardから「Apps」に移動し、対象のアプリを選択します。
- サイドバーで「API access requests」をクリックします。
- 「Run bulk operations」の項目で、「Allow bulk queries」または「Allow bulk mutations」(あるいは両方)をクリックします。
すでに有効化されている操作タイプについては、そのセクションに有効化済みであることが表示されます。
この対応にあたり、アプリの設定変更、新しいアプリバージョンのリリース、マーチャントへの再インストール依頼は不要です。有効化したアクセスは、そのアプリがインストールされているすべてのストアに適用されます。
詳細は「Enabling access to bulk operations」のドキュメントを参照するよう案内されています。