Conversions API

Payload-Spezifikation

Wenn du dein CRM-System mit der Conversions API von Meta integrierst und für Lead Ads als Ziel die Optimierung für Conversion Leads verwendest, erzielst du möglicherweise bessere Ergebnisse. Aktuell unterstützt diese Optimierung nur native Lead Ads (Instant-Formulare), die auf Facebook oder Instagram generiert werden.

Dieser Leitfaden enthält die Payload-Spezifikation für hochgeladene CRM-Events nur für die Optimierung für Conversion Leads. Verwende diese Spezifikation nicht für Events ohne Bezug zu dieser Optimierung.

Weitere Informationen zum Einstieg in die API und zusätzliche hilfreiche Ressourcen findest du in der Dokumentation zur Conversions API.

Event-Payload

Parameter

NameBeschreibung

lead_id

Integer

Erforderlich
Die von Facebook generierte ID für jeden Lead. Dabei handelt es sich um eine 15- oder 16-stellige Zahl, die vom leadgen_id-Feld im Leadgenerierungs-Webhook abgerufen wird und unter dem Parameter user_data enthalten ist. Weitere Informationen findest du unter So findest du die Lead-ID.
Es ist erforderlich, Lead-IDs statt Kund*inneninformationen zum Abgleich zu verwenden. Verwende eine Variable zum Übergeben der ID-Werte aus deinem CRM.
Hinweis: Nicht hashen.

event_name

String

Erforderlich.
Freitextfeld zur Erfassung der Phasen, die du in deinem CRM verwendest.
Stelle sicher, dass du alle Phasen sendest, sobald sie aktualisiert wurden, einschließlich der anfänglichen Lead-Phase.
Deine Phasen können zum Beispiel folgende Typen umfassen: Wenn ein Lead die letzte Phase („Konvertiert“) erreicht, sollten alle vorhergehenden Phasen zuvor gesendet worden sein.

  1. Erster Lead von Facebook
  2. Für Marketing qualifizierter Lead
  3. Verkaufschance
  4. Konvertiert

Verwende eine Variable zum Übergeben der Phasen aus deinem CRM. Alternativ kannst du auch einen separaten API-Aufruf für jede Phase erzeugen.

event_time

Integer

Erforderlich.
Ein UNIX-Zeitstempel in Sekunden, der angibt, wann das Update-Event der Lead-Phase von deinem CRM aktualisiert wurde.
Verwende eine Variable zum Übergeben der UNIX-Zeitstempelwerte aus deiner Datenbank.
Hinweis: Der Parameterwert event_time kann bis zu 7 Tage vor dem Zeitpunkt liegen, zu dem du ein Event an Meta sendest. Auch der Zeitstempel muss nach dem Leadgenerierungszeit liegen, sonst kann das Event verworfen werden.

action_source

String

Erforderlich.
Lege diesen Parameter auf den Wert system_generated für alle Conversion Leads-Events fest.
Für Conversion Leads-Integrationen gibt dies an, wo deine Conversions vom System generiert werden.

lead_event_source

String

Erforderlich.
Lege diesen Parameter auf den Namen des Tools fest, von dem die Leads kommen (z. B. Hubspot, SAP, Oracle, Dynamics, internes CRM, etc.); wird unter dem Parameter custom_data angegeben.

event_source

String

Erforderlich.
Lege diesen Parameter auf den Wert crm für alle Conversions Leads-Events fest.
Für die Conversion Leads-Integration gibt dies die Quelle des Events als dein CRM unter dem Parameter custom_data an.

Beispiel

Dieses Beispiel veranschaulicht das Format der Event-Payload, die im API-Aufruf gesendet wird.

{
    "event_name": "my lead stage",
    "event_time": 1617693833,
    "user_data": {
        "lead_id": 1234567890123456
    },
    "action_source": "system_generated",
    "custom_data": {
        "lead_event_source": "Salesforce",
        "event_source": "crm"
    }
}

Mehr dazu