POST-Schema
Die an den Webhook gesendete POST-Anfrage hat das JSON-Format mit dem folgenden Schema:
Webhook-Proto-Nutzlast
// 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;
}
Feldbeschreibung
Feld | Beschreibung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Eindeutiger String, der einen bestimmten Lead identifiziert.
Empfehlung zur Verarbeitung:Hiermit können Sie Duplikate von eingehenden Leads entfernen. Dieser Name ist für alle Formulare eindeutig. Wenn Sie Probleme im Zusammenhang mit einem bestimmten Lead melden, ist diese ID erforderlich. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
API-Version, zu der dieses Lead-Schema gehört. Dies wird bei der Migration zu einem neuen Schema verwendet und kann vorerst ignoriert werden. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Eindeutige ID für jedes in Google Ads konfigurierte Formular Das aktuelle Produkt ermöglicht das Anhängen eines Formulars auf Kampagnenebene im Gegensatz zum Anhängen auf Anzeigengruppen- oder Anzeigenebene.
Auswirkungen:Leads können nur auf Clients müssen zum Verarbeiten eine Ganzzahl von 8 Byte verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
Die Google Ads-Kampagnen-ID oder Werbebuchungs-ID (Display & Video 360) des angehängten Lead-Formulars.
Clients müssen für die Verarbeitung eine 8-Byte-Ganzzahl verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Die Google Ads-Anzeigengruppen-ID dient dazu, eine bestimmte Anzeigengruppe in der Kampagne zu unterscheiden. (Nur für Leads aus Video- und Discovery-Anzeigen verfügbar)
Clients müssen für die Verarbeitung eine 8-Byte-Ganzzahl verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Die Google Ads-Creative-ID wird verwendet, um ein Creative in der Anzeigengruppe zu unterscheiden. (Nur für Leads aus Video- und Discovery-Anzeigen verfügbar)
Clients müssen für die Verarbeitung eine 8-Byte-Ganzzahl verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Google Click ID, ein eindeutiger Parameter, mit dem jeder Klick auf eine Anzeige erfasst wird. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Ein vom Werbetreibenden für jedes Formular konfigurierter Schlüssel.
Empfehlung zur Verarbeitung:Vor der Verarbeitung eines Lead, der über einen Webhook empfangen wurde, entspricht die Validierung von |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Die Semantik dieses Feldes ist optional. Wenn der Wert „true“ ist, wird dieser Lead als Test-Lead behandelt. Wenn der Wert „false“ ist oder das Feld nicht vorhanden ist, wird dieser Lead als gültigen Produktions-Lead behandelt. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Wiederholtes Schlüssel/Wert-Tupel, das vom Nutzer übermittelte Daten überträgt.
|
Umgang mit Anfragen
Lead-Handler sollten mit den folgenden HTTP-Codes antworten:
HTTP-Antwort | Antworttext (JSON) | Wiederholbarer Fehler? |
---|---|---|
200 |
{} | – |
4XX |
{"message: Free form error text, which what was wrong with request"} | Nein |
5XX |
{„message: Intermitt retraible error optional message"} | Ja |
Duplikate
Es kann nicht garantiert werden, dass ein einzelner Lead genau einmal gesendet wird. Daher sollte der Webhook, der Lead-Verarbeitung verarbeitet, Duplikate ordnungsgemäß verarbeiten sollten.