Uygulama

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;
  // Lead stage at the time of delivery.
  string lead_stage = 12 [(datapol.semantic_type) = ST_NOT_REQUIRED];
}

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 formun benzersiz kimliği. 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 form_id düzeyinde (yani kampanya düzeyinde) dilimlenebilir.

İ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şleme almak için 8 baytlık bir tam sayı kullanması gerekir.

creative_id Google Ads reklam öğesi kimliği, reklam grubundaki belirli bir 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, google_key değerini doğrulamak, potansiyel müşterinin geçerli olduğundan daha emin olmak için Google Ads'de yapılandırmakla aynıdır. Bu anahtarı gizli tutun ve geniş çapta sızdırıldığına dair bir neden varsa Google Ads'de güncelleyin.
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.
  • user_column_data.column_id: Kullanıcı tarafından gönderilen veri türü.
  • User_column_data.column_value: Her veri türü için, veri türüne bağlı olarak doldurulan bir değer türü vardır. Mevcut tüm veri türlerimizin değeri user_column_data.string_value.
  • user_column_data.column_name: Kullanıcı tarafından gönderilen veri türünün kullanıcı tarafından okunabilen metni. Bu alan her zaman doldurulmayabilir. Bunun yerine column_id değerini kullanın.
user_column_data.column_id User_column_data.string_value içeriği user_column_data.column_name (Desteği sonlandırıldı)
"FULL_NAME" Kullanıcının tam adı. "Tam Ad"
"FIRST_NAME" Kullanıcının adı. "Ad"
"LAST_NAME" Kullanıcının soyadı. "Soyadı"
"EMAIL" Kullanıcı e-posta adresi. "Kullanıcı E-postası"
"PHONE_NUMBER" E.164 biçiminde kullanıcı telefon numarası (ör. "+11234567890". "Kullanıcı Telefonu"
"POSTAL_CODE" Kullanıcının posta kodu. "Posta Kodu"
"COMPANY_NAME" Kullanıcının şirket adı. "Şirket Adı"
"JOB_TITLE" Kullanıcının iş unvanı. "İş unvanı"
"WORK_EMAIL" Kullanıcının iş e-postası. "İş E-postası"
"WORK_PHONE" Kullanıcının iş telefonu. "İş Telefonu"
"STREET_ADDRESS" Kullanıcının açık adresi. "Cadde Adresi"
"ŞEHİR" Kullanıcının yaşadığı şehir. "Şehir"
"REGION" Kullanıcının bulunduğu bölge. "Bölge"
"COUNTRY" Kullanıcının ülkesi. "Country"
"VEHICLE_MODEL" Hangi modelle ilgileniyorsunuz? Yok
"VEHICLE_TYPE" Hangi araç türüyle ilgileniyorsunuz? Yok
"PREFERRED_DEALERSHIP" Tercih ettiğiniz bayiliği seçin Yok
"VEHICLE_PURCHASE_TIMELINE" Ne zaman araç satın almayı düşünüyorsunuz? Yok
"VEHICLE_CONDITION" Hangi durumdaki araçlarla ilgileniyorsunuz? Yok
"VEHICLE_OWNERSHIP" Aracınız var mı? "Geçersiz"
"VEHICLE_PAYMENT_TYPE" İlgilendiğiniz araç sahipliği seçeneği hangisi? Yok
"COMPANY_SIZE" Şirketiniz hangi büyüklükte? Yok
"ANNUAL_SALES" Yıllık satış hacminiz ne kadar? Yok
"YEARS_IN_BUSINESS" Kaç yıldır sektörde faaliyet gösteriyorsunuz? Yok
"JOB_DEPARTMENT" Hangi departmanda çalışıyorsunuz? Yok
"JOB_ROLE" İşinizdeki rolünüz ne? Yok
"EDUCATION_PROGRAM" Hangi programla ilgileniyorsunuz? Yok
"EDUCATION_COURSE" Hangi kursla ilgileniyorsunuz? Yok
"PRODUCT" Hangi ürünle ilgileniyorsunuz? Yok
"SERVICE" Hangi hizmetle ilgileniyorsunuz? Yok
"OFFER" Hangi teklifle ilgileniyorsunuz? Yok
"CATEGORY" Hangi kategoriyle ilgileniyorsunuz? Yok
"PREFERRED_CONTACT_METHOD" Tercih ettiğiniz iletişim yöntemini seçin Yok
"PREFERRED_LOCATION" Tercih ettiğiniz konumu seçin Yok
"PREFERRED_CONTACT_TIME" Sizinle iletişime geçmek için en uygun zaman hangisi? Yok
"PURCHASE_TIMELINE" Ne zaman satın alma işlemi gerçekleştirmek istiyorsunuz? Yok
"YEARS_OF_EXPERIENCE" Kaç yıllık iş deneyiminiz var? Yok
"JOB_INDUSTRY" Hangi sektörde çalışıyorsunuz? Yok
"LEVEL_OF_EDUCATION" En son hangi okuldan mezun oldunuz? Yok
"PROPERTY_TYPE" Ne tür bir mülk arıyorsunuz? Yok
"REALTOR_HELP_GOAL" Hangi konuda bir emlakçıdan yardım almak istiyorsunuz? Yok
"PROPERTY_COMMUNITY" Hangi toplulukla ilgileniyorsunuz? Yok
"PRICE_RANGE" Hangi fiyat aralığını tercih ediyorsunuz? Yok
"NUMBER_OF_BEDROOMS" Kaç yatak odalı bir ev arıyorsunuz? Yok
"FURNISHED_PROPERTY" Eşyalı mülk mü arıyorsunuz? Yok
"PETS_ALLOWED_PROPERTY" Evcil hayvanlara izin verilen mülkler mi arıyorsunuz? Yok
"NEXT_PLANNED_PURCHASE" Satın almayı planladığınız bir sonraki ürün nedir? Yok
"EVENT_SIGNUP_INTEREST" Bir etkinliğe kaydolmak istiyor musunuz? Yok
"PREFERRED_SHOPPING_PLACES" Nerede alışveriş yapmakla ilgileniyorsunuz? Yok
"FAVORITE_BRAND" En sevdiğiniz marka hangisi? Yok
"TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" Geçerli ticari ehliyetiniz hangi türde? Yok
"EVENT_BOOKING_INTEREST" Etkinlik rezervasyonu yapmak istiyor musunuz? Yok
"DESTINATION_COUNTRY" Hangi ülkeye gidiyorsunuz? Yok
"DESTINATION_CITY" Hangi şehre gidiyorsunuz? Yok
"DEPARTURE_COUNTRY" Hangi ülkeden yola çıkıyorsunuz? Yok
"DEPARTURE_CITY" Hangi şehirden yola çıkıyorsunuz? Yok
"DEPARTURE_DATE" Gidiş tarihiniz nedir? Yok
"RETURN_DATE" Dönüş tarihiniz nedir? Yok
"NUMBER_OF_TRAVELERS" Kaç kişiyle seyahat ediyorsunuz? Yok
"TRAVEL_BUDGET" Seyahat bütçeniz ne kadar? Yok
"TRAVEL_ACCOMMODATION" Seyahat sırasında nerede konaklamak istiyorsunuz? Yok
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şleme almak için 8 baytlık bir tam sayı kullanması gerekir.
lead_stage Bu, potansiyel müşterinin teslim edildiği sıradaki potansiyel müşteri aşamasını belirtir. Bu alan, bir potansiyel müşterinin dönüşüm hunisi aşamasını / dönüşüm durumunu izlemek için faydalıdır.

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 ele almalıdır.