Implementierung

POST-Schema

Die an den Webhook gesendete POST-Anfrage ist im JSON-Format mit dem folgenden Schema:

Webhook-Protonutzlast

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

Feldbeschreibung

Feld	Beschreibung
lead_id	Eindeutiger String, der einen bestimmten Lead identifiziert. Empfehlung zum Umgang:Verwenden Sie diese Option, um eingehende Leads zu deduplizieren. Er muss für alle Formulare eindeutig sein. 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. Dieser Wert 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. Mit dem aktuellen Produkt können Formulare auf Kampagnenebene angehängt werden (nicht auf Anzeigengruppen- oder Anzeigenebene). Folgen:Leads können nur auf form_id-Ebene (d.h. auf Kampagnenebene) segmentiert werden. Clients müssen für die Verarbeitung Ganzzahlen mit 8 Byte verwenden.
campaign_id	Die Google Ads-Kampagnen-ID oder die Werbebuchungs-ID (Display & Video 360) des angehängten Lead-Formulars. Clients müssen eine 8-Byte-Ganzzahl für die Verarbeitung verwenden.
adgroup_id	Mit der Google Ads-Anzeigengruppen-ID wird die jeweilige Anzeigengruppe in der Kampagne identifiziert. (Nur für Leads aus Video- und Discovery-Anzeigen verfügbar) Clients müssen eine 8-Byte-Ganzzahl für die Verarbeitung verwenden.
creative_id	Mit der Google Ads-Creative-ID wird das jeweilige Creative in der Anzeigengruppe identifiziert. (Nur für Leads aus Video- und Discovery-Anzeigen verfügbar) Clients müssen eine 8-Byte-Ganzzahl für die Verarbeitung 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 für jedes Formular konfiguriert wird. Empfehlung zur Verarbeitung:Bevor Sie einen über einen Webhook empfangenen Lead verarbeiten, sollten Sie google_key validieren. Das ist mit der Konfiguration in Google Ads vergleichbar und gibt Ihnen mehr Sicherheit, dass der Lead gültig ist. Bewahren Sie diesen Schlüssel vertraulich auf und aktualisieren Sie ihn in Google Ads, wenn Sie Grund zur Annahme haben, dass er allgemein bekannt ist.
is_test	Dieses Feld hat die Semantik „optional“. Wenn der Wert „wahr“ ist, wird dieser Lead als Test-Lead behandelt. Wenn der Wert „false“ ist oder das Feld nicht vorhanden ist, behandeln Sie diesen Lead als gültigen Produktionslead.
user_column_data	Ein wiederholtes Schlüssel/Wert-Tupel, über das von Nutzern übermittelte Daten übertragen werden. user_column_data.column_id: Vom Nutzer eingereichter Datentyp. User_column_data.column_value: Für jeden Datentyp wird ein Wertetyp ausgefüllt, der vom Datentyp abhängt. Alle unsere aktuellen Datentypen haben den Wert user_column_data.string_value. user_column_data.column_name: Der vom Nutzer eingereichte Datentyp in lesbarer Form. Dieses Feld ist möglicherweise nicht immer ausgefüllt. Verwenden Sie stattdessen column_id . user_column_data.column_id User_column_data.string_value-Inhalt user_column_data.column_name (verworfen) „FULL_NAME“ Vollständiger Name des Nutzers. „Vollständiger Name“ „FIRST_NAME“ Vorname des Nutzers „Vorname“ „LAST_NAME“ Nachname des Nutzers „Nachname“ „EMAIL“ E-Mail-Adresse des Nutzers „Nutzer-E-Mail-Adresse“ „PHONE_NUMBER“ Telefonnummer des Nutzers im E.164-Format, z.B. "[phone]". „Nutzertelefon“ „POSTAL_CODE“ Postleitzahl des Nutzers. „Postleitzahl“ „COMPANY_NAME“ Name des Unternehmens des Nutzers. „Name des Unternehmens“ „JOB_TITLE“ Die Position des Nutzers. „Beruf“ „WORK_EMAIL“ Die geschäftliche E-Mail-Adresse des Nutzers. „E-Mail-Adresse für geschäftliche Zwecke“ „WORK_PHONE“ Geschäftliche Telefonnummer des Nutzers. „Geschäftstelefon“ „STREET_ADDRESS“ Die Adresse des Nutzers. „Straßenadresse“ „STADT“ Wohnort des Nutzers. „Ort“ „REGION“ Region des Nutzers. „Region“ „COUNTRY“ Land des Nutzers. „Land“ „VEHICLE_MODEL“ Für welches Modell interessieren Sie sich? – „VEHICLE_TYPE“ Für welchen Fahrzeugtyp interessieren Sie sich? – „PREFERRED_DEALERSHIP“ Bevorzugten Händler auswählen – „VEHICLE_PURCHASE_TIMELINE“ Wann möchten Sie ein Fahrzeug kaufen? – „VEHICLE_CONDITION“ Welchen Zustand soll das Fahrzeug haben? – „VEHICLE_OWNERSHIP“ Besitzt du ein Fahrzeug? „–“ „VEHICLE_PAYMENT_TYPE“ Welche Form der Fahrzeugfinanzierung interessiert Sie? – „COMPANY_SIZE“ Wie groß ist Ihr Unternehmen? – „ANNUAL_SALES“ Wie hoch ist Ihr Jahresumsatz? – „YEARS_IN_BUSINESS“ Wie lange sind Sie schon im Geschäft? – „JOB_DEPARTMENT“ In welcher Abteilung arbeiten Sie? – „JOB_ROLE“ Welchen Beruf üben Sie aus? – „EDUCATION_PROGRAM“ Für welches Programm interessieren Sie sich? – „EDUCATION_COURSE“ Für welchen Kurs interessieren Sie sich? – „PRODUCT“ Für welches Produkt interessieren Sie sich? – „SERVICE“ Welche Dienstleistung interessiert Sie? – „ANGEBOT“ Für welches Angebot interessieren Sie sich? – „CATEGORY“ Für welche Kategorie interessieren Sie sich? – „PREFERRED_CONTACT_METHOD“ Bevorzugte Methode zur Kontaktaufnahme auswählen – „PREFERRED_LOCATION“ Bevorzugten Standort auswählen – „PREFERRED_CONTACT_TIME“ Wann sind Sie am besten zu erreichen? – „PURCHASE_TIMELINE“ Wann möchtest du etwas kaufen? – „YEARS_OF_EXPERIENCE“ Wie viele Jahre Berufserfahrung haben Sie? – „JOB_INDUSTRY“ In welcher Branche sind Sie tätig? – "LEVEL_OF_EDUCATION" Was ist Ihr höchster Bildungsabschluss? – „PROPERTY_TYPE“ Nach welcher Art von Immobilie suchen Sie? – „REALTOR_HELP_GOAL“ Wobei soll Ihnen ein Makler helfen? – „PROPERTY_COMMUNITY“ Welche Immobilienart interessiert Sie? – „PRICE_RANGE“ Für welche Preisspanne interessieren Sie sich? – „NUMBER_OF_BEDROOMS“ Wie viele Schlafzimmer möchten Sie? – „FURNISHED_PROPERTY“ Bist du auf der Suche nach einer voll möblierten Immobilie? – „PETS_ALLOWED_PROPERTY“ Suchen Sie nach Immobilien, in denen Haustiere erlaubt sind? – „NEXT_PLANNED_PURCHASE“ Welches Produkt möchten Sie als Nächstes kaufen? – „EVENT_SIGNUP_INTEREST“ Möchten Sie sich für eine Veranstaltung registrieren? – „PREFERRED_SHOPPING_PLACES“ Wo würden Sie einkaufen? – „FAVORITE_BRAND“ Was ist Ihre Lieblingsmarke? – "TRANSPORTATION_COMMERCIAL_LICENSE_TYPE" Welche Art von gültiger gewerblicher Lizenz haben Sie? – „EVENT_BOOKING_INTEREST“ Möchten Sie eine Veranstaltung buchen? – „DESTINATION_COUNTRY“ Was ist Ihr Zielland? – „DESTINATION_CITY“ Was ist Ihr Zielort? – „DEPARTURE_COUNTRY“ Was ist Ihr Abreiseland? – „DEPARTURE_CITY“ Was ist Ihr Abreiseort? – "DEPARTURE_DATE" Wann reisen Sie ab? – „RETURN_DATE“ Wann reisen Sie zurück? – „NUMBER_OF_TRAVELERS“ Mit wie vielen Personen reisen Sie? – „TRAVEL_BUDGET“ Wie hoch ist Ihr Reisebudget? – "TRAVEL_ACCOMMODATION" Wo möchten Sie während der Reise übernachten? –
asset_group_id	Dieses Feld wird nur für Performance Max-Kampagnen ausgefüllt. Dies ist die Container-ID, die das Lead-Formular enthält. Clients müssen eine 8-Byte-Ganzzahl für die Verarbeitung verwenden.

Lead-Verarbeitung

Lead-Handler sollten mit den folgenden HTTP-Codes antworten:

HTTP-Antwort	Antworttext (JSON)	Wiederholbarer Fehler?
200	{}	–
4XX	{"message: Kostenloser Fehlertext, der beschreibt, was mit der Anfrage nicht stimmt"}	Nein
5XX	{"message: Optionale Meldung zu einem vorübergehenden, wiederholbaren Fehler"}	Ja

Duplikate

Es kann nicht garantiert werden, dass ein einzelner Lead genau einmal gesendet wird. Daher sollte der Webhook für die Lead-Verarbeitung Duplikate ordnungsgemäß verarbeiten.

Wichtig: Verwenden Sie lead_id, um Leads zu deduplizieren.