L'API Conversions consente agli inserzionisti di inviare eventi web, nell'app, nei punti vendita fisici e relativi alla messaggistica aziendale a Meta attraverso un unico endpoint anziché su più origini. Questo consolidamento semplificherà lo stack tecnologico degli inserzionisti e creerà una visione più completa in Gestione eventi di Meta usando i dataset.
Questa documentazione fornisce indicazioni per integrare gli eventi nell'app nell'API Conversions.
Gli eventi nell'app inviati tramite l'API Conversions devono essere associati a un dataset.
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.
Puoi effettuare la chiamata GET
a https://graph.facebook.com /v16.0/{ads-pixel-id}/is_consolidated_container per rilevare se il dataset dell'inserzionista è consolidato e quindi idoneo per passare eventi nell'app tramite l'API Conversions.
a. Collegamento dell'ID del dataset e dell'ID dell'app
In Gestione eventi ci sono due modi per collegare la tua app a un dataset:
Una volta completato il collegamento, il dataset include l'app collegata.
b. Campi obbligatori
Puoi fare riferimento qui all'attuale insieme di parametri che possono essere inviati tramite l'API Conversions. Per l'invio di eventi nell'app, i seguenti campi server_event possono essere condivisi nel payload:
action_source
deve contenere il valore app
per gli eventi nell'app.event_id
è obbligatorio per il caso di configurazione della deduplicazione.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. |
Parametro | Descrizione |
---|---|
anon_id stringa | Non applicare l'algoritmo di hashing. |
madid stringa | Non sottoporre a procedura di hashing. |
Parametro | Descrizione |
---|---|
description stringa | Facoltativo. |
level stringa | Facoltativo. |
max_rating_value | Facoltativo. |
success booleano | Facoltativo. |
In sintesi, gli eventi nell'app condivisi usando l'API Conversions richiederanno i seguenti parametri dei dati:
action_source
: deve essere impostato su "app". (Usando l'API Conversions, dichiari che il parametro action_source
, per quanto ne sai, è accurato).event_id
: obbligatorio per la configurazione della deduplicazione, vedi i dettagli nella sezione "Configurazione della deduplicazione per più canali".Di seguito un esempio di extinfo
. Assicurati che tutti i sottoparametri siano compilati e in ordine sequenziale. Se manca qualcosa, usa una stringa vuota come segnaposto.
Nome sottoparametro | Obbligatorio | Tipo di dati | Esempio |
---|---|---|---|
extinfo version | Sì | stringa |
|
app package name | No | stringa |
|
short version | No | stringa |
|
long version | No | stringa |
|
os version | Sì | stringa |
|
device model name | No | stringa |
|
locale | No | stringa |
|
timezone abbr | No | stringa |
|
carrier | No | stringa |
|
screen width | No | stringa |
|
screen height | No | stringa |
|
screen density | No | stringa |
|
cpu core | No | stringa |
|
external storage size | No | stringa |
|
free space in external storage size | No | stringa |
|
device time zone | No | stringa |
|
c. Configurazione della deduplicazione per più canali
Il meccanismo di deduplicazione sarà necessario per rimuovere il traffico di eventi duplicati tra l'integrazione dell'API Conversions e tutte le altre integrazioni esistenti che hai con gli eventi nell'app, tra cui SDK, MMP e API App Events.
Per gli eventi nell'app, applichiamo la stessa funzionalità di deduplicazione esistente per gli eventi web. La logica sfrutta il campo event_id
e la deduplicazione basata su event_name
(eventi API Conversions e SDK/API App Events che hanno lo stesso event_id
). Il parametro event_id è un identificatore che può distinguere in modo univoco eventi simili. ID evento inaccurati possono causare una deduplicazione errata della conversione, con conseguente impatto sul report sulle conversioni e sulle prestazioni della campagna.
Puoi consultare la seguente documentazione per gli sviluppatori per implementare la configurazione della deduplicazione:
Ecco un esempio di come registrare un evento personalizzato. Per farlo, passa il nome dell'evento come AppEvents.Name nell'SDK per iOS:
AppEvents.shared.logEvent(.achievedLevel, parameters: [AppEvents.ParameterName(rawValue: "event_id"): "123"])
Per gli eventi di installazione dell'app, esiste già un meccanismo di deduplicazione che assicura che solo un'installazione sia attribuita nell'ultima finestra di 90 giorni. Manteniamo il primo evento e ignoriamo quelli successivi, indipendentemente dall'origine dell'azione da cui provengono. Non è necessario implementare la deduplicazione per gli eventi nell'app relativi agli eventi di installazione.
d. Invio di eventi
Per inviare nuovi eventi, fai una richiesta POST
all'API Conversions da questo percorso: https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}
. Quando pubblichi su questo segmento, Meta crea nuovi eventi del server dell'app. Per maggiori dettagli, consulta il seguente documento per gli sviluppatori.
Di seguito è riportata una panoramica di come si inseriscono i parametri nello schema complessivo del payload:
{ "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" ] } } ] }
Puoi usare lo Strumento di assistenza per il payload per generare dati del payload:
app
come origine dell'azioneUsa lo strumento Testa gli eventi in Gestione eventi per i test.