Dynamic Yield コネクタ構成ガイド
この記事では、Dynamic Yield コネクタの構成方法について説明します。
アクション
| アクション名 | AudienceStream | EventStream |
|---|---|---|
| ページビューを記録 | ✗ | ✓ |
| イベントを送信 | ✓ | ✓ |
| イベントをバッチで送信 | ✓ | ✓ |
| エンゲージメントを記録 | ✗ | ✓ |
| エンゲージメントをバッチで報告 | ✗ | ✓ |
| ユーザーのアップサートまたは削除 | ✓ | ✗ |
| ユーザーのアップサートまたは削除（バッチ） | ✓ | ✓ |
構成
コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法については、コネクタについてを参照してください。
コネクタを追加した後、以下の構成を構成します：
- ホスト
- （必須）Dynamic Yield プロジェクトに関連付けられたホストを選択します。
- EUベースのAPIエンドポイントを指定する場合は https://dy-api.eu を使用し、USベースのAPIエンドポイントを指定する場合は https://dy-api.com を使用します。
- API キー
- （必須）Dynamic Yield のAPIキー。
アクション
以下のセクションでは、各アクションに対応するサポートされるパラメータをリストアップします。
ページビューを記録
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザーID | ユニークなユーザーID。有効な値は dyid または dyid_server です。 |
| Dynamic Yield によって生成されたセッション識別子 | _dyjsession クッキーが存在する場合はその値を渡します。そうでない場合は、新しいセッション識別子が Dynamic Yield によって作成され、レスポンスで返されます。 |
| ページタイプ | （必須）ページのタイプ。有効なフィールドは：HOMEPAGE, CATEGORY, PRODUCT, CART, OTHER です。 |
| ページの場所 | デバイスまたはアプリケーションのタイプ。アプリまたはサイト内の現在の場所に応じて体験やキャンペーンをターゲティングするために使用します。有効なフィールドは：Webの場合はページURL、SPAの場合は場所、モバイルアプリの場合は画面名です。 |
| ページリファラ | ページリファラドメイン。サイトまたはアプリの前の場所に応じて体験をターゲティングするために使用します。 |
| ページロケール | ページのロケールコード、例えば en_US。 |
| ページデータ | ページタイプに関連する追加データ。PRODUCTタイプのページの場合は製品SKUなど。カテゴリーと製品のページにのみ必要です。ホームページやその他のタイプには使用しないでください。 |
| デバイスIP | IPフィルタリングのためのクライアントIPアドレス。この値が渡されない場合、呼び出し元のIPが使用されます。 |
| チャンネル | 監視するチャンネル。有効なフィールドは：Web、App、Kioskです。 |
| アクティブな同意が承認されました | ユーザーの同意決定。有効なフィールドは：true または falseです。このパラメータを送信しない場合、APIはデフォルトで false に構成されます。 |
イベントを送信
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザーID | ユニークなユーザーID。有効な値は dyid または dyid_server です。 |
| Dynamic Yield によって生成されたセッション識別子 | _dyjsession クッキーの値が存在する場合はその値を渡します。そうでない場合は、新しいセッション識別子が Dynamic Yield によって作成され、レスポンスで返されます。 |
| 名前 | （必須）イベントを説明するための人間が読める名前。通常はスキーマ名に対応しており、標準イベントを識別するために使用されます。 |
| DYタイプ | 標準イベント識別子。 |
| 値 | 支払い通貨でのイベントの総金額。例えば、カートの総購入額。有効なフィールドは：add-to-cart-v1, purchase-v1, remove-from-cart-v1, sync-cart-v1です。 |
| 通貨 | 支払い通貨。有効なフィールドは：add-to-cart-v1, purchase-v1, remove-from-cart-v1, sync-cart-v1です。 |
| 商品ID | 商品フィードに正確に表示されるSKU。有効なフィールドは：add-to-cart-v1, add-to-wishlist-v1, remove-from-cart-v1です。 |
| 数量 | カートに追加されたアイテムの総数。有効なフィールドは：add-to-cart-v1, remove-from-cart-v1です。 |
| ユニークトランザクションID | トランザクションIDに対して重複したイベントが報告されても、トランザクションIDごとに購入が1回のみ記録されることを保証します。有効なフィールドは：purchase-v1です。 |
| CUID | ユーザー識別子値。有効なフィールドは：identify-v1, login-v1, signup-v1, newsletter-subscription-v1です。 |
| CUIDタイプ | ユーザー識別子値のタイプ。この値を使用してデバイス間でユーザーを識別します。例えば、customer_id, account_id, emailなど。
|
| ハッシュ化されたメール | 小文字のメールアドレスのSHA-256エンコーディング。cuidおよびcuidTypeの代わりにこの識別子タイプを使用できます。有効なフィールドは：identify-v1, login-v1, signup-v1, newsletter-subscription-v1, message-optout-v1です。 |
| 電話番号 | SMSチャンネルでユーザーを識別するためにこの識別子タイプを使用します。Reconnectキャンペーンで使用します。有効なフィールドは：login-v1です。 |
| プレーンテキストメール | 有効なプレーンテキストのメールアドレス。plainTextEmailまたはexternalIdのいずれかを使用します。有効なフィールドは：message-optin-v1です。 |
| 外部ID | ユーザーを識別するために使用される外部ID。あなたのESPはこのIDを認識し、それをメールアドレスにマッピングできる必要があります。plainTextEmailまたはexternalIdのいずれかを使用し、両方は使用しないでください。注： 外部IDタイプはカスタムESPおよびEmarsys統合にのみ対応しています。有効なフィールドは：message-optin-v1, message-optout-v1です。 |
| サイズ | 商品のサイズ。有効なフィールドは：add-to-wishlist-v1です。 |
| フィルタータイプ | フィルター名。例えば、色、サイズ、ブランド、フィット、著者、またはキーワード。商品フィードの商品プロパティに対応する必要があります。有効なフィールドは：filter-items-v1です。 |
| フィルター数値値 | セグメンテーション条件の楽しさを決定する値。このプロパティまたはfilterStringValueの値を指定します。有効なフィールドは：filter-items-v1です。 |
| フィルター文字列値 | セグメンテーション条件の楽しさを決定する値。このプロパティまたはfilterNumericValueの値を指定します。有効なフィールドは：filter-items-v1です。 |
| 属性タイプ | 属性タイプ。例えば、色、サイズ、フィット、ブランド、または著者。有効なフィールドは：change-attr-v1です。 |
| 属性値 | 新しい属性値。例えば、新しい色はグレーです。有効なフィールドは：change-attr-v1です。 |
| ソート順 | 価格、年齢、人気、評価など、あなたが許可する他のソートパラメータ。有効なフィールドは：sort-items-v1です。 |
| ソート順序 | ASCまたはDESC。有効なフィールドは：sort-items-v1です。 |
| コード | プロモーションコード。有効なフィールドは：enter-promo-code-v1です。 |
| キーワード | 検索文字列。有効なフィールドは：keyword-search-v1です。 |
| アイテムID | コンテンツフィードのアイテムIDに一致するID。有効なフィールドは：video-watch-v1です。 |
| カテゴリ | ビデオカテゴリの配列。有効なフィールドは：video-watch-v1です。 |
| 自動再生 | ビデオが自動的に再生されたか（true）、ユーザーのアクションによるものか（false）を示します。デフォルトはfalseです。有効なフィールドは：video-watch-v1です。 |
| 進行状況 | ビデオが再生された量を説明します。可能な値：
|
| 進行パーセント | ビデオがどれだけ視聴されたかをパーセンテージで示します。有効なフィールドは：video-watch-v1です。 |
| 商品ID | 商品識別子の配列。 |
| 数量 | 商品数量の配列。 |
| アイテム価格 | ドル.セント形式のアイテム価格の配列。 |
| アクティブな同意の受け入れ | ユーザーの同意決定。有効なフィールドは：trueまたはfalseです。このパラメータを送信しない場合、APIはデフォルトでfalseに構成されます。 |
| 店舗ID | ユニークな店舗識別子。例えば、レストランの推薦のためです。 |
| 店舗の日時部分 | 1日の時間に基づいてキャンペーンを区別するために使用します。 |
| デバイスIP | IPフィルタリングのためのクライアントIPアドレス。渡されない場合、呼び出し元のIPが使用されます。 |
| デバイスユーザーエージェント | Webベースのクライアントの場合、ユーザーエージェント文字列。渡されない場合、APIゲートウェイはHTTPSリクエストでそのヘッダーをチェックします。 |
| カスタムイベントプロパティ | 共有したいカスタムイベントプロパティ。例えば、product_categoryやcoupon_codeです。イベントプロパティvalueおよびcurrencyは予約済みプロパティであり、ここにマッピングすることはできません。 |
イベント送信（バッチ）
バッチ制限
このアクションは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます：
- 最大リクエスト数：10
- 最古のリクエストからの最大時間：5分
- リクエストの最大サイズ：1 MB
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザーID | ユニークなユーザーID。有効な値は dyid または dyid_server です。 |
| Dynamic Yield によって生成されたセッション識別子 | _dyjsession クッキーの値が存在する場合はその値を渡します。そうでない場合は、新しいセッション識別子が Dynamic Yield によって作成され、レスポンスで返されます。 |
| 名前 | （必須）イベントを説明するための人間が読める名前。通常はスキーマ名に対応しており、標準イベントを識別するために使用されます。 |
| DYタイプ | 標準イベント識別子。 |
| 値 | 支払い通貨でのイベントの総金額。例えば、カートの総購入額。有効なフィールドは：add-to-cart-v1, purchase-v1, remove-from-cart-v1, sync-cart-v1。 |
| 通貨 | 支払い通貨。有効なフィールドは：add-to-cart-v1, purchase-v1, remove-from-cart-v1, sync-cart-v1。 |
| 商品ID | 商品フィードに正確に表示されるSKU。有効なフィールドは：add-to-cart-v1, add-to-wishlist-v1, remove-from-cart-v1。 |
| 数量 | カートに追加されたアイテムの総数。有効なフィールドは：add-to-cart-v1, remove-from-cart-v1。 |
| ユニークトランザクションID | トランザクションIDに対して重複したイベントが報告されても、トランザクションIDごとに購入が1回のみ記録されることを保証します。有効なフィールドは：purchase-v1 |
| CUID | ユーザー識別子値。有効なフィールドは：identify-v1, login-v1, signup-v1, newsletter-subscription-v1。 |
| CUIDタイプ | ユーザー識別子値のタイプ。この値を使用してデバイス間でユーザーを識別します。例えば、customer_id, account_id, email。
|
| ハッシュ化されたメール | 小文字のメールアドレスのSHA-256エンコーディング。cuidおよびcuidTypeの代わりにこの識別子タイプを使用できます。有効なフィールドは：identify-v1, login-v1, signup-v1, newsletter-subscription-v1, message-optout-v1。 |
| 電話番号 | SMSチャンネルでユーザーを識別するためにこの識別子タイプを使用します。有効なフィールドは：login-v1。 |
| プレーンテキストメール | 有効なプレーンテキストのメールアドレス。plainTextEmailまたはexternalIdのいずれかを使用します。有効なフィールドは：message-optin-v1。 |
| 外部ID | ユーザーを識別するために使用される外部ID。あなたのESPはこのIDを認識し、メールアドレスにマッピングできる必要があります。plainTextEmailまたはexternalIdのいずれかを使用し、両方は使用しないでください。注: 外部IDタイプはカスタムESPおよびEmarsys統合にのみ対応しており、SendGridやResponsysでは対応していません。例えば、(message-optin-v1, message-optout-v1)。 |
| サイズ | 商品のサイズ。有効なフィールドは：add-to-wishlist-v1。 |
| フィルタータイプ | フィルター名。例えば、色、サイズ、ブランド、フィット、著者、キーワードなど。商品フィードの商品プロパティに対応する必要があります。有効なフィールドは：filter-items-v1 |
| フィルター数値値 | セグメント条件の楽しさを決定する値。このプロパティまたはfilterStringValueの値を指定します。有効なフィールドは：filter-items-v1 |
| フィルター文字列値 | セグメント条件の楽しさを決定する値。このプロパティまたはfilterNumericValueの値を指定します。有効なフィールドは：filter-items-v1 |
| 属性タイプ | 属性タイプ。例えば、色、サイズ、フィット、ブランド、著者など。有効なフィールドは：change-attr-v1。 |
| 属性値 | 新しい属性値。例えば、新しい色はグレーです。有効なフィールドは：change-attr-v1。 |
| ソート順 | 価格、年齢、人気、評価など、あなたが許可する他の任意のソートパラメータ。有効なフィールドは：sort-items-v1。 |
| ソート順序 | ASCまたはDESC。有効なフィールドは：sort-items-v1。 |
| コード | プロモーションコード。有効なフィールドは：enter-promo-code-v1。 |
| キーワード | 検索文字列。有効なフィールドは：keyword-search-v1。 |
| アイテムID | コンテンツフィードのアイテムIDに一致するID。有効なフィールドは：video-watch-v1。 |
| カテゴリ | ビデオカテゴリの配列。有効なフィールドは：video-watch-v1。 |
| 自動再生 | ビデオが自動的に再生されたか（true）、ユーザーのアクションによるものか（false）を示します。デフォルトはfalseです。有効なフィールドは：video-watch-v1。 |
| 進行状況 | ビデオの再生量を説明します。可能な値：
|
| 進行パーセント | ビデオがどれだけ視聴されたかをパーセンテージで示します。有効なフィールドは：video-watch-v1。 |
| 商品ID | 商品識別子の配列。 |
| 数量 | 商品数量の配列。 |
| アイテム価格 | ドル.セント形式のアイテム価格の配列。 |
| アクティブな同意が受け入れられました | ユーザーの同意決定。有効なフィールドは：true または false。このパラメータを送信しない場合、APIのデフォルトは false です。 |
| 店舗ID | ユニークな店舗識別子。例えば、レストランの推薦のためです。 |
| 店舗の日時部分 | 1日の時間に基づいてキャンペーンを区別するために使用します。 |
| デバイスIP | IPフィルタリングのためのクライアントIPアドレス。渡されない場合、呼び出し元のIPが使用されます。 |
| デバイスユーザーエージェント | Webベースのクライアントの場合、ユーザーエージェント文字列。渡されない場合、APIゲートウェイはHTTPSリクエストでそのヘッダーをチェックします。 |
| カスタムイベントプロパティ | 共有したいカスタムイベントプロパティ。例えば、product_category や coupon_code。イベントプロパティ value と currency は予約されたプロパティであり、ここにマッピングすることはできません。 |
エンゲージメントの記録
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザーID | ユニークなユーザーID。有効な値は dyid または dyid_server です。 |
| Dynamic Yield によって生成されたセッション識別子 | _dyjsession クッキーの値が存在する場合はその値を渡します。そうでない場合は、新しいセッション識別子が Dynamic Yield によって作成され、レスポンスで返されます。 |
| デバイスIP | IPフィルタリングのためのクライアントIPアドレス。渡されない場合、呼び出し元のIPが使用されます。 |
| タイプ | （必須）エンゲージメントのタイプ。
|
| 決定ID | 選択されたエンドポイントから返されるユニークな決定ID。CLICKまたはIMPを報告するために必要です。決定IDはbase64形式の配列でなければなりません。 |
| バリエーション | ユーザーが見た複数のバリエーションIDの配列。カスタムキャンペーンで複数のバリエーションを返す場合にのみ、明示的にインプレッションを報告するために必要です。例えば、スライダー。 |
| スロットID | 選択されたエンドポイントから返される特定のクリックされた製品のスロットID。カスタムAPIキャンペーンでは使用されません。APIレコメンデーションキャンペーンでクリックを報告するために必要です。 |
| アクティブな同意が受け入れられました | ユーザーの同意決定。有効なフィールドは：true または false。このパラメータを送信しない場合、APIのデフォルトは false です。 |
エンゲージメントの報告（バッチ）
バッチ制限
このアクションは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます：
- 最大リクエスト数：10
- 最古のリクエストからの最大時間：1分
- リクエストの最大サイズ：1 MB
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザーID | ユニークなユーザーID。有効な値は dyid または dyid_server です。 |
| Dynamic Yield によって生成されたセッション識別子 | _dyjsession クッキーの値が存在する場合はその値を渡します。そうでない場合は、新しいセッション識別子が Dynamic Yield によって作成され、レスポンスで返されます。 |
| デバイスIP | クライアントのIPアドレス。指定されない場合は、呼び出し元のIPが使用されます。 |
| タイプ | (必須) エンゲージメントのタイプ。
|
| ディシジョンID | 選択したエンドポイントから返されるユニークなディシジョンID。CLICKまたはIMPの報告に必要です。ディシジョンIDはbase64形式の配列でなければなりません。 |
| バリエーション | ユーザーが見た複数のバリエーションIDの配列。カスタムキャンペーンで複数のバリエーションを返す場合にのみ、明示的にインプレッションを報告するために必要です。例えば、スライダーなど。 |
| スロットID | 選択したエンドポイントから返される特定のクリックされた製品のスロットID。カスタムAPIキャンペーンには使用されません。APIレコメンデーションキャンペーンでクリックを報告するために必要です。 |
| アクティブな同意の受け入れ | ユーザーの同意決定。有効なフィールドは：true または false。このパラメータを送信しない場合、APIはデフォルトで false に構成されます。 |
ユーザーのアップサートまたは削除
パラメータ
| パラメータ | 説明 |
|---|---|
| フィードキー | データフィードID。Experience OSの Assets › Data Feeds にアクセスし、ID列を見て既存のデータフィードのIDを取得できます。ID列が表示されない場合は、列ドロップダウンを使用して追加できます。 |
| アクション | upsert または delete。デフォルトは delete です。 |
| CUID | ユーザー識別値。 |
| CUIDタイプ | ユーザー識別値タイプ。デバイス間でユーザーを識別するためにこの値を使用します。ハッシュ化されたメールアドレスには ihe を使用するか、独自の識別タイプを使用します。 |
| タイムスタンプ | イベントが発生したUnixエポックからのミリ秒単位でフォーマットされたイベントタイムスタンプ。 |
| CRMデータ | upsert のみ。共有するCRMデータを指定します。例えば、vip_card_member や birthday など。 |
ユーザーのアップサートまたは削除 (バッチ)
バッチ制限
このアクションは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。詳細については、Batched Actionsを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます：
- 最大リクエスト数：100
- 最古のリクエストからの最大時間：60分
- リクエストの最大サイズ：1 MB
パラメータ
| パラメータ | 説明 |
|---|---|
| フィードキー | データフィードID。Experience OSの Assets › Data Feeds にアクセスし、ID列を見て既存のデータフィードのIDを取得できます。ID列が表示されない場合は、列ドロップダウンを使用して追加できます。 |
| アクション | upsert または delete。デフォルトは delete です。 |
| CUID | ユーザー識別値。 |
| CUIDタイプ | ユーザー識別値タイプ。デバイス間でユーザーを識別するためにこの値を使用します。ハッシュ化されたメールアドレスには ihe を使用するか、独自の識別タイプを使用します。 |
| タイムスタンプ | イベントが発生したUnixエポックからのミリ秒単位でフォーマットされたイベントタイムスタンプ。 |
| CRMデータ | upsert のみ。共有するCRMデータを指定します。例えば、vip_card_member や birthday など。 |
最終更新日 :: 2026年June月17日