Conversions sur mobile

Aperçu de MACT

La mesure de la promotion d’applications mobiles sur X permet aux annonceurs de suivre les performances des campagnes publicitaires sur X conçues pour générer des installations ou d’autres conversions in‑app. Un partenaire de mesure mobile X permet à un annonceur de définir les conversions qu’il souhaite suivre à partir des applications qu’il promeut sur X. Une fois que l’annonceur a défini le type d’événements et les fenêtres temporelles qu’il souhaite suivre, le partenaire de mesure mobile enverra tous ces événements à X et recevra immédiatement des données d’attribution indiquant la campagne et la création publicitaire avec laquelle l’utilisateur a interagi et qui a conduit à la conversion.

Événements de conversion

Pour déclarer un événement de conversion à X et obtenir des données d’attribution, le partenaire doit envoyer l’id de l’App mobile, le type et l’horodatage de la conversion, ainsi qu’une valeur hachée de l’id publicitaire/appareil. La fourniture de ces données enregistrera l’événement de conversion sur la plateforme de X et retournera l’attribution le cas échéant. En outre, l’annonceur peut choisir de fournir des métadonnées supplémentaires sur l’événement de conversion, telles que la valeur d’un achat, l’id d’un produit ou la méthode d’inscription.

Référence API

Événement de conversion

POST conversion_event

Enregistre un événement de conversion de mesure mobile. La réponse indiquera une attribution X ou X Audience Platform (TAP). Cela concerne l’endpoint GET conversion_attribution. Dans la réponse, une attribution X, TAP ou aucune attribution sera indiquée. Le nœud twitter_attribution sera toujours présent et aura la valeur null lorsqu’il n’y a pas d’attribution X (voir l’exemple de réponse ci-dessous). Si une attribution TAP est indiquée, un nœud tpn_attribution sera présent et renseigné en conséquence. Veuillez vous référer à la présentation de TAP pour plus d’informations. Plusieurs paramètres facultatifs sont disponibles pour définir les metadata associées à chaque événement de conversion. Ces metadata n’ont aucun effet sur les calculs d’attribution.

URL de ressource

https://ads-api.x.com/12/conversion_event

Paramètres

Nom	Description
app_id obligatoire	Identifiant unique correspondant au store d’apps. Type : int, string Exemple : `333903271`, `com.vine.android`
conversion_time obligatoire	Horodatage de l’événement de conversion au format ISO‑8601, avec millisecondes. Type : string Exemple : `2014-05-22T02:38:28.103Z`
conversion_type obligatoire	Type d’événement de conversion. Type : enum Valeurs possibles : `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 obligatoire	IDFA ou AdID haché avec HMAC_SHA‑256. Type : string Exemple : `ABCD1234XYZ`
os_type obligatoire	Type de système d’exploitation de l’App. Type : enum Valeurs possibles : `IOS`, `ANDROID`
click_window facultatif	Fenêtre de clic pour cet événement (en jours). Type : int Remarque : `click_window` doit être supérieur ou égal à view_through_window Par défaut : `14` Valeurs possibles : `1`, `7`, `14`, `30`
device_ip_address facultatif	Adresse IPv4 ou IPv6 de l’appareil au moment de l’événement de conversion. Type : string Exemple : `192.133.78.1`
level facultatif	Niveau associé à cet événement. Type : int Exemple : `2`
non_twitter_engagement_time facultatif	Horodatage de la dernière interaction hors X avant la conversion. Type : string Exemple : `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type facultatif	Type d’interaction hors X avant l’événement de conversion. Type : enum Valeurs possibles : `CLICK`, `VIEW`
number_items facultatif	Nombre d’éléments associés à cet événement. Type : int Exemple : `2`
price_currency facultatif	Code ISO 4217 indiquant la devise associée à cet événement. Type : string Exemples : `EUR`, `USD`, `JPY`
price_micro facultatif	Montant associé à cet événement, en micro‑unités. Type : int Exemple : `123450000`
user_payment_info facultatif	Valeur booléenne indiquant si les informations de paiement de l’utilisateur sont stockées dans l’App associée à cet événement. Type : bool Valeurs possibles : `true` ou `false`
view_through_window facultatif	Fenêtre de post‑impression pour cet événement (en jours). Remarque : `click_window` doit être supérieur ou égal à view_through_window. Type : int Par défaut : `1` Valeurs possibles : `0`, `1`, `7`, `14`, `30`

Exemple de requête

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

Exemple de réponse

    {
      "data": {
        "conversion_value_micro": 0,
        "view_through_window": 1,
        "tpn_attribution": null,
        "conversion_time": "2017-01-21T01:14:00.602Z",
        "click_window": 30,
        "limit_ad_tracking": false,
        "event_metadata": null,
        "non_twitter_engagement_type": null,
        "conversion_type": "INSTALL",
        "partner_client_id": "com.appname contact id",
        "app_id": "com.appname",
        "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
        "twitter_attribution": {
          "country_code": "US",
          "engagement_time": "2017-01-21T01:13:00.602Z",
          "engagement_type": "CLICK",
          "attribution_type": "PROMOTED",
          "promoted_properties": {
            "campaign_id": "4ns44",
            "line_item_id": "3x44d",
            "publisher_app_id": "333903271"
            "account_id":"18ce11e3egb",
            "line_item_objective": "APP_INSTALLS",
            "campaign_name": null
          },
          "tweet_id": "11434635565377600"
        },
        "os_type": "ANDROID",
        "non_twitter_engagement_time": null
      },
      "request": {
        "params": {
          "version_number": "1",
          "app_id": "com.appname",
          "conversion_type": "INSTALL",
          "os_type": "ANDROID",
          "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
          "conversion_time": "2017-01-21T01:14:00.602Z",
          "click_window": "30",
          "view_through_window": "1",
          "limit_ad_tracking": "false"
        }
      }
    }

Balises d’événement d’App

GET accounts/:account_id/app_event_tags

Récupère les détails de certains ou de l’ensemble des balises d’événement d’App associées au compte actuel. Ces balises définissent les fenêtres de conversion configurées pour chaque type de conversion dans le suivi des conversions d’App mobile.

URL de la ressource

https://ads-api.x.com/12/accounts/:account_id/app_event_tags

Paramètres

Nom	Description
account_id requis	L’identifiant du compte exploité. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_event_tag_ids optionnel	Limitez la réponse aux balises d’événements d’App souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 id peuvent être fournis. Type : string Exemple : `jhp`
count optionnel	Indique le nombre d’enregistrements à tenter de récupérer par requête distincte. Type : int Valeur par défaut : `200` Min, Max : `1`, `1000`
cursor optionnel	Spécifie un curseur pour obtenir la page suivante de résultats. Consultez Pagination pour plus d’informations. Type : string Exemple : `8x7v00oow`
sort_by optionnel	Trie par attribut pris en charge, par ordre croissant ou décroissant. Consultez Sorting pour plus d’informations. Type : string Exemple : `created_at-asc`
with_deleted optionnel	Inclure les résultats supprimés dans votre requête. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`
with_total_count optionnel	Inclure l’attribut de réponse `total_count`. Remarque : Ce paramètre et `cursor` sont mutuellement exclusifs. Remarque : Les requêtes qui incluent `total_count` sont soumises à des limites de taux plus basses, actuellement fixées à 200 par tranche de 15 minutes. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp

Exemple de réponse

    {
      "request": {
        "params": {
          "app_event_tag_ids": [
            "jhp"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "provider_app_event_name": null,
          "app_store_identifier": "co.vine.android",
          "post_view_attribution_window": 1,
          "deep_link_scheme": "vine://",
          "id": "jhp",
          "retargeting_enabled": true,
          "conversion_type": "INSTALL",
          "created_at": "2016-12-08T07:49:58Z",
          "post_engagement_attribution_window": 14,
          "provider_app_event_id": null,
          "last_tracked_at": "2021-05-22T17:00:04Z",
          "status": "TRACKING",
          "updated_at": "2016-12-08T23:07:54Z",
          "os_type": "ANDROID",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/app_event_tags/:app_event_tag_id

Récupère une balise d’événement d’App spécifique associée au compte actuel. Ce sont elles qui définissent les fenêtres de conversion configurées pour chaque type de conversion dans le suivi des conversions des Apps mobiles.

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id

Paramètres

Nom	Description
account_id requis	L’identifiant du compte concerné. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_event_tag_id requis	Référence à la balise d’événement d’App utilisée dans la requête. Type : string Exemple : `jhp`
with_deleted optionnel	Inclure les résultats supprimés dans la requête. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp

Exemple de réponse

    {
      "request": {
        "params": {
          "app_event_tag_id": "jhp",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "provider_app_event_name": null,
        "app_store_identifier": "co.vine.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "vine://",
        "id": "jhp",
        "retargeting_enabled": true,
        "conversion_type": "INSTALL",
        "created_at": "2016-12-08T07:49:58Z",
        "post_engagement_attribution_window": 14,
        "provider_app_event_id": null,
        "last_tracked_at": "2021-05-22T17:00:04Z",
        "status": "TRACKING",
        "updated_at": "2016-12-08T23:07:54Z",
        "os_type": "ANDROID",
        "deleted": false
      }
    }

POST accounts/:account_id/app_event_tags

Créer une nouvelle balise d’événement d’App associée au compte en cours.

URL de la ressource

https://ads-api.x.com/12/accounts/:account_id/app_event_tags

Paramètres

Nom	Description
account_id requis	L’identifiant du compte exploité. Apparaît dans le chemin de la ressource et constitue généralement un paramètre obligatoire pour toutes les requêtes de l’API Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_store_identifier requis	L’identifiant de l’App Store. Type : string Exemple : `com.twitter.android`
conversion_type requis	Le type d’événement de conversion. Type : enum Valeurs possibles : `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 requis	Le type d’OS pour l’App. Type : enum Valeurs possibles : `IOS`, `ANDROID`
provider_app_event_id requis	L’id de la balise de conversion sur le site du fournisseur. Type : string Exemple : `provider_tag_j5394`
provider_app_event_name requis	Le nom de la balise de conversion sur le site du fournisseur. Type : string Exemple : `provider_name_a4382`
deep_link_scheme optionnel	Indiquez l’URI de lien profond pour l’App associée à cette balise. Type : string Exemple : `twitter://`
post_engagement_attribution_window optionnel	La fenêtre d’attribution post‑engagement pour ces événements. Type : int Par défaut : 30 Valeurs possibles : `1`, `7`, `14`, `30`
post_view_attribution_window optionnel	La fenêtre d’attribution post‑vue pour ces événements. Type : int Par défaut : 1 Valeurs possibles : `0`, `1`, `7`, `14`, `30`
retargeting_enabled optionnel	Indique si le reciblage doit être activé pour cette balise d’événement d’App. Type : boolean Par défaut : true Valeurs possibles : `true`, `false`

Exemple de requête

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

Exemple de réponse

    {
      "data": {
        "provider_app_event_name": "balise-test",
        "app_store_identifier": "com.twitter.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "https://",
        "id": "3p3t",
        "retargeting_enabled": true,
        "conversion_type": "ACHAT",
        "created_at": "2017-09-06T06:58:22Z",
        "post_engagement_attribution_window": 30,
        "provider_app_event_id": "abc123",
        "updated_at": "2017-09-06T06:58:22Z",
        "os_type": "ANDROID",
        "deleted": false
      },
      "request": {
        "params": {
          "provider_app_event_name": "balise-test",
          "app_store_identifier": "com.twitter.android",
          "account_id": "18ce54d4x5t",
          "conversion_type": "ACHAT",
          "provider_app_event_id": "abc123",
          "os_type": "ANDROID"
        }
      }
    }

DELETE accounts/:account_id/app_event_tags/:id

Supprime la balise d’événement d’App spécifiée appartenant au compte en cours.

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id

Paramètres

Nom	Description
account_id requis	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Ads, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
id requis	Référence à la balise d’événement d’App utilisée dans la requête. Type : string Exemple : `jhp`

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp

Exemple de réponse

    {
      "data": {
        "provider_app_event_name": null,
        "app_store_identifier": "co.vine.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "vine://",
        "id": "jhp",
        "retargeting_enabled": true,
        "conversion_type": "INSTALL",
        "created_at": "2016-12-08T07:49:58Z",
        "post_engagement_attribution_window": 14,
        "provider_app_event_id": null,
        "last_tracked_at": "2021-05-22T17:00:04Z",
        "status": "TRACKING",
        "updated_at": "2017-08-30T05:44:57Z",
        "os_type": "ANDROID",
        "deleted": true
      },
      "request": {
        "params": {
          "id": "jhp",
          "account_id": "5gvk9h"
        }
      }
    }

Listes d’App

GET accounts/:account_id/app_lists

Récupère les détails de certaines ou de toutes les listes d’App associées au compte actuel.

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/app_lists

Paramètres

Nom	Description
account_id requis	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Ads, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_list_ids optionnel	Limite la réponse aux App Lists souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 id peuvent être fournis. Type : string Exemple : `wm7x`
count optionnel	Spécifie le nombre d’enregistrements à tenter de récupérer par requête distincte. Type : int Valeur par défaut : `200` Min, Max : `1`, `1000`
cursor optionnel	Spécifie un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type : string Exemple : `8x7v00oow`
sort_by optionnel	Trie selon un attribut pris en charge, par ordre croissant ou décroissant. Voir Sorting pour plus d’informations. Type : string Exemple : `created_at-asc`
with_deleted optionnel	Inclure les résultats supprimés dans la requête. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`
with_total_count optionnel	Inclure l’attribut de réponse `total_count`. Remarque : Ce paramètre et `cursor` sont mutuellement exclusifs. Remarque : Les requêtes incluant `total_count` sont soumises à des limites de taux plus basses, actuellement fixées à 200 par tranche de 15 minutes. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x

Exemple de réponse

    {
      "request": {
        "params": {
          "app_list_ids": [
            "wm7x"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "id": "wm7x",
          "name": "foo @ 14026528192426843"
        }
      ]
    }

GET accounts/:account_id/app_lists/:app_list_id

Récupère une App List spécifique associée au compte en cours.

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API des annonceurs, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple : `18ce54d4x5t`
app_list_id obligatoire	Référence à la App List utilisée dans la requête. Type: string Exemple : `28ukf`
with_deleted optionnel	Inclure les résultats supprimés dans la requête. Type: boolean Par défaut : `false` Valeurs possibles : `true`, `false`

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf

Exemple de réponse

    {
      "data": {
        "name": "twitter @ 262689209670784",
        "id": "28ukf",
        "created_at": "2017-08-17T17:07:42Z",
        "updated_at": "2017-08-17T17:07:42Z",
        "deleted": false,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_list_id": "28ukf",
          "account_id": "18ce54d4x5t"
        }
      }
    }

POST accounts/:account_id/app_lists

Créer une entité app_list associée au compte actuel. Il existe actuellement une limite de 100 objets app_list par account_id et de 500 apps par app_list.

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/app_lists

Paramètres

Nom	Description
account_id requis	L’identifiant du compte exploité. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Ads, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_store_identifiers requis	Les identifiants de l’App Store à inclure dans `app_list` Type : string Exemple : `com.twitter.android`
name requis	Le nom que vous attribuerez à `app_list` Type : string Exemple : `My First App List`

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android

Exemple de réponse

    {
      "data": {
        "name": "liste d’apps",
        "id": "2a4um",
        "created_at": "2017-09-06T07:17:26Z",
        "updated_at": "2017-09-06T07:17:26Z",
        "deleted": false,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_store_identifiers": [
            "com.twitter.android"
          ],
          "name": "liste d’apps",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/app_lists/:app_list_id

Supprime la liste d’App spécifiée associée au compte en cours.

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Ads des annonceurs, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_list_id obligatoire	Référence à la App List utilisée dans la requête. Type : string Exemple : `28ukf`

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf

Exemple de réponse

    {
      "data": {
        "name": "twitter @ 262689209670784",
        "id": "28ukf",
        "created_at": "2017-08-17T17:07:42Z",
        "updated_at": "2017-09-12T22:20:33Z",
        "deleted": true,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_list_id": "28ukf",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Configurations du fournisseur d’événements App

❯

GET accounts/:account_id/app_event_provider_configurations¶

Récupère les détails de certaines ou de toutes les configurations de fournisseur d’événements d’App (configuration de base pour le suivi des conversions des applications mobiles) associées au compte actuel.

URL de ressource

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations

Paramètres

Nom	Description
account_id requis	Identifiant du compte exploité. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
count optionnel	Indique le nombre d’enregistrements à tenter de récupérer par requête distincte. Type : int Valeur par défaut : `200` Min, Max : `1`, `1000`
cursor optionnel	Indique un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type : string Exemple : `8x7v00oow`
ids optionnel	Restreint la réponse aux configurations souhaitées en fournissant une liste d’identifiants séparés par des virgules. Jusqu’à 200 id peuvent être fournis. Type : string Exemple : `25n`
sort_by optionnel	Trie selon un attribut pris en charge, par ordre croissant ou décroissant. Voir Sorting pour plus d’informations. Type : string Exemple : `created_at-asc`
with_deleted optionnel	Inclure les résultats supprimés dans la requête. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`
with_total_count optionnel	Inclure l’attribut de réponse `total_count`. Remarque : Ce paramètre et `cursor` sont mutuellement exclusifs. Remarque : Les requêtes incluant `total_count` sont soumises à des limites de taux plus faibles, actuellement fixées à 200 par 15 minutes. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`

Exemple de requête

GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n

Exemple de réponse

    {
      "data": [
        {
          "provider_name": "Answers avec la technologie Fabric",
          "id": "25n",
          "provider_advertiser_id": "54ac2766f0de9e1f7a00001a",
          "created_at": "2016-12-08T07:49:58Z",
          "provider_advertiser_identifier": "54ac2766f0de9e1f7a00001a",
          "updated_at": "2017-05-12T21:37:15Z",
          "deleted": false
        }
      ],
      "next_cursor": null,
      "request": {
        "params": {
          "ids": [
            "25n"
          ],
          "account_id": "18ce54d4x5t"
        }
      }
    }

GET accounts/:account_id/app_event_provider_configurations/:id

Récupère l’id spécifique d’une configuration de fournisseur d’événements (configuration centrale pour le suivi des conversions d’applications mobiles) associée au compte actuel.

URL de ressource

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id

Paramètres

Nom	Description
account_id requis	L’identifiant du compte exploité. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Ads pour les annonceurs, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
id requis	Une référence à la configuration du fournisseur d’événements d’App utilisée dans la requête. Type : string Exemple : `25n`
with_deleted optionnel	Inclure les résultats supprimés dans la réponse. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`

Exemple de requête

GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n

Exemple de réponse

    {
      "data_type": "app_event_provider_configuration",
      "data": {
        "provider_name": "API McTestface",
        "id": "25n",
        "provider_advertiser_id": "123",
        "created_at": "2017-03-24T22:24:56Z",
        "provider_advertiser_identifier": "123",
        "updated_at": "2017-03-24T22:24:56Z",
        "deleted": false
      },
      "request": {
        "params": {
          "id": "25n",
          "account_id": "18ce54d4x5t"
        }
      }
    }

POST accounts/:account_id/app_event_provider_configurations

Créer une nouvelle configuration de fournisseur d’événements d’App associée au compte actuel. Un seul fournisseur MACT peut être associé à un compte publicitaire donné.

URL de ressource

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte exploité. Figure dans le chemin de la ressource et constitue généralement un paramètre obligatoire pour toutes les requêtes de l’API Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
provider_advertiser_id obligatoire	L’identifiant de l’annonceur tel qu’il apparaît sur le site du fournisseur. Type : string Exemple : `client1`

Exemple de requête

POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1

Exemple de réponse

    {
      "data": {
        "provider_name": "InternalTestProvider",
        "id": "e5g",
        "provider_advertiser_id": "client1",
        "created_at": "2017-08-30T05:40:07Z",
        "provider_advertiser_identifier": "client1",
        "updated_at": "2017-09-06T06:39:03Z",
        "deleted": false
      },
      "request": {
        "params": {
          "provider_advertiser_id": "client1",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

Supprime la configuration du fournisseur d’événements d’App spécifiée pour le compte actuel.

URL de ressource

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id

Paramètres

Nom	Description
account_id requis	L’identifiant du compte utilisé. Il apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes de l’API Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple : `18ce54d4x5t`
id requis	Référence à la configuration du fournisseur d’événements d’App utilisée dans la requête. Type: string Exemple : `e5g`

Exemple de requête

DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g

Exemple de réponse

    {
      "data": {
        "provider_name": "InternalTestProvider",
        "id": "e5g",
        "provider_advertiser_id": "client1",
        "created_at": "2017-08-30T05:40:07Z",
        "provider_advertiser_identifier": "client1",
        "updated_at": "2017-08-30T05:40:26Z",
        "deleted": true
      },
      "request": {
        "params": {
          "id": "e5g",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Attribution des conversions

GET conversion_attribution

Interrogez X pour vérifier l’attribution de conversion sans consigner un événement de conversion. La réponse indiquera l’attribution par X. Cela concerne l’endpoint POST conversion_event. Dans la réponse, l’attribution revendiquée sera X, TAP ou aucune. Le nœud twitter_attribution sera toujours présent et aura la valeur null lorsqu’il n’y a pas d’attribution X, et sera renseigné comme dans l’exemple de réponse ci‑dessous. Si une attribution TAP est revendiquée, un nœud tpn_attribution sera présent et renseigné en conséquence. Veuillez consulter la présentation de TAP pour plus d’informations.

URL de ressource

https://ads-api.x.com/12/conversion_attribution

Paramètres

Name	Description
app_id required	L’identifiant unique auprès de l’app store correspondant. Type : int, string Exemple : `333903271`, `com.vine.android`
conversion_time required	L’heure de l’événement de conversion au format d’horodatage ISO-8601, avec millisecondes. Type : string Exemple : `2014-05-22T02:38:28.103Z`
conversion_type required	Le type d’événement de conversion. Type : enum Valeurs possibles : `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 required	L’IDFA ou l’AdID haché en HMAC_SHA-256. Type : string Exemple : `ABCD1234XYZ`
os_type required	Le type de système d’exploitation de l’App. Type : enum Valeurs possibles : `IOS`, `ANDROID`
click_window optional	La fenêtre de clic pour cet événement, en jours. Type : int Valeur par défaut : `14` Valeurs possibles : `1`, `7`, `14`, `30`
extra_device_ids optional	Un SHA256 du SHA1 de l’identifiant d’appareil transmis dans `hashed_device_id`, plus tout identifiant d’appareil supplémentaire haché. Type : string Exemple : `ABCD1234XYZ`, `DCBA4321XYZ`
non_twitter_engagement_time optional	L’heure de la dernière interaction hors Twitter avant la conversion. Type : string Exemple : `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	Le type d’interaction hors Twitter avant l’événement de conversion. Type : enum Valeurs possibles : `CLICK`, `VIEW`
view_through_window optional	La fenêtre d’attribution via vue pour cet événement, en jours. Type : int Valeur par défaut : `1` Valeurs possibles : `0`, `1`, `7`, `14`, `30`

Exemple de requête

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

Exemple de réponse

    {
      data:{
        "app_id":"333903271",
        "os_type":"IOS",
        "hashed_device_id":"ABCD1234XYZ",
        "conversion_type":"INSTALL",
        "partner_client_id":"123abc",
        "conversion_time":"2013-04-16T07:00:00.123Z",
        "click_window":14,
        "view_through_window":0,
        "extra_device_ids":null,
        "twitter_attribution":{
          "engagement_type":"VIEW",
          "engagement_time":"2013-04-16T07:00:00.123Z",
          "country_code":"US",
          "tweet_id":"383034667764441088",
          "attribution_type":"PROMOTED",
          "promoted_properties":{
            "campaign_id”: “54a21",
            "campaign_name":"Vine_Contest",
            "line_item_id":"23ab2d4"
          }
        }
      },
      "data_type":"conversion_attribution",
      "request":{
        "params":{
          "app_id":"333903271",
          "os_type":"IOS",
          "hashed_device_id":"ABCD1234XYZ",
          "conversion_time":"2013-04-16T07:00:00.123Z",
          "conversion_type":"INSTALL",
          "click_window":14,
          "view_through_window":0
        }
      }
    }

X Ads API

Principes fondamentaux

Ressources

Mesure

​Aperçu de MACT

​Événements de conversion

​Référence API

​Événement de conversion

​POST conversion_event

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​Balises d’événement d’App

​GET accounts/:account_id/app_event_tags

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​GET accounts/:account_id/app_event_tags/:app_event_tag_id

URL de ressource

Paramètres

​Exemple de requête

​Exemple de réponse

​POST accounts/:account_id/app_event_tags

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​DELETE accounts/:account_id/app_event_tags/:id

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​Listes d’App

​GET accounts/:account_id/app_lists

URL de ressource

​Paramètres

Exemple de requête

Exemple de réponse

​GET accounts/:account_id/app_lists/:app_list_id

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​POST accounts/:account_id/app_lists

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​DELETE accounts/:account_id/app_lists/:app_list_id

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​Configurations du fournisseur d’événements App

​GET accounts/:account_id/app_event_provider_configurations¶

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​GET accounts/:account_id/app_event_provider_configurations/:id

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

POST accounts/:account_id/app_event_provider_configurations

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

URL de ressource

Paramètres

Exemple de requête

Exemple de réponse

​Attribution des conversions

​GET conversion_attribution

URL de ressource

Paramètres

Aperçu de MACT

Événements de conversion

Référence API

Événement de conversion

POST conversion_event

Balises d’événement d’App

GET accounts/:account_id/app_event_tags

GET accounts/:account_id/app_event_tags/:app_event_tag_id

Exemple de requête

Exemple de réponse

POST accounts/:account_id/app_event_tags

DELETE accounts/:account_id/app_event_tags/:id

Listes d’App

GET accounts/:account_id/app_lists

Paramètres

GET accounts/:account_id/app_lists/:app_list_id

POST accounts/:account_id/app_lists

DELETE accounts/:account_id/app_lists/:app_list_id

Configurations du fournisseur d’événements App

GET accounts/:account_id/app_event_provider_configurations¶

GET accounts/:account_id/app_event_provider_configurations/:id

DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

Attribution des conversions

GET conversion_attribution