Shopifyをデータパイプラインソースとして設定 ​

Shopify GraphQL Admin APIを使用して、注文、製品、顧客、トランザクションなどのコマースデータをShopifyストアから転送先に抽出するために、Shopifyをデータパイプラインソースとして設定します。

このガイドを使用して、サポートされている機能の確認、前提条件の完了、Shopifyへの接続、パイプラインの設定を行い、サポートされているオブジェクト、同期モード、スキーマ処理、制限事項を理解します。

サポートされている機能 ​

Shopifyをパイプラインソースとして使用する場合、次の機能がサポートされます。

• 完全同期と増分同期：完全なデータセット、または新規および更新済みレコードのみを同期します。 増分同期では、updated_atなど、各オブジェクトのカーソルフィールドを使用します。
• オブジェクトレベルの選択：同期するShopifyオブジェクトを選択します。 すべてのオブジェクトは、ストアごとに1つのコネクションを通じて利用できます。
• フィールドレベルの選択：任意のオブジェクトを展開し、抽出とスキーマレプリケーションに含める、または除外する特定のフィールドを指定します。
• ソフト削除の追跡：サポートされているオブジェクトについて、キャンセルされた注文やアーカイブされた製品などの状態ベースの削除を、_workato_is_deleted列を通じて追跡します。 詳細については、削除追跡を参照してください。
• スキーマドリフト処理: ソースで新しく追加されたフィールドを自動同期するかブロックするかを選択します。
• フィールドレベルのデータ保護：転送先に到達する前に、フィールド値をそのままレプリケートするか、機密値をハッシュ化します。
• 設定可能な同期頻度：時間ベースまたはcronベースのスケジュールで同期をスケジュールします。 最小間隔は15分です。

前提条件 ​

Shopifyをデータパイプラインソースとして設定する前に、次の要件を満たします。

• アプリをインストールして認可する権限を持つShopifyストア。
• 選択した認証方法の認証情報。 データパイプラインは、コネクションごとに1つのShopifyストアに接続します。
  • OAuth 2.0：Shopifyストアでコネクションを認可する権限。
  • アクセストークン：Shopifyストア内のカスタムアプリから取得したAdmin APIアクセストークン。 詳細については、Shopifyのカスタムアプリを作成してインストールするドキュメントを参照してください。
• Shopify Partnerダッシュボードを通じて付与される、ShopifyからのProtected Customer Data承認。 Shopifyでは、アプリがcustomersおよびordersデータ内のメールアドレス、電話番号、住所などの顧客の個人を特定できる情報（PII）にアクセスする前に、この承認が必要です。 詳細については、ShopifyのProtected customer dataドキュメントを参照してください。
• 60日より古い注文履歴を同期する予定がある場合は、read_all_ordersスコープの承認。 詳細については、推奨権限を参照してください。

推奨権限 ​

コネクションを認可するときに、次の読み取り専用スコープを付与します。 各スコープによって、パイプラインが同期できるオブジェクトが決まります。 データパイプラインに必要なのはread_*スコープのみで、書き込み操作は実行しません。 Shopify認可画面では、共有Shopifyコネクションアプリのデフォルトの一部として、write_*スコープがリクエストされる場合があります。 データパイプラインではこれらを使用しません。

Workatoでは、コネクションを確立するときにスコープを検証しません。 不足しているスコープは、そのスコープを必要とするオブジェクトをパイプラインが同期したときにのみエラーとして表示されます。 パイプラインを実行する前に、付与されたスコープを前の表と照合して確認してください。

サポートされるコネクションタイプ ​

Shopifyデータパイプラインでは、次の認証方法がサポートされています。

• OAuth 2.0：Shopifyストアを通じてコネクションを認可します。 Workatoは、リクエストされたスコープを付与するためにShopifyにリダイレクトします。
• アクセストークン：Shopifyストアで作成されたカスタムアプリから取得したAdmin APIアクセストークンで認証します。 カスタムアプリにはread_all_ordersスコープが自動的に付与されます。

コネクション設定 ​

Shopifyに接続するには、次の手順を実行します。

https://www.workato.com

https://www.workato.com/oauth/callback

https://www.workato.com

https://www.workato.com/oauth/callback

パイプラインの設定 ​

Shopifyをデータパイプラインソースとして設定するには、次の手順を実行します。

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

Shopifyデータパイプラインは、Shopify GraphQL Admin APIからデータを同期します。 次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、宛先内の個別のテーブルとして同期されます。

コアコマース ​

在庫とフルフィルメント ​

マーケティングとコンテンツ ​

拡張 ​

gift_cardsオブジェクトにはShopify Plusプランが必要です。 Plusプランではないストアからこのオブジェクトを同期すると、Shopifyはエラーを返します。

メタフィールドとメタオブジェクト ​

Shopifyストアでは、メタフィールドとメタオブジェクトを通じてカスタムデータをサポートします。 Shopifyデータパイプラインは、次の両方を同期します。

• Metafields：Workatoはストアからメタフィールド定義を検出し、それらを親オブジェクトのテーブルの追加列として含めます。 メタフィールド列は、orders、products、product_variants、customers、draft_orders、locations、collectionsオブジェクトでサポートされています。
• Metaobjects：ストアで定義された各メタオブジェクトタイプは、個別に選択可能なオブジェクトとして利用でき、独自のテーブルとして同期されます。

メタフィールドとメタオブジェクトのスキーマは、ストア内の定義によって異なります。 想定されるメタフィールド列が表示されない場合は、メタフィールド定義がストアに存在することを確認します。

同期モード ​

Shopifyデータパイプラインは、完全同期と増分同期をサポートしています。

フル同期 ​

完全同期では、Shopifyからオブジェクトの完全なデータセットを再抽出します。 shop、locations、gift_cardsオブジェクトは常に完全同期を使用します。 locationsとgift_cardsの削除状態は、各完全同期で再導出されます。 詳細については、削除追跡を参照してください。

増分同期 ​

増分同期では、各オブジェクトのカーソルフィールドを使用して、前回の同期後に作成または更新されたレコードのみを抽出します。 スタンドアロンオブジェクトは、processed_atを使用するtender_transactionsオブジェクトを除き、updated_atフィールドを使用します。

子オブジェクトは親オブジェクトと同期し、独自のフィールドではなく親のカーソルを使用します。 order_line_items、transactions、refunds、fulfillmentsオブジェクトは親注文が同期されると同期され、product_variantsオブジェクトは親製品が同期されると同期され、collection_productsオブジェクトは親コレクションが同期されると同期されます。

削除追跡 ​

Shopifyデータパイプラインは、各オブジェクトの状態フィールドを使用して、サポートされているオブジェクトのソフト削除を追跡します。 レコードがShopifyで削除状態になると、次回の同期時にパイプラインは転送先の_workato_is_deleted列をtrueに設定します。

次のオブジェクトはソフト削除の追跡をサポートしています。

customersとすべての子オブジェクトを含む、その他すべてのオブジェクトには_workato_is_deleted列は含まれません。

ハード削除はどのオブジェクトでも追跡されません。 詳細については、ハード削除は追跡されないを参照してください。

スキーマとデータ型の処理 ​

Shopifyデータパイプラインは、ネストされたGraphQL構造をリレーショナル列にフラット化します。

金額 ​

金額フィールドは、ストア通貨と表示通貨を対象として、フィールドごとに4つの列に展開されます：{field}_set_shop_amount、{field}_set_shop_currency_code、{field}_set_presentment_amount、{field}_set_presentment_currency_code。 たとえば、注文の合計価格は、total_price_set_shop_amount、total_price_set_shop_currency_code、total_price_set_presentment_amount、total_price_set_presentment_currency_codeとして同期されます。

住所 ​

住所オブジェクトは、billing_address_address_1、billing_address_city、billing_address_country_codeなど、個別のコンポーネント列にフラット化されます。 配送先住所は、shipping_address_プレフィックスを持つ同じコンポーネントにフラット化されます。

タグ ​

タグリストは、カンマ区切りの単一文字列列として同期されます。

レコードID ​

レコードIDは、Shopify GraphQLグローバルIDではなく数値IDとして同期されます。 たとえば、製品はgid://shopify/Product/123456789ではなく、ID123456789で同期されます。

合成列 ​

Workatoは、特定のオブジェクトの同期先テーブルに次の合成列を追加します:

この列を設定する状態変更については、削除の追跡を参照してください。

機密データの処理 ​

Shopifyオブジェクトには、顧客の個人を特定できる情報（PII）が含まれる場合があります。 次のオブジェクトには、一般的に機密フィールドが含まれます:

Shopifyは、Protected Customer Data承認によって顧客PIIへのアクセスを制御します。 詳細については、前提条件を参照してください。

パイプライン設定中にフィールドレベルのデータ保護でHashオプションを使用し、PIIが宛先に到達する前に保護します。 詳細については、パイプラインを構成手順を参照してください。

制限事項 ​

Shopifyをデータパイプラインソースとして使用する場合、次の制限事項が適用されます。

ハード削除は追跡されない ​

Shopifyは、ハード削除されたレコードを削除マーカーなしでAPIから削除します。 Shopify管理画面でレコードがハード削除されると、パイプラインはシグナルを受信せず、レコードは転送先に無期限に残ります。 これはすべてのオブジェクトタイプに適用されます。

削除された製品のバリアントなど、ハード削除された親の子レコードも転送先に残り、削除済みとしてマークされることはありません。

古いレコードが下流のユースケースに影響する場合は、転送先で定期的な照合プロセスを計画してください。 キャンセルされた注文やアーカイブされた製品などのソフト削除は、サポートされているオブジェクトについて追跡されます。 詳細については、削除追跡を参照してください。

Ordersオブジェクトは下書き注文と放棄されたチェックアウトを除外 ​

ordersオブジェクトは、完了済みの顧客注文のみを同期します。 Shopify管理画面で下書き注文が完了済み注文と一緒に表示される場合でも、下書き注文と放棄されたチェックアウトはordersオブジェクトに含まれません。 このデータを含める予定がある場合は、draft_ordersオブジェクトとabandoned_checkoutsオブジェクトを個別に同期します。

注文履歴にはread_all_ordersスコープが必要 ​

アプリがread_all_ordersスコープについて承認されていない限り、Shopifyは注文データを過去60日間に制限します。 完全な注文履歴を同期する予定がある場合は、初回同期の前にShopify Partnerダッシュボードを通じて承認をリクエストしてください。 承認には通常2～4週間かかります。 Shopify管理画面で直接作成されたカスタムアプリには、このスコープが自動的に付与されます。

子レコードの更新は親の更新に依存 ​

すべての子オブジェクトは、親レコードのカーソルフィールドが変更されたときに同期されます。 これは、order_line_items、transactions、refunds、fulfillmentsオブジェクト（ordersの子）、product_variantsオブジェクト（productsの子）、およびcollection_productsオブジェクト（collectionsの子）に適用されます。 親のupdated_atタイムスタンプを更新しない子レコードへの変更は、親が変更されるまで増分同期で取得されません。 子のみの変更をすぐに取得する必要がある場合は、完全同期を実行します。

顧客データの編集削除 ​

Shopifyは、GDPRリクエストに準拠するために顧客PIIを編集削除する場合があります。 編集削除された顧客レコードは、フィールドがスクラブされたレコードシェルとしてShopifyに残る場合があり、これらのシェルは転送先に同期されます。 Shopifyによって完全に削除された顧客レコードは、削除済みとして検出されません。 詳細については、ハード削除は追跡されないを参照してください。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。 これより高い頻度で同期をトリガーすることはできません。