Panoramica MACT
Eventi di conversione
Riferimenti API
Evento di conversione
POST conversion_event
Registra un evento di conversione per la misurazione su dispositivo mobile. La risposta indicherà l’attribuzione a X o a X Audience Platform (TAP). Questo è correlato all’endpoint GET conversion_attribution. Nella risposta verrà indicata un’attribuzione a X, a TAP oppure nessuna attribuzione. Il nodotwitter_attribution
sarà sempre presente e avrà valore null
quando non è presente attribuzione a X (vedi l’esempio di risposta qui sotto). Se viene indicata un’attribuzione TAP, sarà presente un nodo tpn_attribution
compilato di conseguenza. Consulta la panoramica di TAP per ulteriori informazioni.
Sono disponibili diversi parametri facoltativi per impostare i metadati associati a ciascun evento di conversione. Questi metadati non influiscono sui calcoli di attribuzione.
URL della risorsa
https://ads-api.x.com/12/conversion_event
Parametri
Nome | Descrizione |
---|---|
app_id required | L’identificatore univoco presso il relativo app store. Type: int, string Example: 333903271 , com.vine.android |
conversion_time required | L’orario dell’evento di conversione in formato timestamp ISO-8601, con millisecondi. Type: string Example: 2014-05-22T02:38:28.103Z |
conversion_type required | Il tipo di evento di conversione. Type: enum Possible values: PURCHASE , SIGN_UP , INSTALL , RE_ENGAGE , UPDATE , TUTORIAL_COMPLETE , RESERVATION , ADD_TO_CART , ADD_TO_WISHLIST , LOGIN , CHECKOUT_INITIATED , SEARCH , LEVEL_ACHIEVED , ACHIEVEMENT_UNLOCKED , CONTENT_VIEW , SHARE , INVITE , ADDED_PAYMENT_INFO , SPENT_CREDITS , RATED |
hashed_device_id required | IDFA o AdID con hash HMAC_SHA-256. Type: string Example: ABCD1234XYZ |
os_type required | Il tipo di OS per l’app. Type: enum Possible values: IOS , ANDROID |
click_window optional | La finestra di clic per questo evento (in giorni). Type: int Nota: click_window deve essere maggiore o uguale a view_through_windowDefault: 14 Possible values: 1 , 7 , 14 , 30 |
device_ip_address optional | Indirizzo IPv4 o IPv6 del dispositivo al momento dell’evento di conversione. Type: string Example: 192.133.78.1 |
level optional | Un livello associato a questo evento. Type: int Example: 2 |
non_twitter_engagement_time optional | L’orario dell’ultima interazione non su X precedente alla conversione. Type: string Example: 2014-05-22T02:38:28.103Z |
non_twitter_engagement_type optional | Il tipo di interazione non su X precedente all’evento di conversione. Type: enum Possible values: CLICK , VIEW |
number_items optional | Numero di elementi associati a questo evento. Type: int Example: 2 |
price_currency optional | Deve essere un codice ISO 4217 che indica la valuta associata a questo evento. Type: String Examples: EUR , USD , JPY |
price_micro optional | Un importo di prezzo associato a questo evento in micro-unità. Type: int Example: 123450000 |
user_payment_info optional | Valore booleano che indica se le informazioni di pagamento dell’utente sono memorizzate nell’app associata a questo evento. Type: bool Possible values: true o false |
view_through_window optional | La finestra di visualizzazione per questo evento (in giorni). Nota: click_window deve essere maggiore o uguale a view_through_window.Type: int Default: 1 Possible values: 0 , 1 , 7 , 14 , 30 |
Esempio di richiesta
https://ads-api.x.com/12/conversion_event?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=1
Esempio di risposta
GET accounts/:account_id/app_event_tags
Recupera i dettagli di alcuni o di tutti i tag degli eventi dell’App associati all’account corrente. Questi tag definiscono le finestre di conversione configurate per ciascun tipo di conversione nel tracciamento delle conversioni delle app mobili.URL risorsa
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’Advertiser API, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
app_event_tag_ids opzionale | Limita la risposta ai soli tag di evento dell’app desiderati specificando un elenco di identificatori separati da virgola. È possibile fornire fino a 200 ID. Type: string Example: jhp |
count opzionale | Specifica il numero di record da recuperare per ciascuna richiesta. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor opzionale | Specifica un cursore per ottenere la pagina successiva dei risultati. Vedere Pagination per maggiori informazioni. Type: string Example: 8x7v00oow |
sort_by opzionale | Ordina in base a un attributo supportato in ordine crescente o decrescente. Vedere Sorting per maggiori informazioni. Type: string Example: created_at-asc |
with_deleted opzionale | Includi i risultati eliminati nella richiesta. Type: boolean Default: false Possible values: true , false |
with_total_count opzionale | Includi l’attributo di risposta total_count .Nota: Questo parametro e cursor sono mutuamente esclusivi.Nota: Le richieste che includono total_count avranno limiti di velocità inferiori, attualmente pari a 200 per 15 minuti.Type: boolean Default: false Possible values: true , false |
Esempio di richiesta
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp
Esempio di risposta
GET accounts/:account_id/app_event_tags/:app_event_tag_id
Recupera uno specifico tag di evento App associato all’account corrente. Questi elementi definiscono le finestre di conversione configurate per ciascun tipo di conversione nel monitoraggio delle conversioni delle app mobili.URL risorsa
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account a leva. Compare nel percorso della risorsa ed è in genere un parametro obbligatorio per tutte le richieste dell’API Advertiser, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Esempio: 18ce54d4x5t |
app_event_tag_id obbligatorio | Un riferimento al tag evento dell’App con cui operi nella richiesta. Type: string Esempio: jhp |
with_deleted opzionale | Includi i risultati eliminati nella richiesta. Type: boolean Predefinito: false Valori possibili: true , false |
Esempio di richiesta
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Esempio di risposta
POST accounts/:account_id/app_event_tags
Crea un nuovo tag di evento dell’App associato all’account corrente.URL risorsa
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è in genere un parametro obbligatorio per tutte le richieste dell’Advertiser API, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
app_store_identifier obbligatorio | L’identificatore dell’app store. Type: string Example: com.twitter.android |
conversion_type obbligatorio | Il tipo di evento di conversione. Type: enum Possible values: ACHIEVEMENT_UNLOCKED , ADDED_PAYMENT_INFO , ADD_TO_CART , ADD_TO_WISHLIST , CHECKOUT_INITIATED , CONTENT_VIEW , INSTALL , INVITE , LEVEL_ACHIEVED , LOGIN , PURCHASE , RATED , RESERVATION , RE_ENGAGE , SEARCH , SHARE , SIGN_UP , SPENT_CREDITS , TUTORIAL_COMPLETE , UPDATE |
os_type obbligatorio | Il tipo di sistema operativo dell’app. Type: enum Possible values: IOS , ANDROID |
provider_app_event_id obbligatorio | L’id del tag di conversione sul sito del provider. Type: string Example: provider_tag_j5394 |
provider_app_event_name obbligatorio | Il nome del tag di conversione sul sito del provider. Type: string Example: provider_name_a4382 |
deep_link_scheme opzionale | Specifica l’URI di deep link per l’app associata a questo tag. Type: string Example: twitter:// |
post_engagement_attribution_window opzionale | La finestra di attribuzione post-engagement per questi eventi. Type: int Default: 30 Possible values: 1 , 7 , 14 , 30 |
post_view_attribution_window opzionale | La finestra di attribuzione post-view per questi eventi. Type: int Default: 1 Possible values: 0 , 1 , 7 , 14 , 30 |
retargeting_enabled opzionale | Specifica se il retargeting deve essere abilitato per questo tag di evento dell’app. Type: boolean Default: true Possible values: true , false |
Esempio di richiesta
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_store_identifier=com.twitter.android&os_type=ANDROID&conversion_type=PURCHASE&provider_app_event_id=abc123&provider_app_event_name=test-tag
Esempio di risposta
DELETE accounts/:account_id/app_event_tags/:id
Elimina il tag evento dell’App specificato che appartiene all’account corrente.URL della risorsa
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’API Ads, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Esempio: 18ce54d4x5t |
id obbligatorio | Un riferimento al tag di evento dell’App utilizzato nella richiesta. Type: string Esempio: jhp |
Esempio di richiesta
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Esempio di risposta
Liste di App
GET accounts/:account_id/app_lists
Recupera i dettagli di alcune o tutte le app lists associate all’account corrente.URL risorsa
https://ads-api.x.com/12/accounts/:account_id/app_lists
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | Identificatore dell’account sfruttato. Compare nel percorso della risorsa ed è generalmente un parametro richiesto per tutte le richieste dell’API Advertiser, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
app_list_ids opzionale | Limita la risposta alle sole liste di app desiderate specificando un elenco di identificatori separati da virgole. È possibile fornire fino a 200 ID. Type: string Example: wm7x |
count opzionale | Specifica il numero di record da recuperare per ciascuna richiesta. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor opzionale | Specifica un cursore per ottenere la pagina successiva dei risultati. Consulta Pagination per maggiori informazioni. Type: string Example: 8x7v00oow |
sort_by opzionale | Ordina in base a un attributo supportato in ordine crescente o decrescente. Consulta Sorting per maggiori informazioni. Type: string Example: created_at-asc |
with_deleted opzionale | Includi i risultati eliminati nella richiesta. Type: boolean Default: false Possible values: true , false |
with_total_count opzionale | Includi l’attributo di risposta total_count .Nota: Questo parametro e cursor si escludono a vicenda.Nota: Le richieste che includono total_count avranno limiti di velocità inferiori, attualmente pari a 200 ogni 15 minuti.Type: boolean Default: false Possible values: true , false |
Esempio di richiesta
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x
Esempio di risposta
GET accounts/:account_id/app_lists/:app_list_id
Recupera una specifica app list associata all’account corrente.URL risorsa
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’API per gli inserzionisti, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Esempio: 18ce54d4x5t |
app_list_id obbligatorio | Un riferimento alla App List con cui operi nella richiesta. Type: string Esempio: 28ukf |
with_deleted opzionale | Includi i risultati eliminati nella richiesta. Type: boolean Predefinito: false Valori possibili: true , false |
Esempio di richiesta
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Esempio di risposta
POST accounts/:account_id/app_lists
Crea unapp_list
associato all’account corrente.
Al momento è previsto un limite di 100 oggetti app_list
per account_id
e di 500 app per app_list
.
URL della risorsa
https://ads-api.x.com/12/accounts/:account_id/app_lists
Parametri
Nome | Descrizione |
---|---|
account_id required | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’Advertiser API, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
app_store_identifiers required | Gli identificatori degli app store da includere in app_list .Type: string Example: com.twitter.android |
name required | Il nome che assegnerai a app_list .Type: string Example: My First App List |
Esempio di richiesta
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android
Esempio di risposta
DELETE accounts/:account_id/app_lists/:app_list_id
Elimina la app list specificata associata all’account corrente.URL della risorsa
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’API per gli inserzionisti, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Tipo: string Esempio: 18ce54d4x5t |
app_list_id obbligatorio | Un riferimento alla lista di app con cui operi nella richiesta. Tipo: string Esempio: 28ukf |
Esempio di richiesta
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Esempio di risposta
Configurazioni del provider di eventi dell’App
GET accounts/:account_id/app_event_provider_configurations¶
Recupera i dettagli di alcune o tutte le configurazioni dei provider di eventi dell’App (configurazione di base per il Mobile Application Conversion Tracking) associate all’account corrente.URL risorsa
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | Identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è in genere un parametro obbligatorio per tutte le richieste dell’Advertiser API, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
count opzionale | Specifica il numero di record da recuperare per ciascuna richiesta. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor opzionale | Specifica un cursore per ottenere la pagina successiva dei risultati. Vedi Pagination per maggiori informazioni. Type: string Example: 8x7v00oow |
ids opzionale | Limita la risposta alle sole configurazioni desiderate specificando un elenco di identificatori separati da virgole. È possibile fornire fino a 200 ID. Type: string Example: 25n |
sort_by opzionale | Ordina in base a un attributo supportato, in ordine crescente o decrescente. Vedi Sorting per maggiori informazioni. Type: string Example: created_at-asc |
with_deleted opzionale | Includi i risultati eliminati nella richiesta. Type: boolean Default: false Possible values: true , false |
with_total_count opzionale | Includi l’attributo di risposta total_count .Nota: Questo parametro e cursor sono mutuamente esclusivi.Nota: Le richieste che includono total_count avranno limiti di velocità inferiori, attualmente fissati a 200 per 15 minuti.Type: boolean Default: false Possible values: true , false |
Esempio di richiesta
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n
Esempio di risposta
GET accounts/:account_id/app_event_provider_configurations/:id
Recupera un id specifico delle configurazioni del provider di eventi (configurazione di base per il Mobile Application Conversion Tracking) associate all’account corrente.URL della risorsa
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account con leva. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’Advertiser API, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
id obbligatorio | Un riferimento alla configurazione del provider di eventi dell’App utilizzata nella richiesta. Type: string Example: 25n |
with_deleted opzionale | Includi anche i risultati eliminati nella richiesta. Type: boolean Default: false Possible values: true , false |
Esempio di richiesta
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n
Esempio di risposta
POST accounts/:account_id/app_event_provider_configurations
Crea una nuova configurazione del provider degli eventi dell’App associata all’account corrente. A un determinato account pubblicitario può essere associato un solo provider MACT.URL risorsa
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | Identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è in genere un parametro obbligatorio per tutte le richieste dell’API Advertiser, escluso GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
provider_advertiser_id obbligatorio | Identificatore dell’inserzionista dal sito del provider Type: string Example: client1 |
Esempio di richiesta
POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1
Esempio di risposta
DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]
Elimina la configurazione del provider di eventi dell’App specificata appartenente all’account corrente.URL della risorsa
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parametri
Nome | Descrizione |
---|---|
account_id obbligatorio | L’identificatore dell’account utilizzato. Compare nel percorso della risorsa ed è generalmente un parametro obbligatorio per tutte le richieste dell’API per Inserzionisti, ad eccezione di GET accounts. L’account specificato deve essere associato all’utente autenticato. Type: string Example: 18ce54d4x5t |
id obbligatorio | Un riferimento alla configurazione del provider di eventi dell’App utilizzata nella richiesta. Type: string Example: e5g |
Esempio di richiesta
DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g
Esempio di risposta
Attribuzione delle conversioni
GET conversion_attribution
Interroga X per verificare l’attribuzione delle conversioni senza registrare un evento di conversione. La risposta indicherà l’attribuzione su X. Questo è correlato all’endpoint POST conversion_event. Nella risposta potrà essere indicata l’attribuzione di X, di TAP oppure nessuna attribuzione. Il nodotwitter_attribution
sarà sempre presente e avrà il valore null
quando non c’è attribuzione su X, altrimenti sarà valorizzato come mostrato nell’esempio di risposta riportato di seguito. Se viene indicata un’attribuzione TAP, sarà presente un nodo tpn_attribution
valorizzato di conseguenza. Consulta la panoramica di TAP per maggiori informazioni.
URL della risorsa
https://ads-api.x.com/12/conversion_attribution
Parametri
Nome | Descrizione |
---|---|
app_id obbligatorio | L’identificatore univoco presso il relativo app store. Type: int, string Esempio: 333903271 , com.vine.android |
conversion_time obbligatorio | L’ora dell’evento di conversione in formato timestamp ISO-8601, con millisecondi. Type: string Esempio: 2014-05-22T02:38:28.103Z |
conversion_type obbligatorio | Il tipo di evento di conversione. Type: enum Valori possibili: ACHIEVEMENT_UNLOCKED , ADDED_PAYMENT_INFO , ADD_TO_CART , ADD_TO_WISHLIST , CHECKOUT_INITIATED , CONTENT_VIEW , INSTALL , INVITE , LEVEL_ACHIEVED , LOGIN , PURCHASE , RATED , RESERVATION , RE_ENGAGE , SEARCH , SHARE , SIGN_UP , SPENT_CREDITS , TUTORIAL_COMPLETE , UPDATE |
hashed_device_id obbligatorio | L’IDFA o l’AdID con hash HMAC_SHA-256. Type: string Esempio: ABCD1234XYZ |
os_type obbligatorio | Il tipo di sistema operativo per l’App. Type: enum Valori possibili: IOS , ANDROID |
click_window facoltativo | La finestra di click per questo evento (in giorni). Type: int Predefinito: 14 Valori possibili: 1 , 7 , 14 , 30 |
extra_device_ids facoltativo | L’SHA256 dell’SHA1 dell’id dispositivo passato in hashed_device_id , più eventuali ulteriori id dispositivo con hash.Type: string Esempio: ABCD1234XYZ , DCBA4321XYZ |
non_twitter_engagement_time facoltativo | L’ora dell’ultima interazione non su X precedente alla conversione. Type: string Esempio: 2014-05-22T02:38:28.103Z |
non_twitter_engagement_type facoltativo | Il tipo di interazione non su X precedente all’evento di conversione. Type: enum Valori possibili: CLICK , VIEW |
view_through_window facoltativo | La finestra di view-through per questo evento (in giorni). Type: int Predefinito: 1 Valori possibili: 0 , 1 , 7 , 14 , 30 |
Esempio di richiesta
GET https://ads-api.x.com/12/conversion_attribution?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=0