Mit der Conversions API können Werbetreibende Web-Events, App-Events, Events in physischen Stores und Business-Messaging-Events über einen einzigen Endpunkt statt über mehrere Quellen an Meta senden. Diese Konsolidierung vereinfacht die technischen Anforderungen für Werbetreibende. Außerdem wird mit der Verwendung von Datensätzen eine umfassendere Ansicht im Meta Events Manager erstellt.
Diese Dokumentation enthält eine Anleitung zur Integration von App-Events in die Conversions API.
Über die Conversions API gesendete App-Events müssen mit einem Datensatz verbunden sein.
Datasets allow advertisers to connect and manage event data from web, app, store and business messaging event sources to the Conversions API. Datasets may show event data from any of these integrations that you choose to set up:
Datasets enable you to view all customer activities from a single interface. They also allow you to reduce the effort to build and maintain multiple API integrations.
In Events Manager, advertisers have different options to create a dataset depending on their starting point. Or you can create a brand new dataset in Events Manager by linking during offline event set creation or through an existing mobile app or during messaging event set creation information. Note that linking a dataset to an application is required before sending mobile app events to the Conversions API and only one application can be linked to a dataset. See more details and instructions here.
Du kannst den GET
-Aufruf unter https://graph.facebook.com /v16.0/{ads-pixel-id}/is_consolidated_container tätigen, um festzustellen, ob der Datensatz des Werbetreibenden konsolidiert und somit zur Weitergabe von App-Events über die Conversions API autorisiert ist.
a. Verlinken von Datensatz-ID und App-ID
Im Events Manager gibt es zwei Möglichkeiten, deine App mit einem Datensatz zu verlinken:
Sobald du die Verlinkung abgeschlossen hast, enthält der Datensatz die verbundene App.
b. Erforderliche Felder
Du kannst hier auf den aktuellen Satz Parameter verweisen, der über die Conversions API gesendet werden kann. Zum Senden von App-Events können die folgenden server_event Felder im Payload geteilt werden:
action_source
muss den Wert app
für App-Events enthalten.event_id
ist für die Deduplizierungs-Einrichtung erforderlich.Parameter | Description |
---|---|
advertiser_tracking_enabled boolean | Required for app events Use this field to specify ATT permission on an iOS 14.5+ device. Set to |
application_tracking_enabled boolean | Required for app events A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use |
extinfo object Please use the down arrow to the right to see the list of | Required for app events Extended device information, such as screen width and height. This parameter is an array and values are separated by commas. When using Note:
|
campaign_ids string | Optional An encrypted string and non-user metadata appended to the outbound URL (for example, ad_destination_url) or deep link (for App Aggregated Event Manager) when a user clicked on a link from Facebook. Graph API definition: Parameter passed via the deep link for Mobile App Engagement campaigns. |
install_referrer string | Optional |
installer_package string | Optional Used internally by the Android SDKs |
url_schemes array | Optional Used internally by the iOS and Android SDKs. |
vendor_id string | Optional Vendor ID. |
windows_attribution_id string | Optional Attribution token used for Windows 10. |
Parameter | Beschreibung |
---|---|
anon_id String | Nicht hashen. |
madid String | Nicht hashen. |
Parameter | Beschreibung |
---|---|
description String | Optional. |
level String | Optional. |
max_rating_value | Optional. |
success Boolescher Wert | Optional. |
Insgesamt sind für die App-Events, die mit der Conversions API geteilt werden, die folgenden Datenparameter erforderlich:
action_source
: Muss auf „App“ eingestellt sein. (Indem du die Conversions API verwendest, versicherst du, dass der Parameter action_source
nach bestem Wissen und Gewissen richtig ist.)event_id
: Für die Einrichtung der Deduplizierung erforderlich, siehe Details unter „Einrichten der Deduplizierung für mehrere Kanäle“.Nachstehend findet du ein Beispiel für extinfo
. Stelle sicher, dass alle nachstehenden Unterparameter angegeben sind und in sequentieller Reihenfolge aufgeführt werden. Falls etwas fehlt, füge einen leeren String als Platzhalter ein.
Name des Unterparameters | Erforderlich | Datentyp | Beispiel |
---|---|---|---|
extinfo-Version | Ja | String |
|
App-Paketname | Nein | String |
|
Kurzversion | Nein | String |
|
Lange Version | Nein | String |
|
Betriebssystemversion | Ja | String |
|
Gerätemodellname | Nein | String |
|
Ländereinstellung | Nein | String |
|
Zeitzone Abk. | Nein | String |
|
Anbieter | Nein | String |
|
Bildschirmbreite | Nein | String |
|
Bildschirmhöhe | Nein | String |
|
Bildschirmdichte | Nein | String |
|
CPU-Core | Nein | String |
|
Größe des externen Speichers | Nein | String |
|
freier Speicherplatz in externem Speicher | Nein | String |
|
Zeitzone für das Gerät | Nein | String |
|
c. Einrichten der Deduplizierung für mehrere Kanäle
Der Deduplizierungsmechanismus ist erforderlich, um den duplizierten Event-Traffic zwischen der Conversions API-Integration und deinen anderen bestehenden Integrationen mit App Events, einschließlich SDK, MMPs und App Events API, zu entfernen.
Für App-Events wenden wir dieselbe Deduplizierungsfunktion an wie für Web-Events. Die Logik nutzt die auf den Feldern event_id
und event_name
basierte Deduplizierung (Conversions API und SDK / App Events API-Events, die über dieselbe event_id
verfügen). Der event_id-Parameter ist eine ID zur eindeutigen Unterscheidung ähnlicher Events. Ungenaue Event-IDs können zu einer fehlerhaften Deduplizierung deiner Conversion führen. Dies kann sich auf das Conversion-Reporting und die Kampagnenperformance auswirken.
Informationen zur Einrichtung der Deduplizierung findest du in der folgenden Dokumentation für Entwickler*innen:
Hier findest du ein Beispiel für die Protokollierung von selbstdefinierten Events. Übergib hierfür den Namen des Events als AppEvents.Name an das iOS-SDK:
AppEvents.shared.logEvent(.achievedLevel, parameters: [AppEvents.ParameterName(rawValue: "event_id"): "123"])
Für App-Installations-Events gibt es bereits einen Deduplizierungsmechanismus, der sicherstellt, dass im letzten 90-Tage-Fenster nur eine Installation zugeordnet wird Wir behalten das erste Event und ignorieren die neueren Events unabhängig von ihrer Handlungs-Quelle. Die Deduplizierung für mit Installations-Events verwandten App-Events muss nicht zwingend implementiert werden.
d. Senden von Events
Tätige zum Senden neuer Events eine POST
-Anfrage von folgendem Pfad an die Conversions API: https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}
. Wenn du in dieser Edge postest, erstellt Meta neue App-Server-Events. Mehr dazu findest du im folgenden Entwicklungsdokument.
Hier findest du eine Übersicht dazu, wie sich die Parameter in das Gesamtschema in der Payload einfügen:
{ "data": [ { "event_name": "Purchase", "event_time": 1684389752, "action_source": "app", "user_data": { "em": [ "30a79640dfd8293d4f4965ec11821f640ca77979ca0a6b365f06372f81a3f602" ], "ph": [ "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b", "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b" ], "madid": "bbbbbbbbbbbb", "anon_id": "cccccccc" }, "custom_data": { "currency": "USD", "value": "142.52" }, "app_data": { "advertiser_tracking_enabled": "True", "application_tracking_enabled": "True", "campaign_ids": "aaaaaaaaa", "extinfo": [ "a2", "com.some.app", "771", "Version 7.7.1", "10.1.1", "OnePlus6", "en_US", "GMT-1", "TMobile", "1920", "1080", "2.00", "2", "128", "8", "USA/New York" ] } } ] }
Mit dem Payload-Hilfstool kannst du Payload-Daten generieren:
app
.Verwende das Test-Events-Tool im Events Manager zum Testen.