Webhook に送信される POST リクエストは、次の JSON 形式になります。
schema:
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;
}
フィールドの説明
フィールド
説明
lead_id
リードを識別する一意の文字列。
対応に関する推奨事項: 有望な見込み顧客を重複排除する際に使用します。
受信します。これはすべてのフォームで一意です。報告時
問題がある場合は、この ID が必要です。
api_version
このリード スキーマが属する API バージョン。これは次の場合に使用されます。
新しいスキーマに移行することになるため、現時点では無視してかまいません。
form_id
Google 広告で設定された各フォームの一意の ID。現在のプロダクトでできること
キャンペーン単位でフォームを添付する(広告グループや広告に添付するのとは異なる)
。
影響: リードは form_id でのみスライスできる
適用できます。
クライアントは処理に 8 バイトの整数を使用する必要があります。
campaign_id
関連付けられている見込み顧客フォームの Google 広告キャンペーン ID または広告申込情報 ID(ディスプレイ&ビデオ 360)。
クライアントは処理に 8 バイトの整数を使用する必要があります。
adgroup_id
Google 広告の広告グループ ID は、広告グループと
広告グループを選択します(動画とファインドからの見込み顧客のみ利用可能)
広告のみ)
クライアントは処理に 8 バイトの整数を使用する必要があります。
creative_id
Google 広告クリエイティブ ID は、個々の広告を識別するために
クリックします(動画広告とディスカバリー広告からの見込み顧客にのみ利用可能)