Conversions mobiles

Présentation de MACT

La mesure de la promotion d’app mobile sur X permet aux annonceurs de suivre le succès des campagnes publicitaires sur X conçues pour générer des installations ou d’autres conversions in‑app. Un partenaire X de mesure mobile offre à un annonceur la possibilité de gérer les conversions qu’il souhaite suivre à partir des apps qu’il promeut sur X. Une fois que l’annonceur a défini le type et les fenêtres temporelles des événements qu’il veut 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 lesquelles l’utilisateur a interagi pour générer la conversion.

Événements de conversion

Pour pouvoir signaler 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/de l’appareil. Le fait de fournir ces données permet d’enregistrer l’événement de conversion sur la plateforme de X et de renvoyer les données d’attribution lorsque cela est approprié. De plus, l’annonceur peut choisir de fournir des métadonnées supplémentaires sur l’événement de conversion, comme la valeur d’un achat, l’id d’un produit ou une méthode d’inscription.

Référence de l’API

Événement de conversion

POST conversion_event

Enregistrer un événement de conversion pour la mesure mobile. La réponse indiquera une attribution X ou X Audience Platform (TAP). Cela est lié à l’endpoint GET conversion_attribution. Une attribution X, TAP ou aucune attribution sera indiquée dans la réponse. 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 consulter la présentation de TAP pour plus d’informations. Plusieurs paramètres optionnels sont disponibles pour définir les métadonnées associées à chaque événement de conversion. Ces métadonnées n’ont aucun effet sur les calculs d’attribution.

URL de la ressource

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

Paramètres

Name	Description
app_id required	L’identifiant unique correspondant dans le magasin d’applications. 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 les millisecondes ajoutées. Type : string Exemple : `2014-05-22T02:38:28.103Z`
conversion_type required	Le 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 required	L’IDFA ou l’AdID haché avec HMAC_SHA-256. Type : string Exemple : `ABCD1234XYZ`
os_type required	Le type de système d’exploitation pour l’application. Type : enum Valeurs possibles : `IOS`, `ANDROID`
click_window optional	La fenêtre de clic pour cet événement, en jours. Type : int Remarque : `click_window` doit être supérieur ou égal à view_through_window Valeur par défaut : `14` Valeurs possibles : `1`, `7`, `14`, `30`
device_ip_address optional	Adresse IPv4 ou IPv6 de l’appareil au moment où l’événement de conversion s’est produit. Type : string Exemple : `192.133.78.1`
level optional	Un niveau associé à cet événement. Type : int Exemple : `2`
non_twitter_engagement_time optional	L’heure du dernier engagement en dehors de X avant la conversion. Type : string Exemple : `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	Le type d’engagement en dehors de X avant l’événement de conversion. Type : enum Valeurs possibles : `CLICK`, `VIEW`
number_items optional	Nombre d’éléments associés à cet événement. Type : int Exemple : `2`
price_currency optional	Doit être un code ISO 4217 indiquant la devise associée à cet événement. Type : String Exemples : `EUR`, `USD`, `JPY`
price_micro optional	Un montant de prix associé à cet événement, en micro-unités. Type : int Exemple : `123450000`
user_payment_info optional	Une valeur booléenne indiquant si les informations de paiement de l’utilisateur sont stockées dans l’application associée à cet événement. Type : bool Valeurs possibles : `true` ou `false`
view_through_window optional	La fenêtre d’attribution après affichage pour cet événement, en jours. Remarque : `click_window` doit être supérieur ou égal à view_through_window. Type : int Valeur 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"
        }
      }
    }

Tags d’événements d’App

GET accounts/:account_id/app_event_tags

Récupérer les détails de certaines ou de toutes les balises d’événement d’app associées au compte actuel. Elles définissent les fenêtres de conversion configurées pour chaque type de conversion dans le cadre du 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 required	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et est 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 Example: `18ce54d4x5t`
app_event_tag_ids optional	Limite la réponse aux app event tags souhaités en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 ID peuvent être fournis. Type: string Example: `jhp`
count optional	Indique le nombre d’enregistrements à récupérer par requête distincte. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Indique un curseur pour obtenir la page de résultats suivante. Voir Pagination pour plus d’informations. Type: string Example: `8x7v00oow`
sort_by optional	Trie selon un attribut pris en charge, par ordre croissant ou décroissant. Voir Sorting pour plus d’informations. Type: string Example: `created_at-asc`
with_deleted optional	Inclut les résultats supprimés dans votre requête. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count optional	Inclut l’attribut de réponse `total_count`. Note: Ce paramètre et `cursor` sont exclusifs. Note: Les requêtes qui incluent `total_count` auront des limites de taux plus faibles, actuellement définies à 200 toutes les 15 minutes. Type: boolean Default: `false` Possible values: `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érer une balise d’événement d’app spécifique associée au compte en cours. Elles définissent les fenêtres de conversion configurées pour chaque type de conversion dans le cadre du suivi des conversions d’app mobile.

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 required	Identifiant du compte concerné. Apparaît dans le chemin de la ressource et est 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 required	Référence à la balise d’événement d’App utilisée dans la requête. Type : string Exemple : `jhp`
with_deleted optional	Inclure les résultats supprimés dans votre 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ée une nouvelle balise d’événement d’application associée au compte en cours.

URL de la ressource

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

Paramètres

Name	Description
account_id required	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et est 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_store_identifier required	L’identifiant de l’App Store. Type : string Exemple : `com.twitter.android`
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`
os_type required	Le type de système d’exploitation pour l’application. Type : enum Valeurs possibles : `IOS`, `ANDROID`
provider_app_event_id required	L’identifiant de la balise de conversion sur le site du fournisseur. Type : string Exemple : `provider_tag_j5394`
provider_app_event_name required	Le nom de la balise de conversion sur le site du fournisseur. Type : string Exemple : `provider_name_a4382`
deep_link_scheme optional	Indiquez l’URI de deep link pour l’application associée à cette balise. Type : string Exemple : `twitter://`
post_engagement_attribution_window optional	La fenêtre d’attribution post-engagement pour ces événements. Type : int Valeur par défaut : 30 Valeurs possibles : `1`, `7`, `14`, `30`
post_view_attribution_window optional	La fenêtre d’attribution post-view pour ces événements. Type : int Valeur par défaut : 1 Valeurs possibles : `0`, `1`, `7`, `14`, `30`
retargeting_enabled optional	Indique si le reciblage doit être activé pour cette balise d’événement d’application. Type : boolean Valeur 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": "test-tag",
        "app_store_identifier": "com.twitter.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "https://",
        "id": "3p3t",
        "retargeting_enabled": true,
        "conversion_type": "PURCHASE",
        "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": "test-tag",
          "app_store_identifier": "com.twitter.android",
          "account_id": "18ce54d4x5t",
          "conversion_type": "PURCHASE",
          "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 pour le compte actuel.

URL de la ressource

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

Parameters

Name	Description
account_id required	L’identifiant du compte concerné. Apparaît dans le chemin de la ressource et est 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 required	Une référence à la balise d’événement d’app que vous utilisez 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érer les détails de certaines ou de toutes les listes d’applications associées au compte actuel.

URL de la ressource

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

Paramètres

Name	Description
account_id required	Identifiant du compte concerné. Apparaît dans le chemin de la ressource et est 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_list_ids optional	Limite la réponse aux seules listes d’applications souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 identifiants peuvent être fournis. Type : string Exemple : `wm7x`
count optional	Spécifie le nombre d’enregistrements à tenter de récupérer par requête. Type : int Valeur par défaut : `200` Min, Max : `1`, `1000`
cursor optional	Spécifie un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type : string Exemple : `8x7v00oow`
sort_by optional	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 optional	Inclut les résultats supprimés dans votre requête. Type : boolean Valeur par défaut : `false` Valeurs possibles : `true`, `false`
with_total_count optional	Inclut l’attribut de réponse `total_count`. Remarque : Ce paramètre et `cursor` sont mutuellement exclusifs. Remarque : Les requêtes qui incluent `total_count` auront des limites de taux plus faibles, actuellement définies à 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érer une App List spécifique associée au compte actuel.

URL de la ressource

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

Paramètres

Nom	Description
account_id required	Identifiant du compte utilisé. Apparaît dans le chemin de la ressource et est généralement un paramètre requis pour toutes les requêtes de l’Ads API, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
app_list_id required	Référence à la liste d’App avec laquelle vous interagissez dans la requête. Type : string Exemple : `28ukf`
with_deleted optional	Inclure les résultats supprimés dans votre 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_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 un objet app_list associé au compte actuel. Il existe actuellement une limite de 100 objets app_list par account_id et de 500 applications par app_list.

URL de la ressource

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

Paramètres

Name	Description
account_id required	L’identifiant du compte concerné. Apparaît dans le chemin de la ressource et est 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_store_identifiers required	Les identifiants de l’App Store à inclure dans la `app_list`. Type: string Exemple : `com.twitter.android`
name required	Le nom que vous donnerez à la `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": "app list",
        "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": "app list",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/app_lists/:app_list_id

Supprime la liste d’App indiquée, associée au compte actuel.

URL de la ressource

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

Paramètres

Nom	Description
account_id requis	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et est 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_list_id requis	Une référence à la liste d’apps que vous utilisez 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 de l’App

❯

GET accounts/:account_id/app_event_provider_configurations¶

Récupérer les détails relatifs à certaines ou à l’ensemble des configurations de fournisseur d’événements d’application (configuration principale pour le suivi des conversions d’applications mobiles) associées au compte actuel.

URL de la ressource

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

Paramètres

Nom	Description
account_id required	L’identifiant du compte utilisé. Apparaît dans le chemin de la ressource et est 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 optional	Spécifie le nombre d’enregistrements à récupérer par requête distincte. Type: int Valeur par défaut: `200` Min, Max: `1`, `1000`
cursor optional	Spécifie un curseur pour obtenir la page de résultats suivante. Voir Pagination pour plus d’informations. Type: string Exemple: `8x7v00oow`
ids optional	Restreint la réponse aux seules configurations souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 identifiants peuvent être fournis. Type: string Exemple: `25n`
sort_by optional	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 optional	Inclut les résultats supprimés dans votre requête. Type: boolean Valeur par défaut: `false` Valeurs possibles: `true`, `false`
with_total_count optional	Inclut l’attribut de réponse `total_count`. Remarque : ce paramètre et `cursor` sont exclusifs. Remarque : les requêtes qui incluent `total_count` auront des limites de taux plus faibles, actuellement fixées à 200 par période de 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 powered by 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érer un id spécifique de configuration de fournisseur d’événements (configuration principale pour Mobile Application Conversion Tracking) associée au compte en cours.

URL de la ressource

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

Paramètres

Nom	Description
account_id required	L’identifiant du compte exploité. Apparaît dans le chemin de la ressource et est 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 required	Une référence à la configuration du fournisseur d’événements d’App avec laquelle vous travaillez dans la requête. Type : string Exemple : `25n`
with_deleted optional	Inclure les résultats supprimés dans votre requête. 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éez 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 la ressource

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

Paramètres

Nom	Description
account_id obligatoire	Identifiant du compte concerné. Apparaît dans le chemin d’accès à la ressource et est généralement un paramètre obligatoire pour toutes les requêtes de l’API Advertiser, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type : string Exemple : `18ce54d4x5t`
provider_advertiser_id obligatoire	Identifiant de l’annonceur 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’application spécifiée pour le compte actuel.

URL de la ressource

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

Paramètres

Nom	Description
account_id required	L’identifiant du compte concerné. Apparaît dans le chemin de la ressource et est 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`
id required	Une 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 enregistrer d’événement de conversion. La réponse indiquera l’attribution X. Cela est lié à l’endpoint POST conversion_event. Dans la réponse, l’attribution sera soit X, soit TAP, soit aucune attribution. 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 indiqué 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. Reportez-vous à la présentation de TAP pour plus d’informations.

URL de la ressource

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

Parameters

Name	Description
app_id required	Identifiant unique auprès du magasin d’applications 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 les millisecondes incluses. 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é avec HMAC_SHA-256. Type : string Exemple : `ABCD1234XYZ`
os_type required	Le type de système d’exploitation de l’application. 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’ID de l’appareil transmis dans `hashed_device_id`, plus tout ID d’appareil supplémentaire haché. Type : string Exemple : `ABCD1234XYZ`, `DCBA4321XYZ`
non_twitter_engagement_time optional	L’heure de la dernière interaction hors de Twitter avant la conversion. Type : string Exemple : `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	Le type d’interaction hors de Twitter avant l’événement de conversion. Type : enum Valeurs possibles : `CLICK`, `VIEW`
view_through_window optional	La fenêtre d’affichage 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
        }
      }
    }

API X Ads

Notions de base

Ressources

Mesure

​Présentation de MACT

​Événements de conversion

​Référence de l’API

​Événement de conversion

​POST conversion_event

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​Tags d’événements 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 la ressource

Parameters

Exemple de requête

Exemple de réponse

​Listes d’App

​GET accounts/:account_id/app_lists

URL de la ressource

​Paramètres

Exemple de requête

Exemple de réponse

​GET accounts/:account_id/app_lists/:app_list_id

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​POST accounts/:account_id/app_lists

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​DELETE accounts/:account_id/app_lists/:app_list_id

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​Configurations du fournisseur d’événements de l’App

​GET accounts/:account_id/app_event_provider_configurations¶

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​GET accounts/:account_id/app_event_provider_configurations/:id

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

POST accounts/:account_id/app_event_provider_configurations

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

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

URL de la ressource

Paramètres

Exemple de requête

Exemple de réponse

​Attribution des conversions

​GET conversion_attribution

URL de la ressource

Parameters

Présentation de MACT

Événements de conversion

Référence de l’API

Événement de conversion

POST conversion_event

Tags d’événements 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 de l’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