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です。 |
| ページの場所 | デバイスまたはアプリケーションのタイプです。現在のアプリやサイトの場所に基づいてエクスペリエンスやキャンペーンをターゲットにするために使用されます。有効なフィールドは：ページURL（Web用）、場所（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に対して重複したイベントが報告されても、1つの購入のみが記録されるようにします。有効なフィールドは：purchase-v1です。 |
| CUID | ユーザー識別子の値です。有効なフィールドは：identify-v1、login-v1、signup-v1、newsletter-subscription-v1です。 |
| CUIDタイプ | ユーザー識別子の値のタイプです。この値を使用して、デバイス間でユーザーを識別します。
|
| ハッシュ化されたメールアドレス | 小文字のメールアドレスのSHA-256エンコーディングです。この識別子タイプを使用して、cuidおよびcuidTypeの代わりに使用できます。有効なフィールドは：identify-v1、login-v1、signup-v1、newsletter-subscription-v1、message-optout-v1です。 |
| 電話番号 | ReconnectキャンペーンのSMSチャネルでユーザーを識別するために使用する識別子タイプです。有効なフィールドは：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 | ユニークなストア識別子です。たとえば、レストランの推奨事項に使用します。 |
| ストアの日中部分 | 一日の時間に基づいてキャンペーンを区別するために使用します。 |
| デバイスIP | IPフィルタリング用のクライアントIPアドレスです。渡されない場合、呼び出し元のIPが使用されます。 |
| デバイスのユーザーエージェント | WebベースのクライアントのUser-Agent文字列です。渡されない場合、API GatewayはHTTPSリクエストのヘッダーをチェックします。 |
| カスタムイベントプロパティ | 共有したいカスタムイベントプロパティです。たとえば、product_categoryやcoupon_codeなどです。valueとcurrencyのイベントプロパティは予約されたプロパティであり、ここでマッピングすることはできません。 |
イベントを送信する（バッチ）
バッチ制限
このアクションは、ベンダーへの高容量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます。
- 最大リクエスト数：10
- 最も古いリクエストからの経過時間の最大値：5分
- リクエストの最大サイズ：1MB
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザー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に対して重複したイベントが報告されても、1つの購入のみが記録されるようにします。有効なフィールドは：purchase-v1です。 |
| CUID | ユーザー識別子の値です。有効なフィールドは：identify-v1、login-v1、signup-v1、newsletter-subscription-v1です。 |
| CUIDタイプ | ユーザー識別子の値のタイプです。この値を使用して、デバイス間でユーザーを識別します。
|
| ハッシュ化されたメールアドレス | 小文字のメールアドレスのSHA-256エンコーディングです。この識別子タイプを使用して、cuidおよびcuidTypeの代わりに使用できます。有効なフィールドは：identify-v1、login-v1、signup-v1、newsletter-subscription-v1、message-optout-v1です。 |
| 電話番号 | ReconnectキャンペーンのSMSチャネルでユーザーを識別するために使用する識別子タイプです。有効なフィールドは：login-v1です。 |
| プレーンテキストのメールアドレス | 有効なプレーンテキストのメールアドレスです。plainTextEmailまたはexternalIdのいずれかを使用します。有効なフィールドは：message-optin-v1です。 |
| 外部ID | ユーザーを識別するために使用される外部IDです。ESPはこのIDを認識し、それをメールアドレスにマッピングできる必要があります。plainTextEmailまたはexternalIdのいずれかを使用します。**注：外部IDタイプは、SendGridやResponsysではサポートされていません。カスタム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 | ユニークなストア識別子です。たとえば、レストランの推奨事項に使用します。 |
| ストアの日中部分 | 一日の時間に基づいてキャンペーンを区別するために使用します。 |
| デバイスIP | IPフィルタリング用のクライアントIPアドレスです。渡されない場合、呼び出し元のIPが使用されます。 |
| デバイスのユーザーエージェント | WebベースのクライアントのUser-Agent文字列です。渡されない場合、API Gatewayは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分
- リクエストの最大サイズ：1MB
パラメータ
| パラメータ | 説明 |
|---|---|
| ユーザー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になります。 |
ユーザーを追加または削除する
パラメータ
| パラメータ | 説明 |
|---|---|
| フィードキー | データフィードIDです。既存のデータフィードのIDは、Experience OSのAssets › Data Feedsに移動し、ID列を確認することで取得できます。ID列が表示されない場合は、Columnドロップダウンを使用して追加できます。 |
| アクション | upsertまたはdeleteです。デフォルトはdeleteです。 |
| CUID | ユーザー識別子の値です。 |
| CUIDタイプ | ユーザー識別子の値のタイプです。ハッシュ化されたメールアドレスの場合はiheを使用するか、カスタムの識別子タイプを使用します。 |
| タイムスタンプ | イベントのタイムスタンプです。イベントが発生したUnixエポックからのミリ秒単位でフォーマットされます。 |
| CRMデータ | upsertの場合のみ。共有するCRMデータを指定します。たとえば、vip_card_memberやbirthdayなどです。 |
ユーザーを追加または削除する（バッチ）
バッチ制限
このアクションは、ベンダーへの高容量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます。
- 最大リクエスト数：100
- 最も古いリクエストからの経過時間の最大値：60分
- リクエストの最大サイズ：1MB
パラメータ
| パラメータ | 説明 |
|---|---|
| フィードキー | データフィードIDです。既存のデータフィードのIDは、Experience OSのAssets › Data Feedsに移動し、ID列を確認することで取得できます。ID列が表示されない場合は、Columnドロップダウンを使用して追加できます。 |
| アクション | upsertまたはdeleteです。デフォルトはdeleteです。 |
| CUID | ユーザー識別子の値です。 |
| CUIDタイプ | ユーザー識別子の値のタイプです。ハッシュ化されたメールアドレスの場合はiheを使用するか、カスタムの識別子タイプを使用します。 |
| タイムスタンプ | イベントのタイムスタンプです。イベントが発生したUnixエポックからのミリ秒単位でフォーマットされます。 |
| CRMデータ | upsertの場合のみ。共有するCRMデータを指定します。たとえば、vip_card_memberやbirthdayなどです。 |
最終更新日 :: 2024年March月29日