Shopify Export Integration V2

Shopify Export Connector V2は、ShopifyのGraphQL Admin APIを使用して、さまざまなShopifyリソースのメタフィールドを作成および更新するように設計されています。より効率的で柔軟なGraphQL APIを活用することで、このバージョンのコネクタは、REST APIエンドポイントを使用していたV1からの大幅なアップグレードとなります。

主な機能

• パフォーマンスと柔軟性を向上させるためのGraphQL API統合
• 複数のリソースタイプにわたるメタフィールドの作成と更新のサポート
• バッチ処理機能
• 包括的なエラー処理と検証
• ShopifyのAPIガイドラインに準拠したレート制限

サポートされるリソースタイプ

コネクタは、次のShopifyリソースのメタフィールド操作をサポートしています:

• Product
• MediaImage（V1のProduct Imageの代わり）
• ProductVariant
• Collection
• Blog
• Page
• DraftOrder
• Customer
• Article
• Shop

• TD Toolbeltを含むTreasure Dataの基本知識。
• Shopifyの基本知識。

Shopifyアプリを設定する際は、使用するリソースとアクションに応じて以下のAPIスコープが付与されていることを確認してください。

• MediaImage vs Product Image—V1からV2への重要な変更は、画像関連のメタフィールドの処理方法です:
  • V1では製品画像のメタフィールドを作成/更新するためにProduct Image IDを使用していましたが、V2ではMediaImage IDが必要です。
  • MediaImageは、さまざまなメディアタイプ（製品画像だけでなく）を参照できる、より汎用性の高いリソースタイプです。
  • V1でProduct Image IDで作成された既存のメタフィールドは、MediaImage IDを使用するように移行する必要があります
• メタフィールドのキーは3〜64文字である必要があります
• 名前空間は3〜255文字である必要があります

セキュリティポリシーで IP ホワイトリストが必要な場合は、接続を成功させるために Treasure Data の IP アドレスを許可リストに追加する必要があります。

リージョンごとに整理された静的 IP アドレスの完全なリストは、次のリンクにあります: IP Addresses for Integrations

最初のステップは、資格情報のセットで新しい認証を作成することです。

1. Integrations Hubを選択します。
2. Catalogを選択します。

3. CatalogでShopifyを検索し、アイコンの上にマウスを置いてCreate Authenticationを選択します。

4. Credentialsタブが選択されていることを確認してから、統合の資格情報を入力します。

新しい認証フィールド

1. Continueを選択します。
2. 認証の名前を入力し、Doneを選択します。

Treasure コンソールは、データをエクスポートする複数の方法をサポートしています。次の手順に従って、Data Workbenchからデータをエクスポートしてください。

1. Data Workbench > Queriesに移動します。
2. New Queryを選択し、クエリを定義します。
3. Export Resultsを選択して、データのエクスポートを設定します。
4. 既存のShopify CAPI認証を選択するか、前述のように新しい認証を作成します。
5. Export Resultsを設定します

6. Doneを選択します。

Shopifyでメタフィールドを作成するには、Shopifyのガイドラインに準拠した必要なフィールドを含むデータエクスポートクエリを構築する必要があります。デフォルトフィールドの場合、列名が「Field/Column-Level Specifications」セクションにリストされているものと一致することを確認してください。コネクタは列名を自動的に正規化してShopifyの必要な形式に一致させるため、大文字と小文字を区別する必要はありません。たとえば、フィールド名が「resource_id」の場合、「RESOURCE_ID」、「Resource_Id」、または「resource_id」と記述でき、コネクタはShopifyの要件に一致するように標準化します。

クエリ結果にtype列を含めない場合、コネクタはvalue列のデータタイプに基づいてメタフィールドタイプを自動的に決定します:

基本タイプ

参照タイプ

リストタイプ

リストタイプは、基本タイプと参照タイプの配列をサポートします。リストタイプにはlist.というプレフィックスが付き、すべてのリストタイプは、各配列要素に適用される基本タイプの検証ルールをサポートします。以下の例は、一般的なリストタイプを示しています。

注意:

Shopifyで既存のメタフィールドを更新するには、必要なフィールドを含むデータエクスポートクエリを構築する必要があります。コネクタは各フィールドのデータ検証とフォーマット要件を自動的に処理します。

エクスポートクエリの仕様

これらのフィールドは更新には必須ではありませんが、検証目的で含めることができます:

Scheduled Jobs と Result Export を使用して、指定したターゲット宛先に出力結果を定期的に書き込むことができます。

Treasure Data のスケジューラー機能は、高可用性を実現するために定期的なクエリ実行をサポートしています。

2 つの仕様が競合するスケジュール仕様を提供する場合、より頻繁に実行するよう要求する仕様が優先され、もう一方のスケジュール仕様は無視されます。

例えば、cron スケジュールが '0 0 1 * 1' の場合、「月の日」の仕様と「週の曜日」が矛盾します。前者の仕様は毎月 1 日の午前 0 時 (00:00) に実行することを要求し、後者の仕様は毎週月曜日の午前 0 時 (00:00) に実行することを要求するためです。後者の仕様が優先されます。

1. Data Workbench > Queries に移動します

2. 新しいクエリを作成するか、既存のクエリを選択します。

3. Schedule の横にある None を選択します。

4. ドロップダウンで、次のスケジュールオプションのいずれかを選択します:

   ドロップダウン値	説明
   Custom cron...	Custom cron... の詳細を参照してください。
   @daily (midnight)	指定されたタイムゾーンで 1 日 1 回午前 0 時 (00:00 am) に実行します。
   @hourly (:00)	毎時 00 分に実行します。
   None	スケジュールなし。

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

次の名前付きエントリを使用できます:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

各フィールド間には単一のスペースが必要です。各フィールドの値は、次のもので構成できます:

1. (オプション) Delay execution を有効にすることで、クエリの開始時刻を遅延させることができます。

クエリに名前を付けて保存して実行するか、単にクエリを実行します。クエリが正常に完了すると、クエリ結果は指定された宛先に自動的にエクスポートされます。

(オプション) Delay execution を有効にすることで、クエリの開始時刻を遅延させることができます。

Audience Studio で activation を作成することで、segment データをターゲットプラットフォームに送信することもできます。

1. Audience Studio に移動します。
2. parent segment を選択します。
3. ターゲット segment を開き、右クリックして、Create Activation を選択します。
4. Details パネルで、Activation 名を入力し、前述の Configuration Parameters のセクションに従って activation を設定します。
5. Output Mapping パネルで activation 出力をカスタマイズします。

• Attribute Columns
  • Export All Columns を選択すると、変更を加えずにすべての列をエクスポートできます。
  • + Add Columns を選択して、エクスポート用の特定の列を追加します。Output Column Name には、Source 列名と同じ名前があらかじめ入力されます。Output Column Name を更新できます。+ Add Columns を選択し続けて、activation 出力用の新しい列を追加します。
• String Builder
  • + Add string を選択して、エクスポート用の文字列を作成します。次の値から選択します:
    • String: 任意の値を選択します。テキストを使用してカスタム値を作成します。
    • Timestamp: エクスポートの日時。
    • Segment Id: segment ID 番号。
    • Segment Name: segment 名。
    • Audience Id: parent segment 番号。

6. Schedule を設定します。

• スケジュールを定義する値を選択し、オプションでメール通知を含めます。

7. Create を選択します。

td queryコマンドの--resultオプションを使用してShopifyサーバーにエクスポートする情報を指定することで、CLI（Toolbelt）を使用してShopifyに結果をエクスポートすることもできます。td queryコマンドの詳細については、TD Toolbelt: Query Commandsを参照してください。

TD Toolbeltで使用される.yml設定ファイルのオプションはJSON形式でフォーマットされており、一般的な構造は次のとおりです。

• メタフィールドの作成用

out:
  type: 'shopify_v2'
  admin_api_access_token: {admin_api_access_token}
  store_name: {store_name}
  action: 'create'
  resource: 'product'
  stop_on_failed_record: false

• メタフィールドの更新用

out:
  type: 'shopify_v2'
  admin_api_access_token: {admin_api_access_token}
  store_name: {store_name}
  action: 'update'
  stop_on_failed_record: false

パラメータ

メタフィールドの作成

td query --result '{"type":"shopify_v2","admin_api_access_token":"admin_api_access_token","store_name":"store_name","action":"create,"resource":"shop", "stop_on_failed_record":true}' -d sample_database "select shop_id,key,namespace,value from tbl_shop" -T presto

メタフィールドの更新

td query --result '{"type":"shopify_v2","admin_api_access_token":"admin_api_access_token","store_name":"store_name","action":"update, "stop_on_failed_record":true}'  -d sample_database "select metafield_id,value from tbl_metafield" -T presto

• 結果エクスポートは、ターゲット宛先に定期的にデータをアップロードするようにスケジュールできます。Scheduling Jobs Using Treasure コンソールを参照してください。
• すべてのインポートおよびエクスポート統合は、Treasure ワークフローに追加できます。td>: データオペレータは、クエリ結果を指定された統合にエクスポートできます。詳細については、Reference for Treasure ワークフロー Operatorsを参照してください。