Yelp Conversions コネクタ構成ガイド | サーバーサイドコネクタ

API情報

このコネクタは以下のベンダーAPIを使用します：

API名：Yelp API
APIバージョン：v3
APIエンドポイント：https://api.yelp.com/v3/conversion
ドキュメンテーション：Yelp API

構成

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法の一般的な指示については、About Connectorsを参照してください。

コネクタを追加した後、以下の構成を行います：

APIキー – 必須。アプリケーションのAPIキー。APIキーはリクエストに添付され、Yelp Adsのアプリケーション構成で見つけることができます。

アクション

アクション名	AudienceStream	EventStream
送信変換（リアルタイム）	✗	✓
送信変換（バッチ）	✗	✓

アクションの名前を入力し、ドロップダウンリストからアクションタイプを選択します。

次のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

送信変換（リアルタイム）

パラメータ

パラメータ	説明
イベント名	変換トラッキングイベントのタイプ。ドロップダウンリストから値を選択するか、カスタム文字列値を入力します。帰属プロセス中の集計に使用されます。また、`event_id`と組み合わせて重複排除プロセスにも使用されます。

変換イベントパラメータ

パラメータ	説明
イベントID	重複排除プロセスで使用される変換の一意の識別子。
イベント時間	過去に変換イベントが発生した日時。
アクションソース	変換が行われた場所を示します。現在、`app`、`physical_store`、`website`に限定されています。

ユーザーデータ

マッチングプロセス中に使用できるすべてのユーザー固有のデータを含みます。データを多く提供するほど、マッチングの可能性と品質が向上します。

パラメータ	説明
メールアドレス	(SHA256ハッシュを適用) プレーンテキストのメールアドレスを提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
メールアドレス	(既にSHA256ハッシュ化されている) SHA256ハッシュ化されたメールアドレスを提供します。
名前	(SHA256ハッシュを適用) プレーンテキストの名前を提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
名前	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された名前を提供します。
姓	(SHA256ハッシュを適用) プレーンテキストの姓を提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
姓	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された姓を提供します。
電話番号	(SHA256ハッシュを適用) プレーンテキストの電話番号を提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
電話番号	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された電話番号を提供します。
生年月日	(SHA256ハッシュを適用) `YYYYMMDD`形式で顧客の生年月日を提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
生年月日	(既にSHA256ハッシュ化されている) `YYYYMMDD`形式のSHA256ハッシュ化された顧客の生年月日を提供します。
性別	(SHA256ハッシュを適用) 顧客の性別を一文字（`f`、`m`、または`n`、女性、男性、ノンバイナリーを表す）で提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
性別	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された顧客の性別を一文字（`f`、`m`、または`n`、女性、男性、ノンバイナリーを表す）で提供します。
国	(SHA256ハッシュを適用) プレーンテキストの国コードを提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
国	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された国コードを提供します。
州	(SHA256ハッシュを適用) プレーンテキストの州を提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
州	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された州を提供します。
郵便番号	(SHA256ハッシュを適用) プレーンテキストの郵便番号を提供し、コネクタはこの値からすべての非数値文字を削除し、空白トリム、SHA256ハッシュでハッシュ化します。
郵便番号	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された郵便番号を提供します。
市区町村	(SHA256ハッシュを適用) プレーンテキストの市区町村を提供し、コネクタはこの値からスペースと句読点を削除し、空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
市区町村	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された市区町村を提供します。
外部ID	(SHA256ハッシュを適用) 変換ユーザーに関連する任意の一意のID（例：メンバーシップID、ロイヤリティIDなど）を提供します。コネクタはこの値からスペースと句読点を削除し、空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
外部ID	(既にSHA256ハッシュ化されている) 変換ユーザーに関連するSHA256ハッシュ化された一意のID（例：メンバーシップID、ロイヤリティIDなど）を提供します。
IPアドレス	顧客のIPアドレスをIPV4またはIPV6形式で提供します。この値は`client_user_agent`と一緒に含めることで、マッチ率を最大化します。
クライアントユーザーエージェント	顧客のブラウザのユーザーエージェントを提供します。この値は`client_ip_address`と一緒に含めることで、マッチ率を最大化します。
MADID	顧客のモバイル広告ID（IDFA/AAID）モバイルイベントのみに適用します。

カスタム変換データ

パラメータ	説明
値	変換の総金額。このパラメータはROASを決定するための必須フィールドであり、`event_name`の値が`purchase`の場合は必ず含める必要があります。
通貨	通貨は、有効なISO4217の3桁の通貨コードでなければなりません。現在、`USD`に限定されています。
注文ID	変換イベントのトランザクションIDまたは注文ID。
コンテンツカテゴリ	変換が属するカスタムカテゴリ。
コンテンツID	この変換に関連するサブアイテムID。同じ購入に含まれるすべての製品のSKU IDが該当する可能性があります。
カスタム変換コンテンツ	この変換の内容に関する追加情報をJSONオブジェクトの形式で提供します。

送信変換（バッチ）

バッチ制限

このアクションは、ベンダーへの大量のデータ転送をサポートするためにバッチリクエストを使用します。リクエストは、以下のいずれかの閾値が満たされるまでキューに入れられます：

リクエストの最大数：1,000
最古のリクエストからの最大時間：10分
リクエストの最大サイズ：2MB

パラメータ

パラメータ	説明
イベント名	変換トラッキングイベントのタイプ。ドロップダウンリストから値を選択するか、カスタム文字列値を入力します。帰属プロセス中の集計に使用されます。また、`event_id`と組み合わせて重複排除プロセスにも使用されます。

変換イベントパラメータ

パラメータ	説明
イベントID	重複排除プロセスで使用される変換の一意の識別子。
イベント時間	過去に変換イベントが発生した日時。
アクションソース	変換が行われた場所を示します。現在、`app`、`physical_store`、`website`に限定されています。

ユーザーデータ

パラメータ	説明
メールアドレス	(SHA256ハッシュを適用) プレーンテキストのメールアドレスを提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
メールアドレス	(既にSHA256ハッシュ化されている) SHA256ハッシュ化されたメールアドレスを提供します。
名前	(SHA256ハッシュを適用) プレーンテキストの名前を提供し、コネクタはこの値を空白トリム、小文字化、SHA256ハッシュでハッシュ化します。
名前	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された名前を提供します。
姓	(SHA256ハッシュを適用) 平文の姓を提供し、コネクタはこの値を空白トリム、小文字化し、SHA256ハッシュを使用してハッシュ化します。
姓	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された姓を提供します。
電話番号	(SHA256ハッシュを適用) 平文の電話番号を提供し、コネクタはこの値を空白トリム、小文字化し、SHA256ハッシュを使用してハッシュ化します。
電話番号	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された電話番号を提供します。
生年月日	(SHA256ハッシュを適用) `YYYYMMDD`形式で顧客の生年月日を提供し、コネクタはこの値を空白トリム、小文字化し、SHA256ハッシュを使用してハッシュ化します。
生年月日	(既にSHA256ハッシュ化されている) `YYYYMMDD`形式でSHA256ハッシュ化された顧客の生年月日を提供します。
性別	(SHA256ハッシュを適用) 顧客の性別を一文字（`f`、`m`、または`n`、女性、男性、またはノンバイナリーを表す）で提供し、コネクタはこの値を空白トリム、小文字化し、SHA256ハッシュを使用してハッシュ化します。
性別	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された顧客の性別を一文字（`f`、`m`、または`n`、女性、男性、またはノンバイナリーを表す）で提供します。
国	(SHA256ハッシュを適用) 平文の国コードを提供し、コネクタはこの値を空白トリム、小文字化し、SHA256ハッシュを使用してハッシュ化します。
国	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された国コードを提供します。
州	(SHA256ハッシュを適用) 平文の州を提供し、コネクタはこの値を空白トリム、小文字化し、SHA256ハッシュを使用してハッシュ化します。
州	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された州を提供します。
郵便番号	(SHA256ハッシュを適用) 平文の郵便番号を提供し、コネクタはこの値からすべての非数値文字を削除し、空白トリムし、SHA256ハッシュを使用してハッシュ化します。
郵便番号	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された郵便番号を提供します。
市	(SHA256ハッシュを適用) 平文の市を提供し、コネクタはこの値からスペースと句読点を削除し、空白トリムし、小文字化し、SHA256ハッシュを使用してハッシュ化します。
市	(既にSHA256ハッシュ化されている) SHA256ハッシュ化された市を提供します。
外部ID	(SHA256ハッシュを適用) 変換ユーザーに関連する任意の一意のID（例：メンバーシップID、ロイヤルティIDなど）を提供します。コネクタはこの値からスペースと句読点を削除し、空白トリムし、小文字化し、SHA256ハッシュを使用してハッシュ化します。
外部ID	(既にSHA256ハッシュ化されている) 変換ユーザーに関連するSHA256ハッシュ化された一意のID（例：メンバーシップID、ロイヤルティIDなど）を提供します。
IPアドレス	顧客のIPアドレスをIPV4またはIPV6形式で提供します。これは`client_user_agent`と一緒に含めることでマッチ率を最大化します。
クライアントユーザーエージェント	顧客のブラウザのユーザーエージェントを提供します。これは`client_ip_address`と一緒に含めることでマッチ率を最大化します。
MADID	顧客のモバイル広告ID（IDFA/AAID）モバイルイベントのみに適用します。

カスタムコンバージョンデータ

パラメータ	説明
値	コンバージョンの総金額。この値はROASを決定するための必須フィールドであり、`event_name`の値が`purchase`の場合には必ず含める必要があります。
通貨	通貨は有効なISO 4217の3桁の通貨コードでなければなりません。現在は`USD`に限定されています。
注文ID	コンバージョンイベントに関連するトランザクションIDまたは注文ID。
コンテンツカテゴリ	コンバージョンのカスタムカテゴリ。
コンテンツID	このコンバージョンに関連するサブアイテムID。同じ購入に含まれるすべての製品のSKU IDが該当する場合があります。
カスタムコンバージョンコンテンツ	このコンバージョンの内容に関する追加情報をJSONオブジェクトの形式で提供します。