Implementierung

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 form_id segmentiert werden. (d.h. auf Kampagnenebene).

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 google_key entspricht der Konfiguration in Google Ads verwenden, um die Gültigkeit des Leads sicherer zu machen. Notizen dieser Schlüssel vertraulich zu behandeln und in Google Ads zu aktualisieren, falls es einen Grund gibt, glauben, dass dies weit verbreitet ist.
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.
  • user_column_data.column_id: Datentyp, eingereicht von Nutzenden.
  • User_column_data.column_value: Für jeden Datentyp wird ein Werttyp je nach Datentyp eingefügt. Alle unsere aktuellen Datentypen den Wert user_column_data.string_value
  • user_column_data.column_name: menschenlesbarer Text von den vom Nutzer eingereichten Datentyp. Dieses Feld ist nicht immer ausgefüllt, verwenden Sie stattdessen column_id .
user_column_data.column_id Inhalt_nutzer_column_data.string_value user_column_data.column_name (eingestellt)
"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 „E-Mail-Adresse des Nutzers“
PHONE_NUMBER Telefonnummer des Nutzers in E.164 Format, z.B. "+11234567890". „Telefonnummer des Nutzers“
"POSTAL_CODE" Postleitzahl des Nutzers. „Postleitzahl“
"COMPANY_NAME" Unternehmensname des Nutzers. „Name des Unternehmens“
"JOB_TITLE" Position des Nutzers. „Position“
WORK_EMAIL Geschäftliche E-Mail-Adresse des Nutzers. „Geschäftliche E-Mail-Adresse“
WORK_PHONE Geschäftliche Telefonnummer des Nutzers. „Telefon (geschäftlich)“
„STREET_ADDRESS“ Adresse des Nutzers „Adresse“
"STADT" Stadt des Nutzers. „Stadt“
„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? –
"PRODUKT" Für welches Produkt interessieren Sie sich? –
"DIENST" Welche Dienstleistung interessiert Sie? –
"ANGEBOT" Für welches Angebot interessieren Sie sich? –
"KATEGORIE" 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öchtest du eine Veranstaltung buchen? –
"DESTINATION_COUNTRY" Was ist Ihr Zielland? –
"DESTINATION_CITY" Was ist Ihr Zielort? –
„ABFAHRT_LAND“ Was ist Ihr Abreiseland? –
„ABFAHRT_STADT“ Was ist Ihr Abreiseort? –
„ABFAHRT_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? –

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.