Shopify Export Integration V2

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Cursorに接続

  CursorにMCPサーバーをインストール
• VS Codeに接続

  VS CodeにMCPサーバーをインストール

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の基本知識。

制限事項と既知の問題

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

Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/

TD Consoleを使用

認証の作成

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

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

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

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

新しい認証フィールド

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

エクスポート用のクエリ結果を設定

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

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

6. Doneを選択します。

Create Metafieldアクションの詳細ガイド

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

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

フィールド/列レベルの仕様

デフォルトフィールド列

自動タイプ検出

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

タイプ別の値仕様

基本タイプ

参照タイプ

リストタイプ

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

注意:

Update Metafieldアクションの詳細ガイド

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

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

必須列

オプション列

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

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

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

The following named entries can be used:

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

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to Audience Studio.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select Create Activation.
4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the Output Mapping panel.

• Attribute Columns
  • Select Export All Columns to export all columns without making any changes.
  • Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
• String Builder
  • + Add string to create strings for export. Select from the following values:
    • String: Choose any value; use text to create a custom value.
    • Timestamp: The date and time of the export.
    • Segment Id: The segment ID number.
    • Segment Name: The segment name.
    • Audience Id: The parent segment number.

6. Set a Schedule.

• Select the values to define your schedule and optionally include email notifications.

7. Select Create.

（オプション）CLIを使用したエクスポート統合

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

パラメータ

CLI使用例

メタフィールドの作成

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 TD Consoleを参照してください。
• すべてのインポートおよびエクスポート統合は、TD Workflowに追加できます。td>: データオペレータは、クエリ結果を指定された統合にエクスポートできます。詳細については、Reference for Treasure Workflow Operatorsを参照してください。