POST スキーマ
Webhook に送信される POST リクエストは、次のスキーマの JSON 形式になります。
Webhook Proto ペイロード
// Represent user lead data for single column
message UserLeadColumnData {
// Human-readable text of the field type (e.g.: Full Name, What is your
// preferred dealership?). This field might not always be populated.
optional string column_name = 1;
// Column value based on column type
oneof column_value {
string string_value = 2;
}
// Column id. Populated for all types of fields. (e.g.: FULL_NAME)
optional string column_id = 3;
}
// Message to construct webhook JSON payload
message WebhookLead {
// Unique id to represent lead
optional string lead_id = 1;
// User inputted data per column
repeated UserLeadColumnData user_column_data = 2;
// API version
optional string api_version = 3;
// Form id to which lead belonged to.
optional int64 form_id = 4;
// Campaign id that the lead form is associated with
optional int64 campaign_id = 5;
// Key to be used by advertiser to verify the request
// is from Google.
optional string google_key = 6;
// Denotes if the lead is a test lead.
optional bool is_test = 7;
// Click ID for the lead submission.
optional string gcl_id = 8;
// Adgroup id which generated the lead.
optional int64 adgroup_id = 9;
// Creative id which generated the lead.
optional int64 creative_id = 10;
// Asset group id represents the container for holding assets, associated
// urls, hints and criteria that will be used to select assets and for
// optimization. This field is only populated for Performance Max campaigns.
int64 asset_group_id = 11;
}
フィールドの説明
| フィールド | 説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
特定のリードを識別する一意の文字列。 処理の推奨事項: 受信した見込み顧客の重複を排除するために使用します。これは、すべてのフォームで一意になります。特定の見込み顧客に関連する問題を報告する場合は、この ID が必要になります。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
この見込み顧客スキーマが属する API バージョン。これは新しいスキーマへの移行時に使用されます。現時点では無視できます。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Google 広告で設定した各フォームの一意の ID。現在のプロダクトでは、キャンペーン単位でフォームを適用できます（広告グループ単位または広告単位で適用するのではなく）。 影響: 見込み顧客は クライアントは 8 バイトの整数を使用して処理する必要があります。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
関連付けられている見込み顧客フォームの Google 広告キャンペーン ID または広告申込情報 ID（ディスプレイ＆ビデオ 360）。 クライアントは 8 バイトの整数を使用して処理する必要があります。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Google 広告の広告グループ ID は、キャンペーン内の特定の広告グループを区別するために使用されます。（動画広告とディスカバリー広告からの見込み顧客にのみ利用可能）
クライアントは 8 バイトの整数を使用して処理する必要があります。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Google 広告のクリエイティブ ID は、広告グループ内の特定のクリエイティブを区別するために使用されます。（動画広告とディスカバリー広告からの見込み顧客にのみ利用可能） クライアントは 8 バイトの整数を使用して処理する必要があります。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Google クリック ID: 広告の各クリックをトラッキングするために使用される一意のパラメータです。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
広告主が各フォームで設定したキー。
処理に関する推奨事項: webhook 経由で受信した見込み顧客を処理する前に、 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
このフィールドは「省略可」のセマンティクスを持ちます。値が true の場合、この見込み顧客をテスト見込み顧客として扱います。値が false の場合、またはフィールドが存在しない場合、この見込み顧客を有効な製品見込み顧客として扱います。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
ユーザーが送信したデータを送信する繰り返し Key-Value タプル。
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
このフィールドに値が入力されるのは、P-MAX キャンペーンの場合のみです。
これは、見込み顧客フォームを含むコンテナ ID を示します。 クライアントは 8 バイトの整数を使用して処理する必要があります。 |
セールスリードのハンドリング
見込み顧客ハンドラは、次の HTTP コードで応答する必要があります。
| HTTP レスポンス | レスポンスの本文（JSON） | 再試行可能なエラーですか？ |
|---|---|---|
200 |
{} | なし |
4XX |
{"message: リクエストの問題を説明する自由形式のエラー テキスト"} | いいえ |
5XX |
{"message: 断続的に発生する取り消し可能なエラーのオプション メッセージ"} | はい |
重複
1 件のリードを確実に 1 回だけ配信できるとは限りません。そのため、リード処理の Webhook は重複を適切に処理する必要があります。