POST 스키마
웹훅으로 전송되는 POST 요청은 다음 스키마를 사용하는 JSON 형식입니다.
웹훅 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 Ads에서 구성된 각 양식의 고유 ID 현재 제품에서는 캠페인 수준에서 양식을 첨부할 수 있습니다 (광고그룹 또는 광고 수준에서 첨부하는 것과 비교).
의미: 리드는 클라이언트는 처리하려면 8바이트 정수를 사용해야 합니다. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
첨부된 리드 양식의 Google Ads 캠페인 ID 또는
광고 항목 ID (Display & Video 360)입니다.
클라이언트는 8바이트 정수를 사용하여 처리해야 합니다. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Google Ads 광고그룹 ID는 캠페인에서 특정 광고그룹을 구분하는 데 사용됩니다. (동영상 및 디스커버리 광고의 리드에만 사용 가능)
클라이언트는 8바이트 정수를 사용하여 처리해야 합니다. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Google Ads 광고 소재 ID는 광고 그룹에서
특정 광고 소재를 구분하는 데 사용됩니다. (동영상 및 디스커버리 광고의 리드에만 사용 가능)
클라이언트는 8바이트 정수를 사용하여 처리해야 합니다. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Google 클릭 ID는 광고의 각 클릭을 추적하는 데 사용되는 고유한 매개변수입니다. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
광고주가 각 양식에서 구성한 키입니다.
권장사항 처리: 웹훅을 통해 수신된 리드를 처리하기 전에, 리드가 유효하다는 확신을 얻기 위해 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
이 입력란에는 '선택적' 의미 체계가 있습니다. 값이 true인 경우 이 리드를 테스트 리드로 취급합니다. 값이 false이거나 필드가 없으면 이 리드를 유효한 프로덕션 리드로 취급합니다. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
사용자가 제출한 데이터를 전송하는 반복되는 키-값 튜플입니다.
|
리드 처리
리드 핸들러는 다음 HTTP 코드로 응답해야 합니다.
HTTP 응답 | 응답 본문 (JSON) | 재시도 가능한 오류인가요? |
---|---|---|
200 |
{} | N/A |
4XX |
{"메시지: 요청의 문제를 설명하는 자유 형식 오류 텍스트"} | No |
5XX |
{"message: 간헐적인 복구 가능 오류 옵션 메시지"} | 지원됨 |
중복
단일 리드가 정확히 한 번 전달된다는 보장은 없으므로 리드 처리 웹훅은 중복 항목을 적절하게 처리해야 합니다.