Setup Quality API

Diese API befindet sich derzeit in der Betaphase. Wende dich für Zugriff an deine*n Meta-Ansprechpartner*in.

Werbetreibende, die Server-Events mit der Conversions API teilen, können im Events Manager die Event Match Quality (EMQ) sehen. Dies ist jedoch nur für einzelne Events möglich und lässt sich nur schwer skalieren, wenn ein Tech-Anbieter, eine Agentur oder ein Werbetreibender Hunderte oder Tausende von Meta-Pixeln für sein*ihr Unternehmen verwaltet. Die Setup Quality API kann zur Lösung dieses Problems beitragen, indem sie Setup-Qualitätsmetriken programmatisch und in großem Umfang konsolidiert.

Über Event Match Quality

Event Match Quality

Die Event Match Quality (EMQ) ist eine Punktzahl (von 10), die angibt, wie hilfreich die von deinem Server gesendeten Kund*innen-Informationen bei der Zuordnung von Event-Instanzen zu einem Facebook-Konto sind. Eine hohe Event Match Quality kann die Attribution und Leistung von Anzeigen verbessern. Diese Metrik befindet sich in Entwicklung.

Berechnung

Die Event Match Quality wird berechnet, indem untersucht wird, welche Kund*innen-Informationsparameter von deinem Server über eine Conversions-API-Integration empfangen werden. Außerdem werden die Qualität der empfangenen Informationen und der Prozentsatz der Event-Instanzen, die mit einem Meta-Konto übereinstimmen, berücksichtigt.

Verwendung

Anhand der Event Match Quality wird beurteilt, ob du über die Conversions API die richtigen Kund*innen-Informationen sendest, um deine Events einem Meta-Konto zuzuordnen, und ob du deine Kund*innen-Informationsparameter richtig eingerichtet hast. Parameter für die Kund*innen-Informationen helfen dir, deine Events einem Meta-Konto zuzuordnen, sodass du deinen Anzeigen Conversions zuordnen und sie an Personen ausliefern kannst, bei denen die Wahrscheinlichkeit einer Conversion am größten ist.

Die Event Match Quality wird in Echtzeit berechnet. Weitere Informationen zu Best Practices in Bezug auf EMQ findest du hier.

EMQ ist derzeit nur für Web-Events verfügbar. Für andere Eventtypen wie Offline-Events und Events in physischen Geschäften, App-Events, Conversion Leads oder alle anderen Integrationen in der Alpha- oder Beta-Phase kontaktiere deine*n Meta-Ansprechpartner*in, um zu erfahren, wie du die Match-Qualität verbesserst.

Häufige Anwendungsfälle

Partner und Agenturen können die Setup Quality API nutzen, um ein Qualitäts-Dashboard und Einblicke bereitzustellen und ihren Werbetreibenden bei der Verbesserung und Optimierung ihrer Integrationen zu helfen. Partner können diese Integration auch nutzen, um die Stabilität ihrer Conversions-API-Integration zu überwachen. Werbetreibende können diesen Endpunkt nutzen, um Daten zur Einrichtungsqualität zu sammeln und in ihre Überwachung einzubeziehen.

Authentifizierung

Authentifizierung von Werbetreibenden über den Business Manager

Gehe in Business Manager zum Abschnitt für Nutzer*innen und wähle den Tab Systemnutzer aus. Klicke auf den Systemnutzer, den du für die Conversions API verwendest.
Navigiere zum Dialog „Asset zuweisen“ und wähle Pixel aus. Wähle dann die Pixel aus, in deren Namen du Events senden möchtest.
Wähle für jedes Pixel die Berechtigung „Pixel verwalten“ aus und klicke auf Änderungen speichern.
Gehe zurück zur Detailseite deines Systemnutzers. Überprüfe, ob die ausgewählten Pixel dort angezeigt werden.
Befolge zum Generieren des Zugriffstokens die Anweisungen hier.

Authentifizierung bei Partnerplattform

Du musst zunächst eine Autorisierung zum Senden von Events im Namen deiner Kund*innen beantragen. Für die Authentifizierung stehen dir folgende Optionen zur Verfügung:

Facebook Login for Business (empfohlen)

Facebook Login for Business ist die bevorzugte Authentifizierungs- und Autorisierungslösung für Tech-Anbieter und Entwickler*innen von Business-Apps, die Zugang zu den Assets ihrer Geschäftskunden benötigen. Du kannst damit den Typ von Zugriffsschlüssel, die Asset-Typen sowie die Berechtigungen angeben, die deine App benötigt, und als einen Satz (Konfiguration) speichern. Du kannst den Satz dann deinen Geschäftskunden anzeigen, die den Vorgang abschließen und deiner App Zugriff auf ihre Business-Assets gewähren können.

Meta Business Extension (empfohlen)

Mit dieser Option gibt Meta Facebook Business Extension (MBE) alle notwendigen Informationen zurück, um Events im Namen des*der Kund*in zu senden. Die MBE stellt einen Endpunkt für den Abruf von Zugriffstoken für Systemnutzer bereit, die im Business Manager des*der Kund*in erstellt wurden. Dieser Prozess umfasst Berechtigungen für das Senden von Server-Events. Er erfolgt automatisch und ist sicher. MBE befindet sich derzeit in der Betaphase. Wende dich für Zugriff bitte an deine*n Meta-Ansprechpartner*in.

Der Endpunkt benötigt einen Nutzer*innen-Zugriffstoken als Eingabeparameter. Wenn du ein*e neue* MBE-Nutzer*in bist, rufe diesen Endpunkt auf, um den Zugriffstoken des Systemnutzers abzurufen, nachdem du die MBE eingerichtet hast. Bestehende Nutzer*innen müssen sich erneut authentifizieren lassen, um den neuen API-Endpunkt aufrufen zu können.

Kund*innen teilen Meta-Pixel mit dem Business Manager des Partners

Mit dieser Option teilen Kund*innen ihr Meta-Pixel über die Business Manager-Einstellungen oder über die API mit dem Partner. Der Partner kann dann dem Kund*innen-Pixel den Partnersystemnutzer zuweisen und einen Zugriffstoken zum Senden von Server-Events generieren.

Abrufen von Informationen zur Qualität der Pixel-Einrichtung

Mit dem folgenden API-Endpunkt, den Parametern und Feldern kannst du den Event Match Quality-Wert pro Event zusammen mit den gesendeten Abgleichsschlüsseln überwachen:

Endpunkt

https://graph.facebook.com/v20.0/<pixel_id>/setup_quality

Parameter

Parameter Beschreibung

Parameter	Beschreibung
`agent_name` String	Optional. Der normalisierte Wert des Felds „partner_agent“ wird verwendet, um nur Events zu filtern, die mit dem Parameter „partner_agent“ in der POST-Anfrage /{pixel_id}/events gesendet wurden (siehe Best Practices zur Zuordnung deiner Events hier und hier). Lautet dein „partner_agent“-Wert beispielsweise `[partner_name]_[majorversion]_[minorVersion]`, ist dein normalisierter Wert für den Agent-String `partner_name` in Kleinbuchstaben. Mit dem `agent_name` kannst du deine eigene Plattform-ID festlegen, wenn du Events im Namen eineseiner Kundin sendest. Wende dich als Managed Partner/Agentur an deinen Ansprechpartnerin bei Meta, um gemeinsam eine ID für deine Plattform festzulegen. Wenn du Werbetreibender bist, solltest du dir in den meisten Fällen keine Gedanken über die `agent_name`-Attribution machen. Wenn du keinen `agent_name` angibst, werden alle Events in die EMQ-Berechnung aufgenommen, unabhängig davon, ob sie von einem Agent gesendet wurden oder nicht.

agent_name

String

Optional.
Der normalisierte Wert des Felds „partner_agent“ wird verwendet, um nur Events zu filtern, die mit dem Parameter „partner_agent“ in der POST-Anfrage /{pixel_id}/events gesendet wurden (siehe Best Practices zur Zuordnung deiner Events hier und hier).

Lautet dein „partner_agent“-Wert beispielsweise [partner_name]_[majorversion]_[minorVersion], ist dein normalisierter Wert für den Agent-String partner_name in Kleinbuchstaben.

Mit dem agent_name kannst du deine eigene Plattform-ID festlegen, wenn du Events im Namen eines*einer Kund*in sendest. Wende dich als Managed Partner/Agentur an deine*n Ansprechpartner*in bei Meta, um gemeinsam eine ID für deine Plattform festzulegen.

Wenn du Werbetreibender bist, solltest du dir in den meisten Fällen keine Gedanken über die agent_name-Attribution machen.

Wenn du keinen agent_name angibst, werden alle Events in die EMQ-Berechnung aufgenommen, unabhängig davon, ob sie von einem Agent gesendet wurden oder nicht.

Felder

Feld	Beschreibung
`event_name` String	Der Name eines Standard-Events oder selbstdefinierten Events.
`event_match_quality` AdsPixelCAPIEMQ	Die Event Match Quality gibt Aufschluss darüber, wie hilfreich die von deinem Server gesendeten Kund*innen-Informationen dabei sind, Event-Instanzen einem Facebook-Konto zuzuordnen.

Beispiel

Graph API Explorer

GET/v20.0/<PIXEL_ID>/setup_quality?fields=event_match_quality,event_name&agent_name=<AGENT_NAME>&access_token=<ACCESS_TOKEN>

cURL

curl -X GET -G \
  -d 'fields="event_match_quality,event_name"' \
  -d 'agent_name="&lt;AGENT_NAME&gt;"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<LATEST_VERSION>/<PIXEL_ID>/setup_quality

API-Antwort

{
  "data": [
    {
      "event_match_quality": {
        "composite_score": 6.2,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "ip_address",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          }
        ]      
      },
      "event_name": "pLTVPurchase"
    },
    {
      "event_match_quality": {
        "composite_score": 7.2,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "ip_address",
            "coverage": {
              "percentage": 99.9
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "phone",
            "coverage": {
              "percentage": 69.1
            }
          },
          {
            "identifier": "fbp",
            "coverage": {
              "percentage": 96.7
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "fbc",
            "coverage": {
              "percentage": 3.2
            }
          }
        ]
      },
      "event_name": "CompleteRegistration"
    }
  ]
}

FAQs

What is the access token used for?

The access token is used when partners send signal events or access the Setup Quality API on behalf of advertisers. The client system user access token onboarding method is not compatible with the EMQ API at the moment.

Permalink

How should the partner_agent field be formatted?

The partner_agent value in your API GET request should be a normalized lowercase format. This field is now optional.

Permalink

Mehr erfahren

Conversions API – Best Practices.
Steigere die Leistung mit einer optimierten Conversions API-Einrichtung.
Best Practices für das Onboarding der Conversions API für Partner
Informationen zur Qualität der Conversions API-Einrichtung aus dem Hilfebereich für Unternehmen von Meta:

Best Practices zur Verbesserung der Anzeigenleistung durch die Conversions API. Diese Best Practices der Conversions API können Unternehmen helfen, die Performance der Werbeanzeigen zu verbessern, indem sie die Kosten pro Handlung senken. Wir empfehlen, diese Best Practices bei der Ersteinrichtung zu befolgen. Sie können aber auch zur Aktualisierung bestehender Einrichtungen verwendet werden.

Die Server-Event-Details im Meta Events Manager aufrufen. Nachdem Unternehmen die Conversions API eingerichtet haben, können sie in diesem Artikel erfahren, wie sie Events und Parameter überwachen können, um sicherzustellen, dass ihre Einrichtung effektiv funktioniert, und um Verbesserungsmöglichkeiten zu identifizieren. Sie können in diesem Artikel auch erfahren, wie sie die Details von Server-Events (Event Matching [Event Match Quality/EMQ]), Datenaktualität, Event-Übersicht und Event-Deduplizierung) in Events Manager nutzen können, um ihre Conversions API-Einrichtung zu verbessern.