POST şeması
Webhook'a gönderilen POST isteği, aşağıdaki şemaya sahip JSON biçiminde olacaktır:
Webhook Proto yükü
// 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;
}
Alan açıklaması
Alan | Açıklama | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Belirli bir potansiyel müşteriyi tanımlayan benzersiz dize.
Öneriyi işleme: Alınan potansiyel müşterilerin tekilleştirilmesi için bu seçeneği kullanın. Bu, tüm formlarda benzersiz olmalıdır. Belirli bir potansiyel müşteriyle ilgili sorunları bildirirken bu kimlik gereklidir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Bu potansiyel müşteri şemasının ait olduğu API sürümü. Bu, yeni bir şemaya geçiş | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Google Ads'de yapılandırılan her form için benzersiz kimlik. Mevcut ürün, kampanya düzeyinde bir form eklemenize olanak tanır (reklam grubu veya reklam düzeyinde ekleme yerine).
Sonuçlar: Potansiyel müşteriler yalnızca İstemcilerin işlemek için 8 baytlık tam sayı kullanması gerekir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
Ekli potansiyel müşteri formunun Google Ads kampanya kimliği veya satır öğesi kimliği (Display & Video 360).
İstemcilerin işleme almak için 8 baytlık bir tam sayı kullanması gerekir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Google Ads reklam grubu kimliği, kampanyadaki belirli bir reklam grubunu ayırt etmek için kullanılır. (Yalnızca video ve Discovery reklamlarından elde edilen potansiyel müşteriler için kullanılabilir.)
İstemcilerin işlemek için 8 baytlık bir tam sayı kullanması gerekir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Google Ads reklam öğesi kimliği, reklam grubundaki belirli reklam öğesini ayırt etmek için kullanılır. (Yalnızca video ve Discovery reklamlarından elde edilen potansiyel müşteriler için kullanılabilir)
İstemcilerin işlemek için 8 baytlık bir tam sayı kullanması gerekir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Bir reklamın her tıklamasını izlemek için kullanılan benzersiz bir parametre olan Google tıklama kimliği. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Reklamveren tarafından her formla yapılandırılan bir anahtar.
İşleme önerisi: Webhook üzerinden alınan bir potansiyel müşteriyi işleme almadan önce, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Bu alanın semantik değeri "isteğe bağlı"dır. Değer doğruysa bu potansiyel müşteriyi test potansiyel müşterisi olarak değerlendirin. Değer yanlışsa veya alan mevcut değilse bu potansiyel müşteriyi geçerli üretim potansiyel müşterisi olarak değerlendirin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Kullanıcı tarafından gönderilen verileri aktaran yinelenen bir anahtar/değer tuple'si.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id |
Bu alan yalnızca Maksimum Performans kampanyaları için doldurulur.
Bu, potansiyel müşteri formunu içeren kapsayıcı kimliğini belirtir.
İstemcilerin işlemek için 8 baytlık bir tam sayı kullanması gerekir. |
Potansiyel müşterilerle ilgilenme
Potansiyel müşteri işleyicileri aşağıdaki HTTP kodlarıyla yanıt vermelidir:
HTTP Yanıtı | Yanıt gövdesi (JSON) | Yeniden alınabilir hata mı? |
---|---|---|
200 |
{} | Yok |
4XX |
{"message: İstekte neyin yanlış olduğunu açıklayan serbest biçimli hata metni"} | Hayır |
5XX |
{"message: Intermittent retraible error optional message"} | Evet |
Yinelenen kişiler
Tek bir potansiyel müşterinin tam olarak bir kez teslim edileceği garanti edilmez. Bu nedenle, potansiyel müşteri işleme webhook'ı yinelenenleri sorunsuz bir şekilde işlemelidir.