POST şeması
Webhook'a gönderilen POST isteği, aşağıdaki şemayla JSON biçiminde olur:
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;
}
Alan açıklaması
| Alan | Açıklama | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Belirli bir potansiyel müşteriyi tanımlayan benzersiz dize.
İşleme önerisi: Alınan potansiyel müşterilerin tekilleştirilmesi için bunu kullanın. Bu, tüm formlarda benzersizdir. Belirli bir potansiyel müşteriyle ilgili sorunlar bildirilirken bu kimlik gereklidir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Bu potansiyel müşteri şemasının ait olduğu API sürümü. Bu ad, yeni şemaya taşıma sırasında kullanılır ve şimdilik yoksayılabilir. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Google Ads'de yapılandırılan her formun benzersiz kimliği. Mevcut ürün, kampanya düzeyinde form eklemeye (reklam grubu veya reklam düzeylerinde ekleme yerine) izin verir.
Çıkarımlar: Potansiyel müşteriler yalnızca İstemcilerin işlem yapmak için 8 baytlık tam sayı kullanması gerekir. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
Ekteki 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 reklam grubunu ayırt etmek için kullanılır. (Yalnızca video ve Discovery reklamlardan gelen potansiyel müşteriler için kullanılabilir)
İstemcilerin, işleme almak 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 reklamlardan gelen potansiyel müşteriler için kullanılabilir)
İstemcilerin, işleme almak 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 |
Her formda reklamveren tarafından yapılandırılan bir anahtar.
Öneriyi ele alma: Webhook üzerinden alınan bir potansiyel müşteriyi işlemeden önce, potansiyel müşterinin geçerli olduğundan emin olmak için |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Bu alanda "isteğe bağlı" semantik vardır. Değer doğruysa bu potansiyel müşteriyi test amaçlı potansiyel müşteri olarak değerlendirin. Değer yanlışsa veya alan mevcut değilse bu potansiyel müşteriyi geçerli bir üretim potansiyel müşteri olarak değerlendirin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Kullanıcı tarafından gönderilen verileri ileten, tekrarlanan bir anahtar/değer çifti.
|
Potansiyel müşteri işleme
Potansiyel müşteri işleyicileri aşağıdaki HTTP kodlarıyla yanıt vermelidir:
| HTTP Yanıtı | Yanıt gövdesi (JSON) | Geri alınabilir hata mı? |
|---|---|---|
200 |
{} | Yok |
4XX |
{"message: İstekle ilgili sorunun ne olduğunu açıklayan serbest biçimli hata metni"} | Hayır |
5XX |
{"message: İsteğe bağlı aralıklı geri alınabilir hata mesajı"} | Evet |
Yinelenen ileti dizileri
Tek bir potansiyel müşterinin tam olarak bir kez sağlanacağı garanti edilmez. Bu nedenle, potansiyel müşteri işleme webhook'unun kopyaları sorunsuz şekilde ele alması gerekir.