POST-Schema
Die an den Webhook gesendete POST-Anfrage hat das JSON-Format mit folgendem Inhalt: 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: Hiermit deduplizieren Sie Leads, die erhalten haben. Dieser Name ist in allen Formularen eindeutig. Beim Melden Probleme im Zusammenhang mit einem bestimmten Lead auftreten, ist diese ID erforderlich. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Die API-Version, zu der dieses Lead-Schema gehört. Wird verwendet, wenn Migration zu einem neuen Schema und kann vorerst ignoriert werden. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Eindeutige ID für jedes in Google Ads konfigurierte Formular. Aktuelles Produkt ermöglicht
Hinzufügen eines Formulars auf Kampagnenebene (im Vergleich zum Anhängen auf Anzeigengruppenebene oder Anzeigengruppe)
Stufen).
Auswirkungen: Leads können nur nach Clients müssen für die Verarbeitung eine Ganzzahl von 8 Byte verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
Die Google Ads-Kampagnen-ID oder -Werbebuchungs-ID (Display &Video 360) des
angehängten Lead-Formular aus.
Clients müssen für die Verarbeitung eine 8-Byte-Ganzzahl verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
Anhand der Google Ads-Anzeigengruppen-ID wird die spezifische
Anzeigengruppe in der Kampagne. (Verfügbar für Leads aus Video- und Discovery-Kampagnen
Anzeigen)
Clients müssen für die Verarbeitung eine 8-Byte-Ganzzahl verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
Anhand der Google Ads-Creative-ID wird ein bestimmtes
Creative in der Anzeigengruppe. (Verfügbar für Leads aus Video- und Discovery-Kampagnen
Anzeigen)
Clients müssen für die Verarbeitung eine 8-Byte-Ganzzahl verwenden. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Google-Klick ID, ein eindeutiger Parameter, mit dem jeder Klick auf eine Anzeige erfasst wird. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Ein Schlüssel, der vom Werbetreibenden mit jedem Formular konfiguriert wird.
Empfehlung: Vor der Bearbeitung eines Leads, der über
Webhooks. Die Validierung von |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Dieses Feld enthält "optional" Semantik. Wenn der Wert „true“ ist, wird dieser Wert behandelt Lead als Test-Lead. Wenn der Wert falsch oder das Feld nicht vorhanden ist, behandeln als gültiger Produktionsleiter. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Ein wiederholtes Schlüsselwert-Tupel, das vom Nutzer übermittelte Daten überträgt.
|
Lead-Verarbeitung
Lead-Handler sollten mit den folgenden HTTP-Codes antworten:
HTTP-Antwort | Antworttext (JSON) | Wiederholbarer Fehler? |
---|---|---|
200 |
{} | – |
4XX |
{"message: Fehlertext in freiem Format, Beschreibung des Fehlers in der Anfrage"} | Nein |
5XX |
{"message: Intermitt retraible error optional message" (Nachricht: Intermitt retraible error optionale Fehlermeldung) | Ja |
Duplikate
Es ist nicht garantiert, dass ein Lead genau einmal ausgeliefert wird. sollten Duplikate ordnungsgemäß verarbeitet werden.