Schemat POST
Żądanie POST wysłane do webhooka będzie mieć format JSON z tym schematem:
Ł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 dany kontakt do potencjalnego klienta.
Zalecenie dotyczące postępowania: użyj tej opcji do usuwania duplikatów otrzymanych kontaktów do potencjalnych klientów. Będzie on niepowtarzalny we wszystkich formularzach. Ten identyfikator będzie wymagany w przypadku zgłaszania problemów związanych z konkretnym kontaktem do potencjalnego klienta. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Wersja interfejsu API, do której należy ten schemat potencjalnego klienta. Będzie ona używana podczas migracji do nowego schematu. Na razie można ją zignorować. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Unikalny identyfikator każdego formularza skonfigurowanego w Google Ads. Obecna usługa umożliwia załączenie formularza z poziomem kampanii (w porównaniu z dołączaniem na poziomie grupy reklam lub reklamy).
Konsekwencje: pozyskiwanie potencjalnych klientów można dzielić na segmenty tylko na poziomie Klienci muszą przetworzyć 8 bajtów liczb całkowitych. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
Identyfikator kampanii Google Ads lub identyfikatora elementu zamówienia (Display & Video 360) załączonego formularza kontaktowego.
Klienci muszą przetworzyć 8-bajtową liczbę całkowitą. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Identyfikator grupy reklam Google Ads służy do rozróżnienia
konkretnej grupy reklam w kampanii. (Dostępne tylko w przypadku potencjalnych klientów z reklam wideo i reklam Discovery)
Klienci muszą przetworzyć 8-bajtową liczbę całkowitą. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Identyfikator kreacji Google Ads służy do rozróżniania konkretnej kreacji w grupie reklam. (Dostępne tylko w przypadku potencjalnych klientów z reklam wideo i reklam Discovery)
Klienci muszą przetworzyć 8-bajtową liczbę całkowitą. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Identyfikator kliknięcia Google: unikalny parametr służący do śledzenia każdego kliknięcia reklamy. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Klucz konfigurowany przez reklamodawcę w przypadku każdego formularza.
Rekomendacja dotycząca postępowania: zanim przetworzymy potencjalnego klienta otrzymanego przez webhooka, weryfikacja |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
To pole ma znaczenie semantyczne „opcjonalne”. Jeśli wartość to prawda, potraktuj tego potencjalnego klienta jako potencjalnego klienta testowego. Jeśli wartość to false (fałsz) lub pole nie jest podane, potraktuj tego potencjalnego klienta jako prawidłowy kontakt do potencjalnego klienta. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Powtarzająca się krotka klucz-wartość przesyłająca dane przesłane przez użytkownika.
|
Obsługa potencjalnych klientów
Moduły obsługi potencjalnych klientów powinny odpowiadać za pomocą tych kodów HTTP:
Odpowiedź HTTP | Treść odpowiedzi (JSON) | Błąd, który można ponownie naprawić? |
---|---|---|
200 |
{} | Nie dotyczy |
4XX |
{"message: Free form error text, description, descriptions What is not down with request"} | Nie |
5XX |
{"message: Intermittent retraible error optional message"} | Tak |
Duplikaty
Nie ma gwarancji, że pojedynczy kontakt do potencjalnego klienta zostanie dostarczony dokładnie raz, dlatego webhooka do obsługi potencjalnych klientów powinien dobrze obsługiwać duplikaty.