Implementacja

Schemat POST

Żądanie POST wysłane do webhooka będzie miało format JSON z schemat:

Ładunek Proto webhooka

// 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;
}

Opis pola

Pole Opis
lead_id Unikalny ciąg znaków, który identyfikuje danego potencjalnego klienta.

Postępowanie w przypadku zalecenia: użyj tej opcji, aby usunąć duplikaty kontaktów do potencjalnych klientów, odebrane. Będzie on niepowtarzalny we wszystkich formularzach. Podczas zgłaszania problemów związanych z konkretnym potencjalnym klientem, identyfikator ten będzie wymagany.
api_version Wersja interfejsu API, do której należy ten schemat potencjalnego klienta. Użyjemy go, gdy migracji do nowego schematu i na razie można je zignorować.
form_id Unikalny identyfikator dla każdego formularza skonfigurowanego w Google Ads. Zezwolenia w bieżącej usłudze Dołączanie formularza na poziomie kampanii (a nie na poziomie grupy reklam lub reklamy) poziomów).

Konsekwencje: kontakty do potencjalnych klientów można podzielić tylko na form_id (tj. na poziomie kampanii).

Klient musi użyć do przetworzenia 8 bajtów liczby całkowitej.

campaign_id Identyfikator kampanii Google Ads lub elementu zamówienia (Display &Video 360) w załączonym formularzu kontaktowym.

Do przetworzenia klient musi używać 8-bajtowej liczby całkowitej.

adgroup_id Identyfikator grupy reklam Google Ads służy do rozróżniania grupy reklam w kampanii. (Dostępne w przypadku potencjalnych klientów z reklam wideo i Discovery tylko reklamy)

Do przetworzenia klient musi używać 8-bajtowej liczby całkowitej.

creative_id Identyfikator kreacji Google Ads służy do rozróżnienia reklamę w grupie reklam. (Dostępne w przypadku potencjalnych klientów z reklam wideo i Discovery tylko reklamy)

Do przetworzenia klient musi używać 8-bajtowej liczby całkowitej.

gcl_id Kliknięcie Google ID: unikalny parametr służący do śledzenia każdego kliknięcia reklamy.
google_key Klucz skonfigurowany przez reklamodawcę dla każdego formularza.

Postępowanie w przypadku zalecenia: zanim przetworzymy kontakt do potencjalnego klienta otrzymany ponad webhooka weryfikacja wartości google_key jest taka sama jak w przypadku konfigurowania Google Ads, aby mieć większą pewność, że kontakt do potencjalnego klienta jest prawidłowy. Google Keep poufne informacje i w razie potrzeby zaktualizować je w Google Ads. uważa, że sprawa wyciekła do późna.
is_test To pole ma wartość „opcjonalne” semantyczne. Jeśli wartość to prawda, potraktuj tę wartość jako potencjalnego klienta w teście. Jeśli wartość to false lub jeśli pole nie jest dostępne, potraktuj jako potencjalnego klienta w produkcji.
user_column_data Powtarzająca się krotka klucz-wartość przesyłająca dane przesłane przez użytkownika.
  • user_column_data.column_id: typ danych przesłany przez użytkownika.
  • User_column_data.column_value: w przypadku każdego typu danych w zależności od typu danych zostanie uzupełniony typ wartości. Wszystkie nasze bieżące typy danych mają wartość user_column_data.string_value
  • user_column_data.column_name: zrozumiały dla człowieka tekst typ danych przesłanych przez użytkownika. To pole nie zawsze jest już wypełniony, użyj w zamian column_id .
user_column_data.column_id User_column_data.string_value content user_column_data.column_name (wycofana)
„FULL_NAME” Imię i nazwisko użytkownika. „Full Name”
„FIRST_NAME” Imię użytkownika. „First Name”
„LAST_NAME” Nazwisko użytkownika. „Nazwisko”
„EMAIL” Adres e-mail użytkownika. „Adres e-mail użytkownika”
„PHONE_NUMBER” Telefon użytkownika E.164 format, np. "+11234567890". „Telefon użytkownika”
"POSTAL_CODE" Kod pocztowy użytkownika. „Kod pocztowy”,
„COMPANY_NAME” Nazwa firmy użytkownika. „Nazwa firmy”
"JOB_TITLE" Stanowisko użytkownika. „Stanowisko”
„WORK_EMAIL” Służbowy adres e-mail użytkownika. „Służbowy adres e-mail”
„WORK_PHONE” Służbowy telefon użytkownika. „Telefon służbowy”
„STREET_ADDRESS” Adres użytkownika. „Adres”
„CITY” Miasto użytkownika. „Miasto”
„REGION” Region użytkownika. „Region”
„COUNTRY” Kraj użytkownika. „Kraj”,
„VEHICLE_MODEL” Który model Cię interesuje? Nie dotyczy
„VEHICLE_TYPE” Jaki typ pojazdu Cię interesuje? Nie dotyczy
„PREFERRED_DEALERSHIP” Wybierz preferowany salon sprzedaży Nie dotyczy
„VEHICLE_PURCHASE_TIMELINE” Kiedy zamierzasz kupić pojazd? Nie dotyczy
„VEHICLE_condition” Jaki stan pojazdu Cię interesuje? Nie dotyczy
„VEHICLE_OWNERSHIP” Czy masz pojazd? „Nie dotyczy”
"VEHICLE_PAYMENT_TYPE" Jaka forma własności pojazdu Cię interesuje? Nie dotyczy
„COMPANY_SIZE” Jak duża jest Twoja firma? Nie dotyczy
„ANNUAL_SALES” Jaka jest Twoja roczna wielkość sprzedaży? Nie dotyczy
„YEARS_IN_BUSINESS” Od ilu lat działa Twoja firma? Nie dotyczy
„JOB_DEPARTMENT” W jakim dziale pracujesz? Nie dotyczy
"JOB_ROLE" Jakie zajmujesz stanowisko? Nie dotyczy
„EDUCATION_PROGRAM” Jaki program Cię interesuje? Nie dotyczy
„EDUCATION_COURSE” Jaki kurs Cię interesuje? Nie dotyczy
„PRODUCT” Jaki produkt Cię interesuje? Nie dotyczy
„SERVICE” Jaka usługa Cię interesuje? Nie dotyczy
„OFERTA” Jaka oferta Cię interesuje? Nie dotyczy
„CATEGORY” Jaka kategoria Cię interesuje? Nie dotyczy
"PREFERRED_CONTACT_METHOD" Wybierz preferowaną metodę kontaktu Nie dotyczy
„PREFERRED_LOCATION” Wybierz preferowaną lokalizację Nie dotyczy
„PREFERRED_CONTACT_TIME” W jakich godzinach najlepiej się z Tobą kontaktować? Nie dotyczy
„PURCHASE_TIMELINE” Kiedy chcesz dokonać zakupu? Nie dotyczy
„YEARS_OF_EXPERIENCE” Ile masz lat doświadczenia w pracy? Nie dotyczy
"JOB_INDUSTRY" W jakiej branży pracujesz? Nie dotyczy
„LEVEL_OF_EDUCATION” Jakie masz wykształcenie? Nie dotyczy
„PROPERTY_TYPE” Jakiego typu nieruchomości szukasz? Nie dotyczy
„REALTOR_HELP_GOAL” Dlaczego potrzebujesz usług agencji nieruchomości? Nie dotyczy
„PROPERTY_COMMUNITY” Jaka społeczność Cię interesuje? Nie dotyczy
„PRICE_RANGE” Jaki przedział cenowy Cię interesuje? Nie dotyczy
„NUMBER_OF_BEDROOMS” Ile sypialni ma mieć dom lub mieszkanie? Nie dotyczy
„FURNISHED_PROPERTY” Czy szukasz w pełni umeblowanej nieruchomości? Nie dotyczy
„PETS_ALLOWED_PROPERTY” Czy szukasz domu lub mieszkania, w którym wolno trzymać zwierzęta? Nie dotyczy
„NEXT_PLANNED_PURCHASE” Jaki produkt zamierzasz kupić w następnej kolejności? Nie dotyczy
„EVENT_SIGNUP_INTEREST” Czy chcesz zarejestrować się na wydarzenie? Nie dotyczy
„PREFERRED_SHOPPING_PLACES” Gdzie chcesz robić zakupy? Nie dotyczy
„FAVORITE_BRAND” Jaka jest Twoja ulubiona marka? Nie dotyczy
"TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" Jakim typem licencji komercyjnej dysponujesz? Nie dotyczy
„EVENT_BOOKING_INTEREST” Czy chcesz zarezerwować miejsce na wydarzenie? Nie dotyczy
„DESTINATION_COUNTRY” Do jakiego kraju chcesz jechać? Nie dotyczy
„DESTINATION_CITY” Do jakiego miasta chcesz jechać? Nie dotyczy
„DEPARTURE_COUNTRY” Z jakiego kraju wyruszasz? Nie dotyczy
„DEPARTURE_CITY” Z jakiego miasta wyruszasz? Nie dotyczy
„DEPARTURE_DATE” Podaj datę wyjazdu. Nie dotyczy
„RETURN_DATE” Którego dnia wracasz? Nie dotyczy
„NUMBER_OF_TRAVELERS” Z iloma osobami podróżujesz? Nie dotyczy
„TRAVEL_BUDGET” Jaki jest Twój budżet na podróż? Nie dotyczy
„TRAVEL_ACCOMMODATION” Gdzie chcesz się zatrzymać w czasie podróży? Nie dotyczy

Obsługa potencjalnych klientów

Moduły obsługi potencjalnych klientów powinny w odpowiedzi na nie odpowiedzieć z użyciem tych kodów HTTP:

Odpowiedź HTTP Treść odpowiedzi (JSON) Błąd, który można powtórzyć?
200 {} Nie dotyczy
4XX {"message: Dowolny tekst błędu, opisujący, co jest nie tak z prośbą"} Nie
5XX {"message: Okresowy, możliwy do przywrócenia opcjonalny komunikat"} Tak

Duplikaty

Nie ma gwarancji, że jeden kontakt do potencjalnego klienta zostanie zrealizowany tylko raz. obsługa webhooka powinna sprawnie radzić sobie z duplikatami.