Créatifs

​

Vue d’ensemble

Les créations désignent toute entité pouvant être promue dans une campagne. Les Posts peuvent inclure du texte, des images, des GIF, des vidéos ou des cartes. Les cartes peuvent inclure des images ou des vidéos.

Les créations image, GIF ou vidéo sont importées via soit POST media/upload — un endpoint de mise en ligne simple qui ne prend en charge que les images — soit les endpoints POST media/upload (en morceaux). Elles peuvent être ajoutées aux

cartes :

• POST accounts/:account_id/cards Tweets :
• POST accounts/:account_id/tweets - Pour ajouter des cartes aux Tweets, utilisez le paramètre card_uri. Tweets programmés :
• POST accounts/:account_id/scheduled_tweets

Pour plus de détails sur les cartes, veuillez consulter la page Cards. La page Promoted Video fournit des informations sur l’association de vidéos avec des cartes ou des Tweets.

​

Cartes

La X Ads API prend en charge plusieurs types de cartes pouvant être utilisés dans des Tweets, qui peuvent ensuite être promus dans des campagnes. Remarque : une fois publié sous forme de Tweet, le contenu de la carte devient visible publiquement. Cela peut inclure des informations sur l’utilisateur qui possède la carte.

​

Image

Les spécifications d’image suivantes s’appliquent aux ressources utilisées dans les Cards. Les images doivent peser 3 Mo ou moins et avoir une largeur d’au moins 800 px. En outre, nous prenons en charge les ratios largeur:hauteur suivants.

• Site Web : 1:1 et 1,91:1
• Image App Download : 1:1 et 1,91:1
• Sondage : 1,91:1
• Image Conversation : 1,91:1
• Image Direct Message : 1,91:1

Nous prenons en charge les formats d’image suivants : .bmp, .jpeg et .png.

​

Vidéo

Les spécifications vidéo suivantes s’appliquent aux éléments utilisés dans les Cards. Nous prenons en charge les ratios largeur:hauteur suivants.

• Vidéo de site web : 16:9 et 1:1
• Vidéo de téléchargement d’App : 16:9 et 1:1
• Sondage : 16:9
• Conversation vidéo : 16:9
• Message direct vidéo : 16:9

​

Vidéo sponsorisée

Ce document présente un bref aperçu du processus de mise en ligne et de promotion de vidéos via la X Ads API.

La X Ads API prend en charge la vidéo sponsorisée dans les Tweets et dans les cartes suivantes :

• Vidéo de site Web
• Téléchargement d’app vidéo
• Conversation vidéo

Commencez par mettre en ligne la vidéo à l’aide de l’endpoint POST media/upload (chunked). À l’aide du media_id, associez la vidéo à un compte publicitaire avec l’endpoint POST accounts/:account_id/videos. L’id de la vidéo, parfois appelé media_key, sera utilisé dans les requêtes suivantes. Il s’agit d’une chaîne qui commence par un entier, suivie d’un trait de soulignement, et se terminant par une valeur longue. Par exemple : 13_875943225764098048.

​

Vidéo sponsorisée dans les Tweets

Pour créer un Tweet, utilisez l’endpoint POST accounts/:account_id/tweet avec l’id de la vidéo. À cette étape, vous pouvez également renseigner un titre de vidéo, une description et un appel à l’action (CTA). Ces valeurs sont visibles par les utilisateurs.

​

Vidéo sponsorisée dans les cartes

Les cartes Video App Download et Video Conversation permettent d’ajouter une image d’aperçu (poster). Téléchargez une image à utiliser dans ces cartes via l’endpoint POST media/upload.

Créez la carte à l’aide de l’un des endpoints suivants :

• POST accounts/:account_id/cards/video_website
• POST accounts/:account_id/cards/video_app_download
• POST accounts/:account_id/cards/video_conversation

en utilisant l’id de la vidéo et, en option, le media_id de l’image (pour l’image d’aperçu).

Enfin, créez le Tweet à l’aide de l’endpoint POST accounts/:account_id/tweet. Les cartes sont associées aux Tweets via le paramètre card_uri.

​

Informations générales

Pour des instructions détaillées sur le téléversement de vidéos via l’API, veuillez consulter le Guide de téléversement vidéo.

Les vidéos peuvent également être promues sous forme de pré-roll. Consultez le Guide de l’objectif « Video Views Pre-roll » pour une explication détaillée.

• (Au 2015-10-22) Lors du téléversement de vidéos destinées à être utilisées dans du contenu promu, le paramètre media_category doit avoir la valeur amplify_video pour toutes les requêtes de commande INIT vers l’endpoint POST media/upload (chunked). L’utilisation de ce paramètre garantit que la vidéo est prétraitée de manière asynchrone et préparée pour une utilisation dans du contenu promu. La commande STATUS peut être utilisée pour vérifier l’achèvement du traitement asynchrone après le téléversement de la vidéo.
• La durée maximale actuellement autorisée pour une vidéo promue est de 10 minutes, avec une taille de fichier de 500 Mo ou moins.
• La vidéo téléversée doit être au format MP4 ou MOV.
• La vidéo téléversée est généralement traitée rapidement, mais les temps de traitement peuvent varier selon la durée de la vidéo et la taille du fichier.
• Les images d’aperçu téléversées doivent être au format PNG ou JPG. Il n’y a pas d’exigence d’aspect ou de taille, mais l’image d’aperçu sera ajustée pour s’adapter au lecteur vidéo.

​

Guides

​

Tweets planifiés

​

Introduction

Les Tweets programmés permettent à un annonceur ou à un utilisateur de créer un Tweet qui sera publié à une date ultérieure. En plus de créer et de gérer ces Tweets, l’API permet d’associer ces Tweets à une ligne d’article afin qu’ils soient promus une fois le Tweet mis en ligne. Cela permet aux annonceurs de préparer des Tweets natifs et de planifier à l’avance les créations de leurs campagnes en amont de toute initiative clé. Par exemple, préparer une création de Tweet à publier immédiatement lors de l’annonce d’un nouveau produit.

L’ensemble des fonctionnalités fournies par les endpoints de l’API Scheduled Tweets est présenté ci‑dessous :

• Créer, modifier et afficher de nouveaux Tweets programmés
• Associer un Tweet programmé à une ligne d’article
• Interroger et gérer les Tweets programmés existants
• Une fois qu’un Tweet programmé est mis en ligne, récupérer l’id du Tweet en ligne

​

Endpoints de l’API

L’ensemble des endpoints associés à la fonctionnalité ci-dessus est répertorié ci-dessous :

​

Gestion des Tweets programmés

• GET accounts/:account_id/scheduled_tweets (récupérer la liste de tous les Tweets programmés)
• GET accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (rechercher un Tweet programmé à l’aide de son id)
• POST accounts/:account_id/scheduled_tweets (créer un Tweet programmé)
• PUT accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (modifier un Tweet programmé existant)
• DELETE accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (supprimer un Tweet programmé à l’aide de son id)
• GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (prévisualiser un Tweet programmé existant)

​

Tweets sponsorisés programmés

• GET accounts/:account_id/scheduled_promoted_tweets (récupérer la liste de tous les Tweets sponsorisés programmés)
• GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (rechercher un Tweet sponsorisé programmé à l’aide de son id)
• POST accounts/:account_id/scheduled_promoted_tweets (créer un nouveau Tweet sponsorisé programmé)
• DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (supprimer un Tweet sponsorisé programmé existant à l’aide de son id)

​

Vue des Tweets planifiés

• GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (afficher un Tweet planifié existant)

Étant donné que les Tweets planifiés sont des entités distinctes des Tweets « en direct », deux séries de validations sont exécutées lors de toute création ou modification de ces Tweets. La première série de règles de validation est exécutée lors de l’étape de création du Tweet planifié, en particulier :

​

Création de Tweet programmé :

• Vérifier que l’utilisateur authentifié est autorisé à créer des Tweets organiques pour un @handle donné. Les droits de création de Tweets « Promoted-Only » exigent que l’utilisateur authentifié soit un utilisateur du compte disposant des Tweet composer permissions.
• Vérifier qu’il n’y a pas plus de 30 Tweets programmés pour création dans une fenêtre de 15 minutes autour de l’horodatage scheduled_at. Un message d’erreur SCHEDULED_TWEET_LIMIT_EXCEEDED indique qu’un trop grand nombre de Tweets programmés ont été planifiés dans le même créneau de 15 minutes à venir. Les annonceurs devront supprimer un Tweet programmé existant ou déplacer l’horodatage scheduled_at plus tôt ou plus tard.

​

Le Tweet programmé passe « en ligne » :

• Ces règles de validation sont exécutées à l’heure scheduled_at et sont identiques à celles appliquées lors de la création d’un Tweet classique via l’API. Par exemple, un Tweet programmé ne sera pas mis en ligne et scheduled_status sera défini sur FAILED si le Tweet programmé contient à la fois une image et un GIF

​

Flux de travail

Créer un nouveau Tweet planifié

Un nouveau Tweet planifié peut être créé à l’aide de l’endpoint POST accounts/:account_id/scheduled_tweets. Cet endpoint comporte les paramètres obligatoires suivants : l’heure scheduled_at, ainsi que le text du Tweet si aucune entité média n’est incluse dans le Tweet. En outre, cet endpoint propose plusieurs options supplémentaires qui permettent de créer un Tweet planifié au nom d’un autre @handle via le paramètre as_user_id, ainsi que d’ajouter une carte (card_uri) et des médias (media_ids). Notez qu’un Tweet ne peut contenir que des entités d’un seul et même type, c’est‑à‑dire soit Vidéo, soit GIF, soit Image. Le paramètre nullcast détermine si le Tweet est un Tweet « Promoted-Only » ou non. Tous les nouveaux Tweets planifiés sont « Promoted-Only » (nullcast=true) par défaut. Si nullcast=false, un Tweet planifié organique est créé.

Une fois qu’un Tweet planifié est créé avec succès, la réponse contient un champ id, qui correspond à l’identifiant unique du Tweet planifié lui‑même. En plus de ce champ, un autre champ appelé tweet_id est également renvoyé. Ce champ est initialement null ; toutefois, une fois le Tweet publié, il est renseigné avec l’ID du Tweet « en ligne ».

twurl -H 'ads-api.x.com' -X POST "/6/accounts/:account_id/scheduled_tweets" -d 'scheduled_at=2017-12-24T23:59:00Z&text=Joyeuses Fêtes !'

Cela créera le Tweet planifié suivant :

{
  "request": {
    "params": {
      "text": "Joyeuses Fêtes !",
      "scheduled_at": "2017-12-24T23:59:00Z"
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "917507899668099072",
    "text": "Joyeuses Fêtes !",
    "user_id": "3271358660",
    "scheduled_status": "SCHEDULED",
    "id": 917507899668099100,
    "nullcast": true,
    "created_at": "2017-10-09T21:51:44Z",
    "scheduled_at": "2017-12-24T23:59:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T21:51:44Z",
    "tweet_id": null,
    "media_keys": []
  }
}

Une fois ce Tweet programmé publié, le champ tweet_id sera renseigné avec l’ID du Tweet « live ».

Afficher un Tweet programmé

L’endpoint GET accounts/:account_id/tweet_previews peut ensuite être utilisé avec l’id du Tweet programmé de l’étape précédente pour générer un aperçu du Tweet. La réponse de l’API contiendra une URL d’iframe prête à l’emploi pour afficher un aperçu du Tweet programmé. Les feuilles de style CSS et les images seront servies directement par X.

twurl -H ads-api.x.com -X GET "/6/accounts/18ce54bgxky/tweet_previews?tweet_type=SCHEDULED&tweet_ids=917507899668099072

{
  "request": {
    "params": {
      "tweet_type": "SCHEDULED",
      "tweet_ids": [
        "917507899668099072"
      ],
      "account_id": "18ce54bgxky"
    }
  },
  "data": [
    {
      "tweet_id": "1126633863155871744",
      "preview": "<\iframe class='tweet-preview' src='https://ton.smf1.x.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAAK1WTW%2FjNhD9Kyyv9dqSZdmOgALJbhJsCyxaIDkUWBUEJY0lNhSpklRSN%2FV%2F71CyZbm297S%2BWJxPzpt5I71T9wbgaELeaW6AOygYxyN9rlryhW9JcEPmUbKIkuiG%2FBjgj8yD8IZOqChoEobz5TKK1ssojOP1KlwtFl7BrDMY4oIW%2FTatlMzB3z7JZ940W%2FJZS1Hwrf0Btc60Kve3oMmGSwsTWgjbSL7tXJjhqgSafA0mYfzHhIJywgmwNHmnFbeV4yU%2Bf0WN3daZlvtDa8Gw2htrdRCZXrlDU92aHIPStA2CKOekMrD5KaWVc02SztIZps%2Bh0rIAg27TXNcpJQYk2ii90VLqt7R3ht%2B4cQoMeVClUIAPd03Th01nvDfx0ClmoJFYk0aouGst82gqROaKskf03KCr7LLvXnXN02K3QTHFaziovYdH0seL5qswitfLZTBq6FGIRfSe9Lm1FTfkY%2BX%2FFcpPAlNRC7eufdFSY1%2BxASh84oo8YitzYXM9IZ%2FuaNcQ1HjMbQc61l0VXDmYlsJVbTYVGq0KwPCi2cf5tQFFnjR2zyDU6YycwX%2Fr3oRzvfKpwTaSZ8NfQUoU%2FUsetanxAV79VElhHbm1oIrSiILcvvgquqSN0Q7y8Uz2TQdjWa5bhZP8IUShEeh8IvIxkVB7SY%2FyKctaIL%2B0kgQrMp8n0SKJ10eWxZ4t%2FBXHUzg4idu6nOnNxsIQ1Yka2D9aDc0sQTNQPJP%2B2sgqvPUrGLERozL68ToNLRELvBj4VuZaOSOy1mmsdAi2dxaWOeyhlRzVl6TYozMnhHIjJLCM5y%2BlwaweHOn96afg%2FuHhnl60ETUvgR1HpJsQntkptrcuO0bOOhuLg1NBPfyH6Swrpw2W9O24rBu8kwH8DuEdns9Kv1hLc5rsxBaTLcN1HIdhHIVRuFov5wtMXH748vO2%2BP0jUzjFXE7%2FbMa3%2BFZl3z1ZxhWyjv2fwlfy9NaY6LhO0lm4WC3WcRSvlqO4UqiXYT7C%2B7vwcT7SWlFAxg3LtMHNfH2ODnZ4kIPVPRo9jnN1r5eDNup%2BIy2y5GxuDrQqYMNb6dje9or44HOyQYTnWs%2FXXoD7%2Ba8WrGO4hwZuK%2B2Qt%2F32tAPhB%2B4xt238qjVQtpIbuuvIP6wbjfAIhStncO3eZ0f9keMHmYHuo%2BCwFoJ%2BDfktdEF0JPfebbxgct30b%2BdhY%2B51u%2FGm2U2IR7rW%2FbJU%2FdcBfpEchHjwoO52%2FwENmVvErwgAAA%3D%3D'>"
    }
  ]
}

Un exemple de l’affichage du Tweet planifié nouvellement créé est montré ci-dessus

Associer un Tweet planifié à un line item

Bien que les Tweets planifiés puissent être utilisés pour créer des Tweets organiques, nous permettons également aux partenaires de créer un Tweet « Promoted-Only » (nullcast=true), l’un ou l’autre pouvant être associé à un line item. Pour faciliter cela, nous proposons également l’endpoint POST accounts/:account_id/scheduled_promoted_tweets. Cet endpoint permet uniquement d’associer un seul Tweet planifié promu à un line item dans un seul appel API. Pour associer plusieurs Tweets planifiés au même line item, plusieurs appels API sont nécessaires.

Veuillez noter qu’il n’est pas possible de modifier un Tweet planifié promu existant.

twurl -H 'ads-api.x.com' -X POST "/6/accounts/:account_id/scheduled_promoted_tweets" -d 'line_item_id=a44qc&scheduled_tweet_id=917507899668099072'

{
  "data": {
    "line_item_id": "a44qc",
    "id": "26576",
    "created_at": "2017-10-09T22:24:16Z",
    "updated_at": "2017-10-09T22:24:16Z",
    "scheduled_tweet_id": "917507899668099072",
    "tweet_id": null,
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "a44qc",
      "scheduled_tweet_id": 917507899668099100,
      "account_id": "aaaaa"
    }
  }
}

Cet endpoint crée uniquement une association entre un Tweet programmé donné et un élément de ligne. Une fois que les dates de vol de la campagne/de l’élément de ligne deviennent actuelles, l’élément de ligne commencera automatiquement à diffuser le Tweet « en direct » correspondant. Bien que nous vérifiions à cette étape que le Tweet programmé est dans l’état SCHEDULED et qu’il est valide pour l’objectif donné, aucune autre validation n’est effectuée. Toutes les règles de validation restantes qui s’appliquent à l’élément de ligne et au Tweet programmé sont exécutées lorsque le Tweet passe « en direct ».

Afin de garantir l’absence de problème de diffusion de la campagne, il est recommandé que le Tweet programmé soit scheduled_at à un moment antérieur aux dates de vol de la campagne/de l’élément de ligne.

Par exemple, si le Tweet programmé est configuré pour passer en direct après la date de début de la campagne (et qu’il n’y a qu’un seul Tweet associé à un seul élément de ligne), alors la campagne sera ACTIVE. Toutefois, étant donné que le Tweet programmé n’est pas encore en direct, aucun créatif ne sera disponible pour la diffusion.

Gestion des Tweets programmés

Les ensembles restants d’endpoints permettent aux consommateurs de l’API de gérer tous leurs Tweets programmés et Tweets sponsorisés programmés. Ces API peuvent être utilisées pour renvoyer une liste de tous les Tweets programmés, éventuellement filtrés par un état donné, ainsi que pour rechercher un Tweet programmé donné par son id.

​

Que se passe-t-il lorsqu’un Tweet programmé est publié ?

Une fois qu’un Tweet programmé est sur le point d’être publié, autrement dit à l’heure scheduled_at, les mises à jour suivantes sont effectuées :

• Le Tweet « publié » est créé ; toutefois, une latence pouvant aller jusqu’à 1 seconde peut survenir
• Le tweet_id est ajouté aux entités suivantes :
• Tweet programmé
• Tweet programmé promu
• Une nouvelle entité de Tweet promu est créée

​

Bonnes pratiques

Les bonnes pratiques suivantes sont recommandées lors de la création ou de la promotion de Tweets programmés :

• Assurez-vous que le Tweet est valide au moment de créer le Tweet programmé (par exemple, un Tweet ne peut contenir qu’un seul média parmi image, vidéo ou GIF, et non une combinaison des trois)
• Assurez-vous que les dates de diffusion de la campagne (c.-à-d. start_time et end_time) sont alignées avec l’heure scheduled_at du Tweet programmé
• Les Tweets programmés ne doivent pas être planifiés à plus d’un an (365 jours) à l’avance
• L’aperçu de Tweet n’est actuellement pas pris en charge pour les Tweets programmés (possibilité d’afficher un aperçu des Tweets programmés avant leur création)

​

Médiathèque

​

Introduction

Les endpoints de la Media Library permettent de gérer des images, des GIF et des vidéos pour les comptes X Ads. Les ressources média de la bibliothèque peuvent être utilisées dans des Tweets et pour créer des cartes. Elles peuvent également être réutilisées dans plusieurs creatives, évitant ainsi d’avoir à téléverser le même élément plusieurs fois.

​

Endpoints d’API

• POST media/upload ou POST media/upload (par segments) (importer des médias)
• POST accounts/:account_id/media_library (ajouter des médias à la bibliothèque de médias)

​

Ajout à la bibliothèque

L’ajout de médias à la bibliothèque se fait en deux étapes. Commencez par envoyer le fichier en utilisant soit l’endpoint POST media/upload, soit l’ensemble d’endpoints POST media/upload (chunked). Voir le guide Chunked media upload pour plus de détails sur notre processus de téléversement en plusieurs parties.

twurl -X POST -H upload.x.com "/1.1/media/upload.json?additional_owners=756201191646691328" --file latte.jpeg --file-field "media"

{
   "media_id":966947208837742592,
   "media_id_string":"966947208837742592",
   "size":74194,
   "expires_after_secs":86400,
   "image":{
      "image_type":"image/jpeg",
      "w":800,
      "h":418
   }
}

Ensuite, à l’aide de l’id du média, ajoutez ce média à la bibliothèque du compte publicitaire via l’endpoint POST accounts/:account_id/media_library.

twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/media_library?file_name=latte.jpeg&media_category=TWEET_IMAGE&media_key=966947208837742592&name=Latte"

{
   "request":{
      "params":{
         "name":"Latte",
         "file_name":"latte.jpeg",
         "media_category":"TWEET_IMAGE",
         "account_id":"18ce54d4x5t",
         "media_key":966947208837742592
      }
   },
   "data":{
      "tweeted":false,
      "name":"Latte",
      "file_name":"latte.jpeg",
      "media_url":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
      "media_category":"TWEET_IMAGE",
      "media_key":"3_966947208837742592",
      "created_at":"2018-02-23T08:05:54Z",
      "media_status":"TRANSCODE_COMPLETED",
      "media_key":"966947208837742592",
      "media_type":"IMAGE",
      "updated_at":"2018-02-23T08:06:17Z",
      "deleted":false
   }
}

Remarque : Tweeter des images, des GIF ou des vidéos immédiatement après leur mise en ligne ajoute également ces médias à la bibliothèque.

​

Paramètres de requête

Toutes les requêtes POST de la Media Library nécessitent un identifiant de média. Cette valeur est renvoyée lors de l’étape de téléchargement. Lorsque vous utilisez le media_id, comme dans l’exemple ci-dessus, vous devez également spécifier un media_category. Quatre valeurs de catégorie sont possibles : AMPLIFY_VIDEO, TWEET_GIF, TWEET_IMAGE et TWEET_VIDEO.

En option, les valeurs name et file_name peuvent être définies pour les objets de la Media Library. Ces attributs aident les utilisateurs à distinguer les variantes d’un même média dans la bibliothèque.

Pour les vidéos, il est également possible de définir un titre et une description. Ces valeurs doivent être passées en tant que paramètres de requête video_title et video_description avec l’endpoint POST accounts/:account_id/tweet. Dans le Tweet, ce texte apparaît sous la vidéo.

​

Attributs

La Media Library introduit formellement le concept de media_key. Il s’agit de l’identifiant unique des objets dans la bibliothèque. Les clés média sont des chaînes de caractères au format suivant : 13_875943225764098048. Elles sont entièrement prises en charge dans tous nos endpoints de cartes.

De plus, la réponse de la Media Library inclut le media_id, représenté sous forme de chaîne. Celui-ci est inclus pour les ressources qui n’acceptent pas encore une clé média : Tweets, aperçu de Tweet et Tweets programmés. Nous travaillons à prendre en charge les clés média partout.

L’attribut aspect_ratio est renvoyé pour les GIF et les vidéos. Il peut être utilisé pour filtrer les médias destinés aux cartes qui n’acceptent que certains rapports largeur/hauteur.

*Ces endpoints prennent en charge le paramètre video_id, qui est une clé média.

​

Utilisation

Dans cette section, l’image suivante sera utilisée dans un Tweet et pour créer une carte de site web.

twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/media_library/3_966947208837742592"

{
   "request":{
      "params":{
         "account_id":"18ce54d4x5t",
         "media_key":"3_966947208837742592"
      }
   },
   "data":{
      "tweeted":false,
      "name":"Latte",
      "file_name":"latte.jpeg",
      "media_url":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
      "media_category":"TWEET_IMAGE",
      "media_key":"3_966947208837742592",
      "created_at":"2018-02-23T08:05:54Z",
      "media_status":"TRANSCODE_COMPLETED",
      "media_key":"966947208837742592",
      "media_type":"IMAGE",
      "updated_at":"2018-02-23T08:06:17Z",
      "deleted":false
   }
}

Tweet

Nous pouvons créer le Tweet en référencer les images à l’aide de media_keys.

twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweet?text=coffee&media_keys=966947208837742592&as_user_id=756201191646691328&trim_user=true"

{
   "data":{
      "created_at":"Fri Feb 23 08:20:05 +0000 2018",
      "id":966950781302665218,
      "id_str":"966950781302665218",
      "text":"café https://t.co/T772Hx5GNT",
      "truncated":false,
      "entities":{
         "hashtags":[

         ],
         "symbols":[

         ],
         "user_mentions":[

         ],
         "urls":[

         ],
         "media":[
            {
               "id":966947208837742592,
               "id_str":"966947208837742592",
               "indices":[
                  7,
                  30
               ],
               "media_url":"http://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
               "media_url_https":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
               "url":"https://t.co/T772Hx5GNT",
               "display_url":"pic.x.com/T772Hx5GNT",
               "expanded_url":"https://x.com/apimctestface/status/966950781302665218/photo/1",
               "type":"photo",
               "sizes":{
                  "thumb":{
                     "w":150,
                     "h":150,
                     "resize":"crop"
                  },
                  "large":{
                     "w":800,
                     "h":418,
                     "resize":"fit"
                  },
                  "medium":{
                     "w":800,
                     "h":418,
                     "resize":"fit"
                  },
                  "small":{
                     "w":680,
                     "h":355,
                     "resize":"fit"
                  }
               }
            }
         ]
      },
      "source":"Application de test interne X Ads API",
      "in_reply_to_status_id":null,
      "in_reply_to_status_id_str":null,
      "in_reply_to_user_id":null,
      "in_reply_to_user_id_str":null,
      "in_reply_to_screen_name":null,
      "user":{
         "id":756201191646691328,
         "id_str":"756201191646691328"
      },
      "geo":null,
      "coordinates":null,
      "place":null,
      "contributors":[
         2417045708
      ],
      "retweet_count":0,
      "favorite_count":0,
      "favorited":false,
      "retweeted":false,
      "possibly_sensitive":false,
      "scopes":{
         "followers":false
      },
      "lang":"en"
   },
   "request":{
      "params":{
         "as_user_id":756201191646691328,
         "text":"café",
         "account_id":"18ce54d4x5t",
         "media_keys":[
            966947208837742592
         ],
         "trim_user":true
      }
   }
}

Carte de site web

Tous nos endpoints de cartes prennent en charge les media keys. Nous allons créer la carte de site web en référant la media_key de l’image.

twurl -X POST -H ads-api.x.com "/11/accounts/18ce54d4x5t/cards"

{
  "name": "components create cards",
  "components": [
    {
      "type": "MEDIA",
      "media_key": "3_1323490622599176192"
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android"
      }
    }
  ]
}

Nous associons ensuite cette carte à un Tweet à l’aide de son card_uri.

​

Identification des cartes

​

Introduction

Les Cards sont des formats publicitaires personnalisables utilisant des médias et pouvant être associées à un site web, une App ou des appels à l’action afin de susciter certains engagements des utilisateurs, comme l’ouverture d’un Message privé. Elles peuvent être ajoutées aux Tweets, aux Tweets programmés ou aux brouillons de Tweets.

Les Cards peuvent être référencées dans les objets Tweet de deux façons : par la card_uri de la Card ou par son preview_url. Des valeurs d’exemple pour chacune sont présentées ci-dessous.

card_uri	preview_url
card://1043282691834048513	https://cards.x.com/cards/18ce54d4x5t/68w3s

Remarque : À partir de la version 3 de la X Ads API, seule la card_uri est générée et renvoyée dans la réponse cards pour les nouvelles Cards créées.

Remarque : À partir de la version 5 de la X Ads API, la preview_url n’est plus renvoyée dans la réponse cards.

Le type de référence dans la réponse de l’objet Tweet dépend de la manière dont le Tweet a été créé. En d’autres termes, si le Tweet a été créé à l’aide du paramètre de requête card_uri, la valeur de l’URI de la Card apparaîtra dans la réponse. En revanche, si la preview_url a été incluse dans le texte du Tweet, l’URL d’aperçu apparaîtra dans la réponse.

​

Identifier des Tweets avec card_uri

Pour les Tweets créés à l’aide de la valeur d’URI de la carte, recherchez la référence à la carte dans l’attribut de réponse card_uri. L’exemple de réponse ci-dessous utilise l’endpoint GET accounts/:account_id/tweets.

$ twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweets?trim_user=true&tweet_type=PUBLISHED&tweet_ids=1043551275923591168"
{
  "request": {
    "params": {
      "tweet_ids": [
        "1043551275923591168"
      ],
      "tweet_type": "PUBLISHED",
      "trim_user": true,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "coordinates": null,
      "retweeted": false,
      "source": "Application de test interne X Ads API",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        15
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "1043551275923591168",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "scheduled_status": null,
      "id": 1043551275923591168,
      "in_reply_to_status_id": null,
      "nullcast": true,
      "created_at": "Sat Sep 22 17:23:07 +0000 2018",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "card_uri": "card://1043282691834048513",
      "full_text": "Suivi d'une carte",
      "lang": "en",
      "contributors": [
        2417045708
      ],
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "id": 756201191646691328,
        "id_str": "756201191646691328"
      },
      "tweet_id": "1043551275923591168"
    }
  ]
}

Si vous utilisez l’API Standard, ajoutez include_card_uri=true à la requête.

Quel que soit l’endpoint utilisé, l’attribut de réponse card_uri n’est renvoyé que si le Tweet a été créé à l’aide d’un URI de carte.

Pour les objets Tweet planifiés et en brouillon, la réponse inclura toujours l’attribut de réponse card_uri.

​

Identifier les Tweets avec preview_url

Pour les Tweets créés en incluant l’URL d’aperçu dans le texte du Tweet, l’URL se trouve dans entities[“urls”][i][“expanded_url”] (le champ text contient une URL t.co raccourcie), où i est un indice de tableau (un Tweet peut contenir plusieurs URL).

Pour les objets Tweet planifiés et les brouillons, l’URL d’aperçu apparaîtra toujours dans le champ text.

​

Récupération des cards

Pour obtenir des informations supplémentaires sur une card spécifique, nous proposons deux endpoints : GET accounts/:account_id/cards/all et GET accounts/:account_id/cards/all/:card_id. Le premier permet de récupérer une card via card_uri et le second via l’ID de la card. L’ID de la card se trouve à la fin de preview_url. Dans l’exemple ci-dessus, l’ID est 68w3s.

​

Identification des médias

​

Introduction

Des médias — images, GIF et vidéos — peuvent être ajoutés aux Tweets et aux cartes. En outre, les vidéos peuvent être utilisées comme ressources de pré‑roll et les images peuvent être promues sur la X Audience Platform. Cette section explique comment trouver les références de médias au sein de ces entités.

Il existe deux types d’identifiants de médias : des ID et des clés. Des valeurs d’exemple pour chacun sont présentées ci‑dessous.

ID de média	Clé de média
1029825579531807971	13_1029825579531807971

La clé de média correspond à l’ID précédé d’un préfixe numérique et d’un caractère de soulignement.

​

Images

Le tableau suivant présente les types d’identifiants actuellement disponibles dans la réponse de chaque ressource liée aux images, ainsi que le ou les noms d’attributs correspondants.

Ressource	Identifiant	Attribut(s)
Cartes d’image	Aucun
Tweet	Les deux	entities["media"]["id_str"] entities["media"]["media_key"]
Tweet programmé	Les deux	media_ids et media_keys
Brouillon de Tweet	Les deux	media_ids et media_keys
Médias du compte	Aucun
Médiathèque	Les deux	media_id et media_key

Les cartes d’image et les images des Médias du compte n’incluent aucune référence à un identifiant de média. Les Tweets n’incluent que des ID de média. Les Tweets programmés et les brouillons de Tweet incluent à la fois l’ID de média et la clé de média. La Médiathèque renvoie également les deux.

Pour les Tweets, les champs id et id_str dans l’objet au sein du tableau entities[“media”] correspondent à l’ID de média. Lorsque qu’un Tweet contient plusieurs images, les références à chaque entité média ne peuvent être trouvées que dans extended_entities[“media”].

En plus des références aux identifiants, il est souvent important d’avoir accès à l’URL de l’image.

Ressource	Attribut(s)	Format
Cartes d’image	image	.jpg
Tweet*	entities["media"][0]["media_url"] ou extended_entities["media"][i]["media_url"]	.jpg
Tweet programmé	Aucun
Brouillon de Tweet	Aucun
Médias du compte	media_url	.jpg
Médiathèque	media_url	.jpg

• L’emplacement de cette URL dépend du fait que le Tweet contienne une seule image ou plusieurs images.

Toutes les cartes d’image incluent un attribut de réponse image qui contient l’URL de l’image X. (Pour les cartes de téléchargement d’applications avec image, le nom est wide_app_image.)

Pour les Tweets, l’emplacement de l’URL du média dépend à la fois du type de média et de l’endpoint utilisé. Pour les Tweets avec une seule image, l’URL se trouve dans entities[“media”][0][“media_url”]. Cela vaut à la fois pour la X Ads API et l’API Standard. En revanche, lorsque les Tweets contiennent plusieurs images, les URL ne peuvent être trouvées que dans extended_entities[“media”][i][“media_url”]. Cela n’est disponible que dans l’API Standard.

​

Vidéos

Le tableau suivant présente les types d’identifiants actuellement disponibles dans la réponse de chaque ressource liée aux vidéos ainsi que le ou les noms d’attributs correspondants.

Ressource	Identifiant	Attribut(s)
Cartes vidéo	Peut être l’un ou l’autre	video_content_id
Cartes de sondage vidéo	Aucun
Tweet	Les deux	entities["media"]["id_str"] entities["media"]["media_key"]
Tweet programmé	Les deux	media_ids et media_keys
Tweet brouillon	Les deux	media_ids et media_keys
Médias du compte	Clé média	video_id
Médiathèque	Les deux	media_id et media_key

Bien que les cartes vidéo (à l’exception des cartes de sondage avec vidéo) incluent un attribut de réponse video_content_id, il existe une incohérence dans le type de valeur renvoyée. Dans certains cas, c’est un media ID ; dans d’autres, c’est une media key.

Les informations sur la façon d’accéder à l’URL de la vidéo sont présentées ci-dessous.

Ressource	Attribut(s)	Format
Cartes vidéo	video_url et video_hls_url	.vmap .m3u8
Tweet avec vidéo	extended_entities["media"][i]["video_info"]["variants"][j]["url"]	.mp4
Tweet programmé	Aucun
Tweet brouillon	Aucun
Médias du compte	Aucun
Médiathèque	media_url	.mp4

Les cartes vidéo incluent les attributs de réponse video_url et video_hls_url avec des URL .vmap et .m3u8, respectivement.

​

Médiathèque

Il est parfois nécessaire d’obtenir des informations supplémentaires sur une ressource média. Un cas d’usage, pour les cartes vidéo, consiste à récupérer l’URL MP4 plutôt que l’URL VMAP. Ces informations sont disponibles dans la Médiathèque. Pour plus de détails sur les informations disponibles, consultez notre Guide de la Médiathèque. La plupart des ressources appartenant à l’utilisateur entièrement promouvable (FULL) du compte publicitaire se trouvent dans la médiathèque. Il existe toutefois quelques exceptions.

Récupération des médias

Comme indiqué ci-dessus, les cartes image ne contiennent pas de références ni à des media IDs ni à des media keys. Par conséquent, il n’est pas possible de récupérer leurs ressources via la Médiathèque. Cela vaut également pour les images Account Media.

Les cartes vidéo exigent que la ressource vidéo fasse partie de la Médiathèque (ou de la ressource Videos auparavant) avant leur création. Par conséquent, ces ressources seront toujours récupérables dans la Médiathèque. Cela vaut également pour les ressources Account Media PREROLL.

Enfin, les médias dans les Tweets sont toujours garantis d’être présents dans la Médiathèque.

Le tableau suivant récapitule quelles ressources sont récupérables dans la Médiathèque, en tenant compte du fait que la réponse de la ressource inclut un identifiant à utiliser pour la recherche.

Ressource	Dans la Médiathèque
Cartes image	Non
Cartes vidéo	Oui*
Tweets (tout média)**	Oui
Tweets programmés	Oui
Tweets brouillons	Oui
Images Account Media	Non
Vidéos Account Media (PREROLL)	Oui

• Pour les cartes où le video_content_id est une media key. Lorsque la valeur est un media ID, la ressource existe toujours dans la Médiathèque, mais sa récupération implique d’y ajouter un préfixe numérique suivi d’un soulignement. ** Les Tweets ne renvoient que des media IDs. Bien que la ressource soit garantie d’exister dans la Médiathèque, sa récupération implique d’y ajouter un préfixe numérique suivi d’un soulignement.

Interactions avec Account Media

Il existe deux cas où des ressources média ajoutées à la médiathèque sont automatiquement ajoutées à la ressource Account Media.

• Lorsqu’une ressource AMPLIFY_VIDEO est ajoutée à la Médiathèque, elle est automatiquement ajoutée en tant que ressource Account Media, avec un type de création PREROLL.
• Lorsque des images ayant des dimensions spécifiques (voir « Creative Types » sur notre page des énumérations) sont ajoutées à la Médiathèque, elles sont automatiquement ajoutées en tant que ressources Account Media. Le type de création (p. ex., INTERSTITIAL) dépend des dimensions de l’image.

​

Tweets

​

Introduction

L’API X Ads prend en charge trois types de Tweets : publiés, programmés et brouillons.

​

Tweets nullcastés

Les Tweets peuvent être soit nullcastés (également appelés « Promoted-only »), soit organiques. Les Tweets nullcastés, une fois publiés, n’apparaissent pas dans la timeline publique de l’utilisateur, bien qu’ils soient publics. Les Tweets organiques, en revanche, sont diffusés aux abonnés de l’utilisateur et apparaissent dans la timeline publique de l’utilisateur.

Création de Tweets

Chacun des trois endpoints de création de Tweet prend en charge un paramètre booléen nullcast qui offre à l’utilisateur de l’API la possibilité de créer des Tweets nullcastés ou organiques. Les Tweets nullcastés peuvent être créés par l’utilisateur ou par toute personne disposant de l’autorisation de créer des Tweets au nom de l’utilisateur. Les Tweets organiques ne peuvent être créés que par le full promotable user.

Mise à jour des Tweets

Il est possible de mettre à jour la propriété nullcast pour les Tweets programmés et les brouillons de Tweets. Pour les Tweets programmés, des modifications peuvent être effectuées jusqu’à l’heure scheduled_at du Tweet. Les brouillons de Tweets peuvent être modifiés indéfiniment. Une fois publiés, toutefois, il n’est pas possible de changer un Tweet de nullcasté à organique, ou inversement.

​

Promotion des Tweets

Seuls les Tweets publiés et programmés peuvent être promus. Ils peuvent être nullcast ou organiques, sans restriction. Un annonceur peut promouvoir ses propres Tweets ou ceux d’un autre utilisateur, à condition d’avoir obtenu l’autorisation nécessaire. (Voir : Promoting another user’s Tweets pour plus d’informations.)

Plusieurs Tweets peuvent être promus dans une même campagne. De même, un seul Tweet peut être promu dans une ou plusieurs campagnes.

Pour promouvoir des Tweets publiés, utilisez l’endpoint POST accounts/:account_id/promoted_tweets. Cela associe des Tweets publiés à un line item. Pour promouvoir des Tweets programmés, utilisez l’endpoint POST accounts/:account_id/scheduled_promoted_tweets.

​

ID de Tweet

Les ID des Tweets publiés, programmés et en brouillon sont numériques — ce sont des entiers non signés sur 64 bits. Par exemple, l’ID du Tweet publié suivant est 1166476031668015104.

Lorsque des Tweets publiés ou programmés sont promus, une entité de Tweet promu correspondante est créée. Ces entités ont leurs propres ID, qui sont alphanumériques et représentés sous forme de valeurs encodées en base 36. Par exemple, promouvoir le Tweet publié ci-dessus — c’est-à-dire l’associer à la ligne d’article 6c62d — renvoie la réponse d’API suivante.

$ twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/promoted_tweets?line_item_id=6c62d&tweet_ids=1166476031668015104"
{
  "request": {
    "params": {
      "tweet_ids": [
        1166476031668015104
      ],
      "line_item_id": "6c62d",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "line_item_id": "6c62d",
      "id": "3qwlq6",
      "entity_status": "ACTIVE",
      "created_at": "2019-09-12T21:39:10Z",
      "updated_at": "2019-09-12T21:39:10Z",
      "approval_status": "ACCEPTED",
      "tweet_id": "1166476031668015104",
      "deleted": false
    }
  ],
  "total_count": 1
}

En plus de l’id du Tweet et de l’id de l’élément de ligne, qui ont été transmis dans la requête de création, la réponse inclut un champ id dont la valeur est 3qw1q6, correspondant à l’id du Tweet promu.

​

Carrousels

​

Introduction

L’API X Ads prend en charge la création et la récupération de carrousels vidéo et de carrousels d’images. Le carrousel est un type de carte pouvant contenir entre 2 et 6 médias. La carte carrousel peut rediriger un utilisateur vers un site web ou l’inciter à installer une application mobile. Pour plus d’informations sur les carrousels, leurs avantages, les bonnes pratiques et la FAQ, consultez notre page Carousel Ads on X.

Un carrousel, comme tout autre type de carte, peut être utilisé dans des Tweets, et ces Tweets peuvent ensuite être promus. Le flux de travail est le même que celui auquel vous êtes déjà habitué :

1. Importer les médias
2. Créer la carte
3. Créer le Tweet
4. Promouvoir le Tweet

La seule différence concerne la manière dont la carte est créée. Alors que d’autres requêtes de création de carte acceptent des paramètres query, les requêtes de création de carte carrousel n’acceptent que des corps de requête POST au format JSON.

​

Endpoints

L’X Ads API prend en charge la création et la récupération de carrousels.

Pour créer un carrousel — quel qu’en soit le type — utilisez l’endpoint POST accounts/:account_id/cards. Pour récupérer des carrousels, utilisez l’endpoint GET accounts/:account_id/cards.

​

Corps de requête JSON POST

Les carrousels sont créés à l’aide de deux composants. Le premier indique les ressources média qui seront utilisées. Le second précise des informations relatives soit au site web, soit à l’App.

Plus précisément, une carte de carrousel est créée en utilisant les composants suivants, dans cet ordre :

• Un composant SWIPEABLE_MEDIA, qui accepte un tableau de clés média
• Un des éléments suivants :
• Un composant DETAILS pour préciser les informations du site web
• Un composant BUTTON pour préciser les informations de l’App

Le composant SWIPEABLE_MEDIA doit inclure un tableau media_keys dans lequel vous pouvez spécifier entre 2 et 6 images ou vidéos. L’ordre dans lequel les clés média sont transmises détermine l’ordre dans lequel elles seront rendues.

{
  "type": "SWIPEABLE_MEDIA",
  "media_keys": [
    "13_1089771253848666112",
    "13_1191948012077092867"
  ]
}

Pour rappel, vous pouvez obtenir des clés média en envoyant une requête à l’endpoint GET accounts/:account_id/media_library.

La composition du deuxième objet composant dépend du fait que vous souhaitiez diriger un utilisateur vers un site web ou l’inciter à installer une App. Le tableau ci-dessous récapitule les deux options. (Remarque : toutes les clés répertoriées sont obligatoires.)

	Site web	App
Préciser le type de composant	"type": "DETAILS"	"type": "BUTTON"
Titre/Libellé	"title": "X"	"label": { "type": "ENUM", "value": "INSTALL" }
Destination	"destination": { "type": "WEBSITE", "url": "https://www.x.com" }	"destination": { "type": "APP", ... }

En combinant ces éléments, un exemple de corps JSON de requête POST pour un carrousel de site web est présenté ci-dessous.

{
  "name": "carrousel de site web",
  "components": [
    {
      "type": "SWIPEABLE_MEDIA",
      "media_keys": [
        "13_1089771253848666112",
        "13_1191948012077092867"
      ]
    },
    {
      "type": "DETAILS",
      "title": "X"
      "destination": {
        "type": "WEBSITE",
        "url": "https://www.x.com"
      }
    }
  ]
}

Les objets de destination d’App dans les composants BUTTON nécessitent un code pays et au moins un identifiant d’App. Ils peuvent également accepter des liens profonds. Pour une description de ces fields, consultez la documentation de référence.

En réunissant ces éléments, un exemple de corps de requête POST JSON pour un carrousel d’App est présenté ci-dessous.

{
  "name": "carrousel d’App",
  "components": [
    {
      "type": "SWIPEABLE_MEDIA",
      "media_keys": [
        "13_1089771253848666112",
        "13_1191948012077092867"
      ]
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android",
        "iphone_app_id": "333903271"
      }
    }
  ]
}

​

Exemple

Cette section explique comment créer une carte de carrousel vidéo pour site web et l’utiliser dans un Tweet. Comme mentionné plus haut, le flux de travail est le même que d’habitude : téléversez les médias, créez la carte, créez le Tweet. La seule différence tient à la manière de créer la carte.

Médias

Pour commencer, téléversez de nouvelles ressources médias ou réutilisez celles déjà existantes. Pour en savoir plus sur la façon de téléverser de nouvelles ressources médias et de les ajouter à la Media Library, consultez notre Media Library Guide.

Une fois vos ressources médias dans la Media Library, récupérez-les à l’aide de l’endpoint GET accounts/:account_id/media_library. Utilisez le paramètre de requête media_type pour restreindre les résultats à un type de média précis.

$ twurl -H ads-api.x.com "/10/accounts/18ce54d4x5t/media_library?media_type=VIDEO"

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_type": "VIDEO"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "tweeted": true,
      "duration": 5283,
      "name": "Lever de soleil",
      "file_name": "sunrise.mp4",
      "description": null,
      "media_url": "https://video.twimg.com/amplify_video/1089771253848666112/vid/1280x720/tyL-pUBP7GgkS9bl.mp4?tag=9",
      "poster_media_key": "3_1089771253848666112",
      "media_key": "13_1089771253848666112",
      "created_at": "2019-01-28T06:24:48Z",
      "media_status": "TRANSCODE_COMPLETED",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/1089771253848666112/img/WOYvToSRZFXUSDzd.jpg",
      "title": null,
      "media_type": "VIDEO",
      "aspect_ratio": "16:9",
      "updated_at": "2019-08-23T19:05:33Z",
      "deleted": false
    },
    {
      "tweeted": true,
      "duration": 15248,
      "name": "Neige",
      "file_name": "snow.mp4",
      "description": "Deux, trois, puis quatre",
      "media_url": "https://video.twimg.com/amplify_video/1191948012077092867/vid/1280x720/2cOvadcctqqea6Hx.mp4?tag=13",
      "poster_media_key": "3_1191948012077092867",
      "media_key": "13_1191948012077092867",
      "created_at": "2019-11-06T05:18:46Z",
      "media_status": "TRANSCODE_COMPLETED",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/1191948012077092867/img/IUbhTRd62SEeIVTf.jpg",
      "title": "Un"
      "media_type": "VIDEO",
      "aspect_ratio": "16:9",
      "updated_at": "2020-03-27T22:23:18Z",
      "deleted": false
    }
  ]
}

Création de carrousel

Utilisez l’endpoint POST accounts/:account_id/cards pour créer votre carrousel. Utilisez les clés de média de la requête précédente. Notez que l’ordre dans lequel les clés de média sont transmises détermine l’ordre dans lequel elles sont affichées.

$ twurl -A "Content-Type: application/json" -X POST -H ads-api.x.com "/10/accounts/18ce54d4x5t/cards" -d '{"name":"carrousel de site web","components":[{"type": "SWIPEABLE_MEDIA","media_keys":["13_1089771253848666112","13_1191948012077092867"]},{"type": "DETAILS","title": "X","destination":{"type":"WEBSITE", "url":"https://www.x.com"}}]}'

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "carrousel de site web",
    "components": [
      {
        "type": "SWIPEABLE_MEDIA",
        "media_keys": [
          "13_1089771253848666112",
          "13_1191948012077092867"
        ]
      },
      {
        "type": "DETAILS",
        "title": "X"
        "destination": {
          "type": "WEBSITE",
          "url": "https://www.x.com/",
          "tco_url": "https://t.co/dyTMHWKWZb"
        }
      }
    ],
    "id": "ars7m",
    "created_at": "2020-11-11T07:51:47Z",
    "card_uri": "card://1326432421105995776",
    "updated_at": "2020-11-11T07:51:47Z",
    "deleted": false,
    "card_type": "UNIFIED"
  }
}

Notez que, comme pour les autres cartes, la réponse de la carte carrousel comprend un card_uri, qui sera utilisé lors de la création d’un Tweet.

Tweet

Utilisez l’endpoint POST accounts/:account_id/tweet pour créer votre Tweet. Réutilisez le card_uri de la requête précédente. (Réponse tronquée pour des raisons de lisibilité.)

$ twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweet_previews?tweet_type=PUBLISHED&tweet_ids=1326434098324385792"

{
  "data": {
    "created_at": "Wed Nov 11 07:58:27 +0000 2020",
    "id": 1326434098324385792,
    "id_str": "1326434098324385792",
    "text": "Balayer",
    "truncated": false,
    "entities": {
      "hashtags": [],
      "symbols": [],
      "user_mentions": [],
      "urls": []
    },
    "source": "App de test interne de la X Ads API",
    "in_reply_to_status_id": null,
    "in_reply_to_status_id_str": null,
    "in_reply_to_user_id": null,
    "in_reply_to_user_id_str": null,
    "in_reply_to_screen_name": null,
    "user": {
      "id": 756201191646691300,
      "id_str": "756201191646691328",
      ...
    },
    "geo": null,
    "coordinates": null,
    "place": null,
    "contributors": [
      2417045708
    ],
    "retweet_count": 0,
    "favorite_count": 0,
    "favorited": false,
    "retweeted": false,
    "possibly_sensitive": false,
    "scopes": {
      "followers": false
    },
    "lang": "en",
  },
  "request": {
    "params": {
      "text": "Balayer"
      "as_user_id": 756201191646691300,
      "card_uri": "card://1326432421105995776",
      "account_id": "18ce54d4x5t"
    }
  }
}

Aperçus de Tweet

Utilisez l’endpoint GET accounts/:account_id/tweet_previews pour afficher votre Tweet.

​

creative-metadata-tagging

​

Introduction

Ce guide s’adresse aux partenaires créatifs, aux agences et aux développeurs créatifs, afin d’étiqueter les ressources utilisées dans les campagnes X pour mieux comprendre la valeur et les performances de chaque ressource.

Remarque : Les ressources média ne doivent être étiquetées que par le partenaire ou le développeur qui crée la ressource. Si l’utilisateur de la ressource média n’en est pas le créateur, n’implémentez pas d’étiquetage de metadata.

L’étiquetage des metadata créatives permet d’attribuer les images et vidéos créées par des partenaires créatifs, quel que soit l’endroit où la ressource est importée sur X et quelle que soit l’entité qui la importe. Pour établir la relation entre la ressource créative et le partenaire créatif, la norme XMP est utilisée.

​

Marquage des ressources créatives

Le tableau suivant présente les types d’identifiants actuellement disponibles dans la réponse de chaque ressource liée aux images ainsi que le(s) nom(s) d’attribut correspondant(s). Un outil de marquage est nécessaire pour baliser les ressources créatives. ExifTool, une bibliothèque Perl indépendante de la plate‑forme accompagnée d’une application en ligne de commande pour lire, écrire et modifier les métadonnées, est recommandé. Consultez la liste de tous les types de fichiers pris en charge.

Suivez les instructions d’installation d’ExifTool fournies. Des paquets logiciels sont également proposés par Homebrew pour simplifier davantage l’installation via la commande d’installation exiftool pour macOS et Linux. Vérifiez que l’outil est correctement installé en saisissant exiftool -ver dans la ligne de commande afin d’obtenir son numéro de version. En savoir plus sur les paramètres de commande d’ExifTool dans la documentation ExifTool.

Les partenaires créatifs peuvent attribuer des balises de métadonnées sur des ressources créatives nouvelles ou existantes, avec leur X app_id dans la balise XMP contributor et la balise date. Les ressources créatives respecteront les restrictions de taille existantes lors du téléversement de médias.

Remarque : L’utilisation par X de la balise XMP contributor garantit que les métadonnées capturent des valeurs exclusivement pour les campagnes sur X.

exiftool -contributor="<YOUR APP ID>" -creative_file.jpg

exiftool -date="<date>" -creative_file.jpg

L’app_id se trouve dans le developer portal, sous Projects & Apps. Exemple : 16489123

L’exemple suivant ajoute app_id comme balise contributor et date comme balise date pour une image :

app_id:858382169

date:2022-03-13

creative_file: eiffel_tower.jpg

exiftool -contributor=858382169 eiffel_tower.jpg

   1 fichiers d’images mis à jour

exiftool -date=2022-03-13 eiffel_tower.jpg

  1 fichier image mis à jour

Vérifiez que votre image est correctement étiquetée : 

exiftool -xmp:all -G1 <filename>

Exemple :

exiftool -xmp:all -G1 eiffel_tower.jpg

[XMP]        Kit XMP            : Image::ExifTool 12.30

[XMP]        Contributeur            : 858382169

[XMP]        Date                   : 2022:03:13

​

Des questions ?

Si vous souhaitez confirmer que votre marquage et votre attribution ont bien été effectués, veuillez envoyer des exemples d’assets déjà tagués à [e-mail] afin qu’un représentant de X puisse les examiner.

​

Référence de l’API

​

Médias du compte

Exécuter dans Postman

​

GET accounts/:account_id/account_media

Récupère les détails d’une partie ou de l’ensemble des médias de compte associés au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
account_media_ids optionnel	Limite la réponse aux médias du compte souhaités en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 IDs peuvent être fournis. Type: string Exemple: 3wpx
count optionnel	Spécifie le nombre d’enregistrements à récupérer par requête. Type: int Valeur par défaut: 200 Min, Max: 1, 1000
creative_types optionnel	Limite la réponse aux médias du compte correspondant aux types de créations spécifiés. Plusieurs types peuvent être indiqués en séparant les valeurs d’énumération par des virgules. Type: enum Valeurs possibles: BANNER, BANNER_TABLET, INTERSTITIAL, INTERSTITIAL_LANDSCAPE, INTERSTITIAL_LANDSCAPE_TABLET, INTERSTITIAL_TABLET, MEDIUM_RECTANGLE, PREROLL, VAST_PREROLL
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	Inclut les résultats supprimés dans la réponse. Type: boolean Valeur par défaut: false Valeurs possibles: true, false
with_total_count optionnel	Inclut l’attribut de réponse total_count. Remarque : ce paramètre et cursor sont exclusifs. Remarque : les requêtes incluant total_count auront 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/12/accounts/18ce54d4x5t/account_media?account_media_ids=3wpx

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_media_ids": [
        "3wpx"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_id": "13_771791717175468032",
      "media_url": null,
      "creative_type": "PREROLL",
      "id": "3wpx",
      "created_at": "2016-09-02T19:27:52Z",
      "updated_at": "2016-09-02T19:27:52Z",
      "deleted": false
    }
  ]
}

Récupère un objet média de compte spécifique associé au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte à effet de levier. 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
account_media_id obligatoire	Une référence au média de compte utilisé dans la requête. Type : string Exemple : 2pnfd
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/account_media/2pnfd

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_media_id": "2pnfd",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "video_id": null,
    "media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "2pnfd",
    "created_at": "2017-07-28T01:44:41Z",
    "updated_at": "2017-07-28T01:44:41Z",
    "deleted": false
  }
}

Supprime l’objet média de compte spécifié appartenant au compte actuel.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_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 spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
account_media_id requis	Référence au média du compte utilisé dans la requête. Type: string Exemple: 2pnfd

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd

​

Exemple de réponse

{
  "data": {
    "video_id": null,
    "media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
    "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
    "id": "2pnfd",
    "created_at": "2017-07-28T01:44:41Z",
    "updated_at": "2017-08-25T17:16:26Z",
    "deleted": true
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "account_media_id": "2pnfd"
    }
  }
}

​

Cartes

Exécuter dans Postman

Remarque : Pour associer une carte à un Tweet, utilisez le paramètre card_uri avec les endpoints POST accounts/:account_id/tweet, POST statuses/update, POST accounts/:account_id/scheduled_tweets ou POST accounts/:account_id/draft_tweets.

Récupérez les détails de certaines ou de toutes les cartes associées au compte actuel.

Remarque : Cela renvoie uniquement les cartes créées via l’endpoint POST accounts/:account_id/cards. Les cartes créées via d’autres endpoints ne sont pas renvoyées.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Example: 18ce54d4x5t
card_types optionnel	Limite la réponse aux types de cartes souhaités en spécifiant une liste de valeurs d’énumération séparées par des virgules. Type: enum Possible values: IMAGE_APP, IMAGE_CAROUSEL_APP, IMAGE_CAROUSEL_WEBSITE, IMAGE_MULTI_DEST_CAROUSEL_WEBSITE, IMAGE_WEBSITE, MIXED_MEDIA_MULTI_DEST_CAROUSEL_WEBSITE, MIXED_MEDIA_SINGLE_DEST_CAROUSEL_APP, MIXED_MEDIA_SINGLE_DEST_CAROUSEL_WEBSITE, VIDEO_APP, VIDEO_CAROUSEL_APP, VIDEO_CAROUSEL_WEBSITE, VIDEO_MULTI_DEST_CAROUSEL_WEBSITE, VIDEO_WEBSITE
card_id optionnel	Limite la réponse aux cartes souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 ID de carte peuvent être fournis. Type: string Example: 1044294149527166979,1044301099031658496
card_uris optionnel	Limite la réponse aux cartes souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 valeurs d’URI de carte peuvent être fournies. Type: string Example: card://1044294149527166979,card://1044301099031658496
count optionnel	Spécifie le nombre d’enregistrements à récupérer par requête. Type: int Default: 100 Min, Max: 1, 200
cursor optionnel	Spécifie un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type: string Example: 8x7v00oow
include_legacy_cards optionnel	Inclut dans la réponse les cartes site web et App héritées. Les cartes héritées sont celles dont l’URL de ressource suit le format : accounts/:account_id/cards/:card_type. Voir cette publication du forum des développeurs pour plus de contexte. Type: boolean Default: false Possible values: true, false
q optionnel	Une query facultative pour restreindre les cartes par name. Omettez ce paramètre pour tout récupérer. Longueur maximale : 80 caractères. Note: correspondance de préfixe insensible à la casse. Type: string Example: dtc
sort_by optionnel	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 optionnel	Inclut les résultats supprimés dans votre requête. Type: boolean Default: false Possible values: true, false

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards?count=1

​

Exemple de réponse

{
  "request": {
    "params": {
      "count": 1,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": "8wzvldqtc",
  "data": [
    {
      "name": "lien direct",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OUVRIR",
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface",
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-28T20:47:52Z",
      "deleted": false
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

Récupère les détails d’une carte unique associée au compte actuel.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/:card_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, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
card_id obligatoire	L’id des cartes. Type : string Exemple : 1044294149527166979
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/cards/1321554298900107264

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OPEN"
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-28T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

​

POST accounts/:account_id/cards

Créer une nouvelle carte associée au compte spécifié.

Les requêtes de création de carte n’acceptent que des corps de requête POST au format JSON. L’en-tête Content-Type doit être défini sur application/json.

Consultez notre guide Carrousels pour un exemple d’utilisation détaillé.

​

URL de ressource

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

​

Paramètres

Le corps de la requête POST au format JSON doit inclure un name de carte et un tableau de components. Les composants sont des objets qui décrivent les attributs de la carte visibles par les annonceurs.

L’exemple suivant illustre la structure générale du payload (mais contient des informations non fonctionnelles).

{
  "name": "un nom",
  "components": [
    {
      "type": "TYPE_ENUM",
      "key": "valeur"
    }
  ]
}

Informations supplémentaires sur les composants ci-dessous.

Nom	Description
account_id obligatoire	L’identifiant du compte exploité. 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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
name obligatoire	Le nom de la carte. Longueur maximale : 80 caractères. Type : string Exemple : component based card
components parfois obligatoire	Décrit les composants à utiliser pour créer la carte. Informations supplémentaires ci-dessous. Ne peut pas être utilisé avec slides. Remarque : l’ordre des composants est important. Type : array of objects
slides parfois obligatoire	Utilisez ce tableau de tableaux pour créer des carrousels à destinations multiples. Décrit chaque carte comme un regroupement de composants. Chaque diapositive doit être une représentation complète d’une carte. Ne peut pas être utilisé avec components. Remarque : l’ordre de chaque diapositive est important. Type : array of array

​

Composants

Chaque composant doit inclure un champ type qui détermine le schéma de l’objet. La X Ads API prend en charge les types de composants suivants, regroupés en composants axés sur les médias et sur la description.

• Médias :
• MEDIA : une seule vidéo ou image
• SWIPEABLE_MEDIA : entre 2 et 6 vidéos ou images
• Description :
• DETAILS
• BUTTON

Chaque composant comporte un ensemble de champs obligatoires (en plus de la clé type). Ils sont répertoriés dans le tableau suivant.

type de composant	Champ	Type de valeur
MEDIA	media_key	chaîne
SWIPEABLE_MEDIA	media_keys	tableau de chaînes
DETAILS	title destination	chaîne objet
BUTTON	label destination	objet objet

Voici un exemple de composant BUTTON dans le contexte du tableau components (omettant intentionnellement la clé name). (Les ellipses indiquent les emplacements où davantage d’informations doivent être précisées.)

{
  "components": [
    {
      "type": "BUTTON",
      "label": {
        ...
      },
      "destination": {
        ...
      }
    }
  ]
}

L’ordre dans lequel les objets composant sont spécifiés détermine l’ordre de rendu de haut en bas. Les cartes doivent être créées à l’aide d’un composant médias et d’un composant DETAILS ou BUTTON. Les composants basés sur une description sont rendus sous le média et ont des destinations associées, soit des URL, soit des apps mobiles.

Label

Les libellés définissent le texte affiché sur les boutons et, par conséquent, ne s’appliquent qu’au composant BUTTON. Les objets de libellé comportent deux clés requises : type et value. Le type doit être défini sur ENUM et la value peut être l’une des valeurs suivantes : BOOK, CONNECT, INSTALL, OPEN, ORDER, PLAY ou SHOP.

En reprenant l’exemple précédent, ce qui suit montre l’objet label au sein du composant BUTTON.

{
  "components": [
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALLER"
      },
      "destination": {
        ...
      }
    }
  ]
}

Destination

Les destinations correspondent à l’endroit où les annonceurs veulent diriger les utilisateurs. Elles sont toujours requises dans les composants DETAILS ou BUTTON. Il existe deux types de destination : WEBSITE ou APP.

Remarque : Les destinations de site web ne peuvent être utilisées qu’avec les composants DETAILS et les destinations d’application uniquement avec les composants BUTTON.

Destination site web

Nom	Description
type obligatoire	Le type de destination, qui détermine son schéma. Type : enum Valeurs possibles : WEBSITE
url obligatoire	L’URL du site web vers lequel rediriger un utilisateur. Type : string Exemple : https://devcommunity.x.com/c/advertiser-api

Destination App

Nom	Description
type obligatoire	Le type de destination, qui détermine son schéma. Type : enum Valeurs possibles : APP
country_code obligatoire	Le code à deux lettres ISO 3166-1 alpha-2 du pays où l’application est vendue. Type : string Exemple : US
googleplay_app_id parfois obligatoire	Le nom de package de l’application Google Play. Remarque : Au moins l’un des éléments suivants est requis : ios_app_store_identifier ou googleplay_app_id. Type : string Exemple : com.twitter.android
ios_app_store_identifier parfois obligatoire	L’identifiant de l’App Store iOS. Remarque : Au moins l’un des éléments suivants est requis : ios_app_store_identifier ou googleplay_app_id. Type : string Exemple : 333903271
googleplay_deep_link facultatif	Un lien profond vers l’app Android que vous promouvez. Remarque : Ne peut être utilisé que si un googleplay_app_id a été fourni. Type : string
ios_deep_link facultatif	Un lien profond vers l’app iOS que vous promouvez. Remarque : Ne peut être utilisé que si un ios_app_store_identifier a été fourni. Type : string

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards

{
  "name": "créer des cartes de composants",
  "components": [
    {
      "type": "MEDIA",
      "media_key": "3_1323490622599176192"
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "INSTALL"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android"
      }
    }
  ]
}

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "création de cartes de composants"
    "components": [
      {
        "type": "MEDIA",
        "media_key": "3_1323490622599176192"
      },
      {
        "type": "BUTTON",
        "label": {
          "type": "ENUM",
          "value": "INSTALL"
        },
        "destination": {
          "type": "APP",
          "country_code": "US",
          "googleplay_app_id": "com.twitter.android"
        }
      }
    ],
    "created_at": "2020-11-11T05:42:25Z",
    "card_uri": "card://1326399865065238531",
    "id": "1321554298900107264",
    "updated_at": "2020-11-11T05:42:25Z",
    "deleted": false,
    "card_type": "IMAGE_APP"
  }
}

Met à jour l’élément spécifié associé au compte actuel.

Les requêtes de modification de carte n’acceptent que des corps de requête POST au format JSON. L’en‑tête Content-Type doit être défini sur application/json.

​

URL de ressource

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

​

Paramètres

Le corps de la requête POST au format JSON doit inclure les paramètres à mettre à jour. La requête remplacera chaque champ par les paramètres spécifiés dans le payload. Les composants sont représentés sous forme d’objets et décrivent les attributs de la carte côté annonceur.

L’exemple suivant illustre la structure générale du payload (mais contient des informations non fonctionnelles).

{
  "name": "un nom",
  "components": [
    {
      "type": "TYPE_ENUM",
      "key": "valeur"
    }
  ]
}

Informations supplémentaires sur les composants et les diapositives dans POST accounts/:account_id/cards.

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 Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
name optionnel	Le nom de la carte. Longueur maximale : 80 caractères. Type : string Exemple : component based card
components optionnel	Décrit les composants à utiliser pour mettre à jour la carte. Informations supplémentaires ci-dessous. Ne peut pas être utilisé conjointement avec slides. Remarque : l’ordre des composants est important. Type : array of objects
slides optionnel	Utilisez ce tableau de tableaux pour mettre à jour les carrousels à destinations multiples. Décrit chaque carte comme un regroupement de composants. Chaque diapositive doit être une représentation complète d’une carte. Ne peut pas être utilisé conjointement avec components. Remarque : l’ordre de chaque diapositive est important. Type : array of array

​

Exemple de requête

Cet exemple met à jour le nom et supprime l’une des media_keys du champ components de l’exemple ci-dessus.

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264

{
  "name": "nom modifié",
  "components": [
    {
      "type": "SWIPEABLE_MEDIA",
      "media_keys": [
        "3_1075096386931052545"
      ]
    },
    {
      "type": "BUTTON",
      "label": {
        "type": "ENUM",
        "value": "OUVRIR"
      },
      "destination": {
        "type": "APP",
        "country_code": "US",
        "googleplay_app_id": "com.twitter.android",
        "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
      }
    }
  ]
}

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "nom modifié",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OUVRIR"
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-29T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

Supprime la carte spécifiée appartenant au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte utilisé. Figure 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
card_id obligatoire	L’id de la carte à supprimer. Type : string Exemple : 1044294149527166979

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "3_1075096386931052545"
          ]
        },
        {
          "type": "BUTTON",
          "label": {
            "type": "ENUM",
            "value": "OPEN",
          },
          "destination": {
            "type": "APP",
            "country_code": "US",
            "googleplay_app_id": "com.twitter.android",
            "googleplay_deep_link": "twitter://user?screen_name=apimctestface"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-29T20:47:52Z",
      "deleted": true,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

​

Récupérer des cartes

Exécuter dans Postman

Récupère plusieurs cartes, par card_uri, associées au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
card_uris requis	Limitez la réponse aux cartes souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 valeurs d’URI de carte peuvent être fournies. Type : string Exemple : card://1044294149527166979,card://1044301099031658496
with_deleted optionnel	Incluez 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/cards/all?card_uris=card://1044294149527166979,card://1044301099031658496

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_uris": [
        "card://1044294149527166979",
        "card://1044301099031658496"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "name": "X App",
      "googleplay_app_id": "com.twitter.android",
      "image_display_height": "836",
      "country_code": "US",
      "id": "692xn",
      "wide_app_image": "https://pbs.twimg.com/media/Dc263l9VwAAAeEH.jpg",
      "created_at": "2018-09-24T18:35:01Z",
      "image_display_width": "1600",
      "card_uri": "card://1044294149527166979",
      "updated_at": "2018-09-24T18:35:01Z",
      "app_cta": "INSTALLER",
      "deleted": false,
      "card_type": "IMAGE_APP_DOWNLOAD"
    },
    {
      "video_poster_height": "9",
      "name": "Plateforme des développeurs",
      "website_shortened_url": "https://t.co/zadeUSVD18",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/991374284135137280.vmap",
      "content_duration_seconds": "24",
      "video_owner_id": "756201191646691328",
      "video_content_id": "13_991374284135137280",
      "website_display_url": "developer.x.com",
      "id": "6933h",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/991374284135137280/pl/sQrBsE9mFvNep9Cx.m3u8?tag=2",
      "website_dest_url": "https://developer.x.com",
      "created_at": "2018-09-24T19:02:38Z",
      "card_uri": "card://1044301099031658496",
      "title": "Plateforme des développeurs",
      "website_url": "https://developer.x.com"
      "updated_at": "2018-09-24T19:02:38Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/991374284135137280/img/YbbGQHvWRjoFgrLz.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_WEBSITE"
    }
  ]
}

Récupérer une carte spécifique, via card_id, associée au compte en cours.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/all/:card_id

​

Paramètres

Nom	Description
account_id obligatoire	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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
card_id obligatoire	Référence à la carte utilisée dans la requête. Type : string Exemple : 508pf
with_deleted facultatif	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/cards/all/508pf

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_id": "508pf",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "carte de site web vidéo",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/867520357225418752.vmap",
    "content_duration_seconds": "21",
    "video_owner_id": "756201191646691328",
    "video_content_id": "13_867520357225418752",
    "website_display_url": "developer.x.com",
    "id": "508pf",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/867520357225418752/pl/TPHeH5ZlHFCa2TeJ.m3u8",
    "website_dest_url": "https://developer.x.com/en/docs/ads/creatives/api-reference/video-website#post-accounts-account-id-cards-video-website"
    "created_at": "2017-11-10T09:00:35Z",
    "card_uri": "card://928910245920829440",
    "title": "VWC",
    "website_url": "https://t.co/F81hp59pUF",
    "updated_at": "2018-01-05T05:43:31Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/867520357225418752/img/E3pnXM0sCKnRsFih.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_WEBSITE"
  }
}

​

Tweets en brouillon

Exécuter dans Postman

​

GET accounts/:account_id/draft_tweets

Récupère les détails de certains ou de l’ensemble des Tweets brouillons associés au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 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. Type : int Valeur par défaut : 100 Min, Max : 1, 200
cursor optionnel	Indique un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type : string Exemple : c-jh1g0ryb
user_id optionnel	Indique l’utilisateur pour lequel récupérer les Tweets brouillons. Par défaut, l’utilisateur promouvable FULL du compte est utilisé lorsque le paramètre n’est pas défini. Type : string Exemple : 756201191646691328

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?count=1

​

Exemple de réponse

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "name" null,
      "text": "bonjour, le monde",
      "user_id": "756201191646691328",
      "id": "994791681219231744",
      "nullcast": true,
      "created_at": "2018-05-11T04:09:53Z",
      "card_uri": null,
      "updated_at": "2018-05-11T04:09:53Z"
      "media_keys": []
    }
  ],
  "next_cursor": "c-jh1g0ryb"
}

Récupérer un brouillon de Tweet précis associé au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	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 des annonceurs, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Example: 18ce54d4x5t
draft_tweet_id requis	Référence au Draft Tweet utilisé dans la requête. Type: string Example: 994788364334325760

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994788364334325760

​

Exemple de réponse

{
  "request": {
    "params": {
      "draft_tweet_id": "994788364334325760"
    }
  },
  "data": {
    "name": null,
    "text": "#TwitterDev",
    "user_id": "756201191646691328",
    "id": "994788364334325760",
    "nullcast": true,
    "created_at": "2018-05-11T03:56:42Z",
    "card_uri": "card://958225772740714496",
    "updated_at": "2018-05-11T03:56:42Z",
    "media_keys": []
  }
}

​

POST accounts/:account_id/draft_tweets

Crée un Tweet brouillon pour l’utilisateur entièrement promouvable du compte (par défaut) ou pour l’utilisateur indiqué dans le paramètre as_user_id.

​

URL de ressource

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

​

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 Advertiser, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
as_user_id requis	L’id utilisateur de l’annonceur pour le compte duquel vous publiez le Tweet. L’annonceur doit accorder à votre handle (ou à vos handles) l’accès à son compte publicitaire via ads.x.com. Cette autorisation vous permet d’appeler l’API en utilisant les jetons OAuth de votre propre handle plutôt que ceux de l’annonceur. Type: string Exemple: 756201191646691328
text parfois requis	Le texte de votre mise à jour de statut. Requis si aucun media_keys n’est spécifié. Type: string Exemple: Just setting up my X.
card_uri optionnel	Associez une carte au Tweet en utilisant la valeur card_uri renvoyée par n’importe quelle réponse de cartes, si disponible. Type: string Exemple: card://960880280705392541
media_keys optionnel	Associez des médias au Tweet en indiquant une liste d’identifiants séparés par des virgules. Incluez jusqu’à 4 images, 1 GIF animé ou 1 vidéo. Remarque : La ressource média doit se trouver dans la Media Library du compte. Type: string Exemple: 13_1153584529292270722
nullcast optionnel	Indique s’il faut créer un Tweet en nullcast (ou « Promoted-only »). Type: boolean Valeur par défaut : true Valeurs possibles : true, false
name optionnel	Le nom du Tweet brouillon. Longueur maximale : 80 caractères. Type: string Exemple: Tweet with name

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?as_user_id=756201191646691328&text=Just setting up my X.

​

Exemple de réponse

{
  "request": {
    "params": {
      "text": "Je suis juste en train de configurer mon X.",
      "as_user_id": "756201191646691328"
    }
  },
  "data": {
    "name": null,
    "text": "Je suis juste en train de configurer mon X.",
    "user_id": "756201191646691328",
    "id": "994747471329873920",
    "nullcast": true,
    "created_at": "2018-05-11T01:14:13Z",
    "card_uri": null,
    "updated_at": "2018-05-11T01:14:13Z",
    "media_keys": []
  }
}

Met à jour le Tweet brouillon spécifié appartenant au compte actuel.

​

URL de la ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte levier. 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 indiqué doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
draft_tweet_id obligatoire	Une référence au Draft Tweet utilisé dans la requête. Type: string Exemple: 994747471329873920
card_uri facultatif	Associez une Card au Tweet à l’aide de la valeur card_uri renvoyée par n’importe quelle réponse de Cards, si disponible. Remarque : Désélectionnez (supprimez) en fournissant le paramètre sans valeur. Type: string Exemple: card://970582057284129151
media_keys facultatif	Associez des médias au Tweet en indiquant une liste d’identifiants séparés par des virgules. Incluez jusqu’à 4 images, 1 GIF animé ou 1 vidéo. Remarque : La ressource média doit se trouver dans la Media Library du compte. Remarque : Désélectionnez (supprimez) en fournissant le paramètre sans valeur. Type: string Exemple: 13_1153584529292270722
nullcast facultatif	Indique s’il faut créer un Tweet « nullcast » (ou « Promoted-only »). Type: boolean Valeurs possibles : true, false
text facultatif	Le texte de votre mise à jour de statut. Type: string Exemple: just setting up my twttr
name facultatif	Le nom du Draft Tweet. Longueur maximale : 80 caractères. Type: string Exemple: Tweet with name

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994747471329873920?text=just setting up my twttr

​

Exemple de réponse

{
  "request": {
    "params": {
      "draft_tweet_id": 994747471329873920,
      "text": "je suis en train de configurer mon twttr"
    }
  },
  "data": {
    "name": null,
    "text": "je suis en train de configurer mon twttr",
    "user_id": "756201191646691328",
    "id": "994747471329873920",
    "nullcast": true,
    "created_at": "2018-05-11T01:14:13Z",
    "card_uri": null,
    "updated_at": "2018-05-11T01:16:59Z",
    "media_keys": []
  }
}

Supprime définitivement le brouillon de Tweet spécifié appartenant au compte actuel.

Remarque : Nous recommandons vivement de supprimer les brouillons une fois qu’un Tweet ou un Tweet planifié a été créé à l’aide de sa metadata.

Remarque : Il s’agit d’une suppression définitive. Par conséquent, il n’est pas possible de récupérer des brouillons de Tweet supprimés.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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’Advertiser API, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
draft_tweet_id obligatoire	Une référence au Draft Tweet utilisé dans la requête. Type : string Exemple : 994787835663155200

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994787835663155200

​

Exemple de réponse

{
  "request": {
    "params": {
      "draft_tweet_id": "994787835663155200"
    }
  },
  "data": {
    "name": null,
    "text": "bonjour, le monde",
    "user_id": "756201191646691328",
    "id": "994787835663155200",
    "nullcast": true,
    "status": "DELETED"
    "created_at": "2018-05-11T03:54:36Z",
    "card_uri": null,
    "updated_at": "2018-05-11T04:07:31Z",
    "media_keys": []
  }
}

​

POST accounts/:account_id/draft_tweets/preview/:draft_tweet_id

Prévisualiser un Tweet brouillon sur un appareil mobile.

Une requête réussie envoie une notification à chaque appareil sur lequel l’utilisateur authentifié est connecté. En appuyant sur la notification, une vue de la timeline s’ouvre et permet à l’utilisateur de voir et d’interagir avec le Tweet brouillon afin de tester la lecture automatique, le volume, le mode plein écran, l’ancrage de la carte vidéo de site web, et d’autres comportements.

Remarque : Les aperçus sur l’appareil ne sont visibles que par l’utilisateur qui reçoit la notification.

Remarque : Les notifications sont envoyées uniquement aux apps officielles X.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/draft_tweets/preview/:draft_tweet_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 Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
draft_tweet_id obligatoire	Référence au Draft Tweet utilisé dans la requête. Type : string Exemple : 996132315829948416

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/preview/996132315829948416

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "draft_tweet_id": "996132315829948416"
    }
  },
  "message": "Consultez les notifications de @apimctestface dans l’app X pour prévisualiser votre Tweet."
}

​

Cartes de conversation avec image

Exécuter dans Postman

Remarque : Pour associer une carte à un Tweet, utilisez le paramètre card_uri avec les endpoints POST accounts/:account_id/tweet, POST statuses/update ou POST accounts/:account_id/scheduled_tweets.

​

GET accounts/:account_id/cards/image_conversation

Récupère les détails de certaines ou de toutes les cartes de conversation d’image associées au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	L’identifiant du compte à effet de levier. 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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
card_ids optionnel	Limite la réponse aux image conversation cards souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 IDs peuvent être fournis. Type: string Exemple: 59woh
count optionnel	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 optionnel	Spécifie un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type: string Exemple: 8x7v00oow
q optionnel	Paramètre query facultatif pour limiter les cards par name. Omettez ce paramètre pour tout récupérer. Longueur maximale : 80 caractères. Remarque : effectue une correspondance de préfixe insensible à la casse. Type: string Exemple: night
sort_by optionnel	Trie par attribut pris en charge, dans l’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 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 exclusifs. Remarque : les requêtes qui incluent total_count auront des limites de taux plus basses, 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/12/accounts/18ce54d4x5t/cards/image_conversation?card_ids=59woh

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_ids": [
        "59woh"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "carte de conversation avec image",
      "first_cta": "#moon",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "merci",
      "id": "59woh",
      "first_cta_tweet": "étoiles",
      "media_key": "3_957113581522141184",
      "created_at": "2018-01-27T04:58:42Z",
      "image_display_width": "1280",
      "card_uri": "card://923498485702009837",
      "title": "Pleine lune"
      "updated_at": "2018-01-27T04:58:42Z",
      "deleted": false,
      "card_type": "IMAGE_CONVERSATION"
    }
  ]
}

Récupérer une carte de conversation d’image spécifique associée au compte actuel.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte à effet de levier. 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
card_id obligatoire	Référence à la carte de conversation avec image utilisée dans la requête. Type : string Exemple : 59woh
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/cards/image_conversation/59woh

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_id": "59woh",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "carte de conversation avec image",
    "first_cta": "#lune",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "merci",
    "id": "59woh",
    "first_cta_tweet": "étoiles",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Pleine lune"
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  }
}

​

POST accounts/:account_id/cards/image_conversation

Créez une nouvelle carte de conversation d’image associée au compte spécifié.

Consultez Téléversement de médias pour des informations utiles sur le téléversement d’images vers nos endpoints.

​

URL de ressource

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

​

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 Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
first_cta requis	Le hashtag d’appel à l’action (CTA) pour la première option. Longueur maximale : 20 caractères (sans compter le #). Type: string Exemple: #ShareNow
first_cta_tweet requis	Le texte du Tweet à utiliser lorsque le premier CTA est cliqué. Type: string Exemple: I Heart @AdsAPI
media_key requis	La clé média d’une image à utiliser dans cette carte. Remarque : L’image doit se trouver dans la Media Library du compte. Remarque : Une largeur d’image minimale de 800 px et un ratio largeur:hauteur de 1,91:1 est requise. Type: string Exemple: 3_1151345051104991073
name requis	Le nom de la carte. Type: string Exemple: image conversation card
thank_you_text requis	Le texte à afficher après le clic sur le CTA. Longueur maximale : 23 caractères. Type: string Exemple: Thank you
second_cta parfois requis	Le hashtag d’appel à l’action (CTA) pour la deuxième option. Longueur maximale : 20 caractères (sans compter le #). Type: string Remarque : Requis si title n’est pas défini. Exemple: #ShareAgain
second_cta_tweet parfois requis	Le texte du Tweet à utiliser lorsque le deuxième CTA est cliqué. Remarque : Requis si second_cta est défini. Type: string Exemple: I Heart @AdsAPI Again
title parfois requis	Le titre de la carte, affiché sous l’image et au‑dessus des CTA. Longueur maximale : 23 caractères. Type: string Remarque : Requis si second_cta n’est pas défini. Exemple: Start a conversation
third_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la troisième option. Longueur maximale : 20 caractères (sans compter le #). Type: string Exemple: #ShareMore
third_cta_tweet parfois requis	Le texte du Tweet à utiliser lorsque le troisième CTA est cliqué. Type: string Remarque : Requis si third_cta est défini. Exemple: I Heart @TwitterDev
fourth_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la quatrième option. Longueur maximale : 20 caractères (sans compter le #). Type: string Exemple: #ShareExtra
fourth_cta_tweet parfois requis	Le texte du Tweet à utiliser lorsque le quatrième CTA est cliqué. Type: string Remarque : Requis si fourth_cta est défini. Exemple: I Heart @TwitterDev Again
unlocked_image_media_key optionnel	Un media_key d’une image qui sera utilisée dans le scénario d’instant unlock. Il s’agit d’un champ en écriture seule. Dans la réponse, l’API fournira une URL X pour cette image. Remarque : L’image doit se trouver dans la médiathèque du compte. Remarque : Une largeur d’image minimale de 800 px et un ratio largeur:hauteur de 5:2 est requise. Type: string Exemple: 3_883112887618682880
thank_you_url optionnel	L’URL à afficher avec le texte de remerciement. Type: string Exemple: https://example.com/thankyou

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation?media_key=3_957113581522141184&name=image conversation card&first_cta=#moon&first_cta_tweet=stars&thank_you_text=thanks&title=Full moon

​

Exemple de réponse

{
  "data": {
    "name": "carte de conversation avec image",
    "first_cta": "#lune",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "merci",
    "id": "59woh",
    "first_cta_tweet": "étoiles",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Pleine lune",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "name": "carte de conversation avec image",
      "first_cta": "#lune",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "merci",
      "media_key": "3_957113581522141184",
      "account_id": "18ce54d4x5t",
      "first_cta_tweet": "étoiles",
      "image_display_width": "1280",
      "title": "Pleine lune",
      "card_type": "IMAGE_CONVERSATION"
    }
  }
}

Met à jour la carte de conversation d’image spécifiée appartenant au compte actuel.

Voir Téléversement de médias pour des informations utiles sur le téléversement d’images vers nos endpoints.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id

​

Paramètres

Nom	Description
account_id requis	L’identifiant du compte avec effet de levier. 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 Ads, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
card_id requis	Une référence à la carte de conversation avec image utilisée dans la requête. Type : string Exemple : 4i0qg
first_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la première option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareNow
first_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le premier CTA est cliqué. Type : string Exemple : I Heart @AdsAPI
second_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la deuxième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Remarque : Requis si title n’est pas défini. Exemple : #ShareAgain
second_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le deuxième CTA est cliqué. Remarque : Requis si second_cta est défini. Type : string Exemple : I Heart @AdsAPI Again
third_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la troisième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareMore
third_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le troisième CTA est cliqué. Type : string Remarque : Requis si third_cta est défini. Exemple : I Heart @TwitterDev
fourth_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la quatrième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareExtra
fourth_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le quatrième CTA est cliqué. Type : string Remarque : Requis si fourth_cta est défini. Exemple : I Heart @TwitterDev Again
media_key optionnel	La clé média d’une image à utiliser dans cette carte. Remarque : L’image doit se trouver dans la Media Library du compte. Remarque : Une largeur d’image minimale de 800 px et un ratio largeur:hauteur de 1,91:1 sont requis. Type : string Exemple : 3_1151345051104991073
name optionnel	Le nom de la carte. Type : string Exemple : moon card
thank_you_text optionnel	Le texte affiché après le clic sur le CTA. Longueur maximale : 23 caractères. Type : string Exemple : Thank you
thank_you_url optionnel	L’URL affichée avec le texte de remerciement. Type : string Exemple : https://example.com/thankyou
title optionnel	Le titre de la carte, qui apparaît sous l’image et au-dessus des CTA. Longueur maximale : 23 caractères. Type : string Remarque : Requis si second_cta n’est pas défini. Exemple : Start a conversation
unlocked_image_media_key optionnel	Un media_key d’une image utilisée dans le scénario d’instant unlock. Il s’agit d’un champ en écriture seule. Dans la réponse, l’API fournira une URL X pour cette image. Remarque : L’image doit se trouver dans la médiathèque du compte. Remarque : Une largeur d’image minimale de 800 px et un ratio largeur:hauteur de 5:2 sont requis. Type : string Exemple : 3_883112887618682880

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/59woh?name=moon card

​

Exemple de réponse

{
  "data": {
    "name": "carte de la lune",
    "id": "59woh",
    "created_at": "2018-01-27T04:58:42Z",
    "card_uri": "card://923498485702009837",
    "updated_at": "2018-01-29T21:04:39Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "IMAGE_CONVERSATION",
      "card_id": "59woh",
      "name": "carte de la lune"
    }
  }
}

Supprime définitivement la carte de conversation image spécifiée appartenant au compte actuel.

Remarque : Il s’agit d’une suppression définitive (hard delete). Par conséquent, il n’est pas possible de récupérer les cartes supprimées.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id

​

Paramètres

Nom	Description
account_id obligatoire	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 des annonceurs, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type: string Exemple : 18ce54d4x5t
card_id obligatoire	Une référence à la carte de conversation d’image utilisée dans la requête. Type: string Exemple : 4i0qe

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/4i0qe

​

Exemple de réponse

{
  "data": {
    "name": "carte de conversation image",
    "id": "4i0qe",
    "created_at": "2017-07-07T00:03:01Z",
    "updated_at": "2017-08-23T13:26:23Z",
    "deleted": true,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0qe",
      "card_type": "image_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}

​

Bibliothèque de médias

Exécuter dans Postman

​

GET accounts/:account_id/media_library

Récupère les détails de certains ou de l’ensemble des objets de la médiathèque associés au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 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 à récupérer par requête. Type: int Par défaut : 20 Min, Max : 1, 50
cursor optionnel	Indique un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type: string Exemple : c-1
media_type optionnel	Restreint la réponse au type de média souhaité. Type: enum Valeurs possibles : GIF, IMAGE, VIDEO
q optionnel	Paramètre query optionnel pour filtrer la ressource par les fields name, title, file_name et description. Remarque : effectue une correspondance de termes insensible à la casse. Type: string Longueur min., max. : 1, 255

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?count=1

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "count": 1
    }
  },
  "data": [
    {
      "tweeted": true,
      "name": null,
      "file_name": "café https://t.co/4tcPU9XUon",
      "media_url": "https://pbs.twimg.com/media/DJvnJf_UEAAXnzC.jpg",
      "media_category": "TWEET_IMAGE",
      "media_key": "3_908573900237180928",
      "created_at": "2017-09-15T06:11:12Z",
      "media_status": "TRANSCODE_COMPLETED",
      "media_type": "IMAGE",
      "updated_at": "2017-11-16T06:00:01Z",
      "deleted": false
    }
  ],
  "next_cursor": "c-1"
}

Récupère un objet précis de la médiathèque associé au compte actuel.

​

URL de la ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 Ads, à l’exception de GET accounts. Le compte indiqué doit être associé à l’utilisateur authentifié. Type: string Example: 18ce54d4x5t
media_key obligatoire	Référence à l’objet de la médiathèque utilisé dans la requête. Type: string Example: 13_909110614026444802

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/13_909110614026444802

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "13_909110614026444802"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 39973,
    "name": null,
    "file_name": "buildings https://t.co/xFdzrHM5QG",
    "description": null,
    "media_url": "https://video.twimg.com/amplify_video/909110614026444802/vid/1280x720/mfahmfkKVjjk1nGm.mp4",
    "media_category": "AMPLIFY_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/909110614026444802/img/QZUNoaiCia0UFNrw.jpg",
    "poster_media_key": "3_909110614026444802",
    "media_key": "13_909110614026444802",
    "created_at": "2017-09-16T17:43:55Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "buildings",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-09-27T13:04:00Z",
    "deleted": false
  }
}

Associer un objet média au compte en cours. Pour plus de détails, consultez notre guide Media Library.

Remarque : Lorsqu’une vidéo avec la catégorie de média AMPLIFY_VIDEO est ajoutée à la Media Library, elle est automatiquement disponible en tant que ressource PREROLL account_media.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte utilisé. 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
media_key obligatoire	Le media_key du contenu téléversé. Un media_key est renvoyé dans la réponse à POST media/upload lorsqu’une media_category est spécifiée. Type : string Exemple : 3_931236738554519552
description facultatif	La description qui apparaît sous la vidéo lorsqu’elle est publiée en tant que Tweet. Longueur maximale : 200 caractères. Elle n’est pas affichée dans le Tweet par défaut. Pour afficher la description de la vidéo, utilisez le paramètre video_description avec l’endpoint POST accounts/:account_id/tweet. Remarque : utilisable uniquement avec des vidéos. Type : string Exemple : This is the description under the video.
file_name facultatif	Le nom de fichier de l’objet de la médiathèque. Longueur maximale : 255. Le nom de fichier est visible dans les détails de chaque ressource média dans l’interface Media Library sur ads.x.com. Ce champ sera vide si file_name n’est pas défini. Type : string Exemple : coffee.jpeg
name facultatif	Le nom de l’objet de la médiathèque. Longueur maximale : 100. Il s’agit de l’étiquette sous chaque ressource média dans l’interface Media Library sur ads.x.com. L’étiquette sera « Sans titre » lorsque name n’est pas défini. Type : string Exemple : Latte
poster_media_key facultatif	Spécifiez une image d’aperçu pour la vidéo en utilisant le media_key d’une image téléversée. Si non spécifié, la première image sera utilisée. Remarque : utilisable uniquement avec des vidéos. Type : string Exemple : 3_890599134483242005
title facultatif	Le titre (accroche) qui apparaît sous la vidéo lorsqu’elle est publiée en tant que Tweet. Longueur maximale : 70 caractères. Il n’est pas affiché dans le Tweet par défaut. Pour afficher le title de la vidéo, utilisez le paramètre video_title avec l’endpoint POST accounts/:account_id/tweet. Remarque : utilisable uniquement avec des vidéos. Type : string Exemple : Video title

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?media_key=3_931236738554519552

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "3_931236738554519552"
    }
  },
  "data": {
    "tweeted": false,
    "name": null,
    "file_name": null,
    "media_url": "https://pbs.twimg.com/media/DOxq4TtV4AAlvh_.jpg",
    "media_category": "TWEET_IMAGE",
    "media_key": "3_931236738554519552",
    "created_at": "2017-11-16T19:05:14Z",
    "media_status": "TRANSCODE_COMPLETED",
    "media_type": "IMAGE",
    "updated_at": "2017-11-16T19:05:23Z",
    "deleted": false
  }
}

Met à jour l’objet spécifié de la médiathèque appartenant au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 Example: 18ce54d4x5t
media_key obligatoire	Référence à l’objet de la médiathèque utilisé dans la requête. Type: string Example: 16_844800354743074820
description optionnel	La description qui apparaît sous la vidéo lorsqu’elle est publiée en tant que Tweet. Longueur maximale : 200 caractères. Elle n’est pas affichée dans le Tweet par défaut. Pour afficher la description de la vidéo, utilisez le paramètre video_description avec l’endpoint POST accounts/:account_id/tweet. Remarque : utilisable uniquement avec des vidéos. Type: string Example: This is the description under the video.
file_name optionnel	Le nom de fichier de l’objet de la médiathèque. Longueur maximale : 255. Le nom de fichier est visible dans les détails de chaque ressource média dans l’interface Media Library sur ads.x.com. Ce champ sera vide si file_name n’est pas défini. Type: string Example: coffee.jpeg
name optionnel	Le nom de l’objet de la médiathèque. Longueur maximale : 100. Il s’agit du libellé sous chaque ressource média dans l’interface Media Library sur ads.x.com. Le libellé sera « Untitled » si name n’est pas défini. Type: string Example: Latte
poster_media_key optionnel	Spécifie une image d’illustration (poster) pour la vidéo en utilisant le media_key d’une image téléversée. Remarque : utilisable uniquement avec des vidéos. Type: string Example: 3_885003359340375465
title optionnel	Le titre (accroche) qui apparaît sous la vidéo lorsqu’elle est publiée en tant que Tweet. Longueur maximale : 70 caractères. Il n’est pas affiché dans le Tweet par défaut. Pour afficher le title de la vidéo, utilisez le paramètre video_title avec l’endpoint POST accounts/:account_id/tweet. Remarque : utilisable uniquement avec des vidéos. Type: string Example: Video title

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/16_844800354743074820?title=GIF de chat&description=dans l’espace

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "16_844800354743074820",
      "title": "GIF de chat",
      "description": "dans l'espace"
    }
  },
  "data": {
    "tweeted": true,
    "duration": null,
    "name": null,
    "file_name": null,
    "description": "dans l'espace",
    "media_url": "https://video.twimg.com/tweet_video/C7lVclqVwAQqTCZ.mp4",
    "media_category": "TWEET_GIF",
    "poster_media_url": "https://pbs.twimg.com/tweet_video_thumb/C7lVclqVwAQqTCZ.jpg",
    "poster_media_key": "3_844800354743074820",
    "media_key": "16_844800354743074820",
    "created_at": "2017-10-20T09:51:54Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "GIF de chat",
    "media_type": "GIF",
    "aspect_ratio": "125:79",
    "updated_at": "2017-10-23T06:37:56Z",
    "deleted": false
  }
}

Supprime l’objet de la médiathèque spécifié appartenant au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 spécifié doit être associé à l’utilisateur authentifié. Type: string Exemple: 18ce54d4x5t
media_key obligatoire	Référence à l’objet de la médiathèque concerné par la requête. Type: string Exemple: 7_860318603387600896

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/7_860318603387600896

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "7_860318603387600896"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 14330,
    "name": "mountains-on-ads.x.com",
    "file_name": "mountains.mp4",
    "description": "",
    "media_url": "https://video.twimg.com/ext_tw_video/860318603387600896/pu/vid/1280x720/xI3DbvWKxdvICsFW.mp4",
    "media_category": "TWEET_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/media/C_B3bTRVYAAFBFt.jpg",
    "poster_media_key": "3_860318839740915712",
    "media_key": "7_860318603387600896",
    "created_at": "2017-05-05T02:21:53Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "téléversé sur ads.x.com",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-05-05T02:26:58Z",
    "deleted": true
  }
}

​

Cartes de sondage

Exécuter dans Postman

​

GET accounts/:account_id/cards/poll

Récupérer les détails de certaines ou de toutes les cartes de sondage associées au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	L’identifiant du compte utilisé. Figure 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
card_ids optionnel	Restreint la réponse aux cartes de sondage souhaitées en spécifiant une liste d’identifiants séparés par des virgules. Jusqu’à 200 identifiants peuvent être fournis. Type : string Exemple : 57i77
count optionnel	Indique le nombre d’enregistrements à tenter de récupérer par requête. 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
q optionnel	Paramètre query optionnel pour restreindre les cartes par name. Omettez ce paramètre pour tout récupérer. Longueur maximale : 80 caractères. Remarque : effectue une correspondance par préfixe insensible à la casse. Type : string Exemple : night
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	Inclut les résultats supprimés dans la réponse. Type : boolean Valeur par défaut : false Valeurs possibles : true, false
with_total_count optionnel	Inclut l’attribut de réponse total_count. Remarque : ce paramètre et cursor sont 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/cards/poll?card_ids=57i77

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_ids": [
        "57i77"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_poster_height": "9",
      "name": "sondage meilleure côte",
      "start_time": "2018-01-09T04:51:34Z",
      "first_choice": "Est",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
      "content_duration_seconds": "8",
      "second_choice": "Ouest",
      "end_time": "2018-01-16T04:51:34Z",
      "id": "57i77",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
      "created_at": "2018-01-09T04:51:34Z",
      "duration_in_minutes": "10080",
      "card_uri": "card://950590850777497601",
      "updated_at": "2018-01-09T04:51:34Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_POLLS"
    }
  ]
}

Récupère une carte de sondage spécifique associée au compte actuel.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_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 obligatoire 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
card_id obligatoire	Une référence à la carte de sondage utilisée dans la requête. Type : string Exemple : 57i8t
with_deleted facultatif	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/cards/poll/57i8t

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_id": "57i8t",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "sondage texte seulement",
    "start_time": "2018-01-09T05:03:05Z",
    "first_choice": "Matin",
    "second_choice": "Soir",
    "end_time": "2018-01-11T05:03:05Z",
    "id": "57i8t",
    "created_at": "2018-01-09T05:03:05Z",
    "duration_in_minutes": "2880",
    "card_uri": "card://950593749658189824",
    "updated_at": "2018-01-09T05:03:05Z",
    "deleted": false,
    "card_type": "TEXT_POLLS"
  }
}

​

POST accounts/:account_id/cards/poll

Crée une nouvelle carte de sondage associée au compte spécifié. Cet endpoint permet de créer des cartes de sondage avec une image, une vidéo ou sans média. Les sondages avec média sont appelés Media Forward Polls.

Remarque : Le produit Media Forward Polls est en version bêta et nécessite la fonctionnalité de compte PROMOTED_MEDIA_POLLS.

Remarque : Il n’est pas possible de mettre à jour (PUT) des cartes de sondage.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	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 Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
duration_in_minutes requis	Durée (en minutes) pendant laquelle le sondage restera ouvert. Une fois la duration_in_minutes écoulée, le sondage se ferme et les votes ne sont plus acceptés. Correspond à end_time dans la réponse. Remarque : le décompte commence dès la création de la carte et non lorsqu’elle est ajoutée à un Tweet. Type : int Min, Max : 5, 10080
first_choice requis	Premier choix du sondage. Longueur maximale : 25 caractères. Type : string Exemple : One
name requis	Nom de la carte. Type : string Exemple : poll card
second_choice requis	Deuxième choix du sondage. Longueur maximale : 25 caractères. Type : string Exemple : Two
fourth_choice optionnel	Quatrième choix du sondage. Longueur maximale : 25 caractères. Remarque : les premier, deuxième et troisième choix doivent être définis lors de l’utilisation de ce paramètre. Type : string Exemple : Four
media_key optionnel	Le media_key d’une image ou d’une vidéo de la médiathèque qui sera utilisée dans cette carte. Champ en écriture seule. Dans la réponse, l’API fournira une URL X pour ce média. Remarque : l’image ou la vidéo doit se trouver dans la médiathèque du compte. Remarque : une largeur d’image minimale de 800 px et un ratio largeur:hauteur de 1,91:1 sont requis.
third_choice optionnel	Troisième choix du sondage. Longueur maximale : 25 caractères. Remarque : les premier et deuxième choix doivent être définis lors de l’utilisation de ce paramètre. Type : string Exemple : Three

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll?duration_in_minutes=10080&first_choice=East&second_choice=West&media_key=13_950589518557540353&name=best coast poll

​

Exemple de réponse

{
  "request": {
    "params": {
      "first_choice": "East",
      "name": "sondage meilleure côte",
      "second_choice": "West",
      "media_key": "13_950589518557540353",
      "duration_in_minutes": 10080
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "sondage meilleure côte",
    "start_time": "2018-01-09T04:51:34Z",
    "first_choice": "East",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
    "content_duration_seconds": "8",
    "second_choice": "West",
    "end_time": "2018-01-16T04:51:34Z",
    "id": "57i77",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
    "created_at": "2018-01-09T04:51:34Z",
    "duration_in_minutes": "10080",
    "card_uri": "card://950590850777497601",
    "updated_at": "2018-01-09T04:51:34Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_POLLS"
  }
}

Supprime définitivement la carte de sondage spécifiée appartenant au compte en cours.

Remarque : il s’agit d’une suppression irréversible (« hard delete »). Par conséquent, il n’est pas possible de récupérer les cartes supprimées.

​

URL de la ressource

https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_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 Ads, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
card_id requis	Une référence à la carte de sondage utilisée dans la requête. Type : string Exemple : 57i9t

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll/57i9t

​

Exemple de réponse

{
  "data": {
    "name": "sondage avec image",
    "start_time": "2018-01-09T05:10:51Z",
    "id": "57i9t",
    "created_at": "2018-01-09T05:10:51Z",
    "updated_at": "2018-01-09T05:11:04Z",
    "deleted": true,
    "card_type": "IMAGE_POLLS"
  },
  "request": {
    "params": {
      "card_id": "57i9t",
      "card_type": "poll",
      "account_id": "18ce54d4x5t"
    }
  }
}

​

Appels à l’action pré-roll

Exécuter dans Postman

​

GET accounts/:account_id/preroll_call_to_actions

Récupère les détails de certaines ou de toutes les incitations à l’action (CTA) de pré‑roll associées aux line items de l’annonceur dans le compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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
line_item_ids facultatif	Restreint la réponse aux CTA de preroll associés aux line items spécifiés en fournissant une liste d’identifiants séparés par des virgules. Jusqu’à 200 id peuvent être fournis. Type: string Exemple: 8v53k
count facultatif	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 facultatif	Spécifie un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type: string Exemple: 8x7v00oow
preroll_call_to_action_ids facultatif	Restreint la réponse aux CTA de preroll souhaités en fournissant une liste d’identifiants séparés par des virgules. Jusqu’à 200 id peuvent être fournis. Type: string Exemple: 8f0
sort_by facultatif	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 facultatif	Inclure les résultats supprimés dans la requête. Type: boolean Valeur par défaut : false Valeurs possibles : true, false
with_total_count facultatif	Inclure l’attribut de réponse total_count. Remarque : Ce paramètre et cursor sont mutuellement exclusifs. Remarque : Les requêtes incluant total_count auront 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/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_ids=8v53k

​

Exemple de réponse

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "line_item_ids": [
        "8v53k"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8v53k",
      "call_to_action_url": "https://www.x.com",
      "call_to_action": "VISIT_SITE",
      "id": "8f0",
      "created_at": "2017-07-07T19:28:40Z",
      "updated_at": "2017-07-07T19:28:40Z",
      "deleted": false
    }
  ]
}

Récupérer un appel à l’action (CTA) spécifique associé à ce compte.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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
preroll_call_to_action_id obligatoire	Référence à l’appel à l’action de pré‑roll utilisé dans la requête. Type : string Exemple : 8f0
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/preroll_call_to_actions/8f0

​

Exemple de réponse

{
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  }
}

​

POST accounts/:account_id/preroll_call_to_actions

Définit l’appel à l’action (CTA) facultatif pour un élément de campagne PREROLL_VIEWS.

​

URL de ressource

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

​

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 des annonces, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
call_to_action requis	Le texte du CTA pour le bouton affiché dans la publicité. Type : enum Valeurs possibles : GO_TO, SEE_MORE, SHOP, VISIT_SITE, WATCH_NOW
call_to_action_url requis	L’URL vers laquelle rediriger l’utilisateur lorsque l’on clique sur le bouton CTA. Type : string Exemple : https://www.x.com
line_item_id requis	Référence à l’élément de ligne utilisé dans la requête. Type : string Exemple : 8v53k

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_id=8v53k&call_to_action=VISIT_SITE&call_to_action_url=https://www.x.com

​

Exemple de réponse

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "8v53k",
      "call_to_action": "VISIT_SITE",
      "call_to_action_url": "https://www.x.com",
      "account_id": "18ce54d4x5t"
    }
  }
}

Mettre à jour l’appel à l’action (CTA) facultatif pour un item de ligne PREROLL_VIEWS.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
preroll_call_to_action_id obligatoire	Référence au CTA de pré‑roll utilisé dans la requête. Type : string Exemple : 8f0
call_to_action facultatif	Texte du CTA pour le bouton affiché dans la publicité. Type : enum Valeurs possibles : GO_TO, SEE_MORE, SHOP, VISIT_SITE, WATCH_NOW
call_to_action_url facultatif	URL vers laquelle l’utilisateur est redirigé lorsque le bouton CTA est cliqué. Type : string Exemple : https://www.x.com

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0?call_to_action=WATCH_NOW

​

Exemple de réponse

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "WATCH_NOW",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-09-09T05:51:26Z",
    "deleted": false
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "call_to_action": "WATCH_NOW",
      "account_id": "18ce54d4x5t"
    }
  }
}

Supprime le Call-to-Action (CTA) pré-roll spécifié appartenant au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte à effet de levier. Figure dans le chemin de la ressource et constitue généralement un paramètre obligatoire 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
preroll_call_to_action_id obligatoire	Référence au CTA de pré‑roll utilisé dans la requête. Type: string Exemple: 8f0

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0

​

Exemple de résultat

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-08-30T06:08:21Z",
    "deleted": true
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  }
}

​

Tweets planifiés

Exécuter dans Postman

​

GET accounts/:account_id/scheduled_tweets

Récupère les détails de certains ou de l’ensemble des Tweets programmés associés au compte actuel.

​

URL de la ressource

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

​

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’Advertiser API, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
count optionnel	Spécifie le nombre d’enregistrements à récupérer par requête. Type : int Valeur par défaut : 100 Min., Max : 1, 200
cursor optionnel	Spécifie un curseur pour obtenir la page suivante de résultats. Voir Pagination pour plus d’informations. Type : string Exemple : c-j3cn6n40
user_id optionnel	Spécifie l’utilisateur pour lequel récupérer les Scheduled Tweets. Par défaut, correspond à l’utilisateur promouvable FULL du compte lorsqu’il n’est pas défini. Type : long Exemple : 756201191646691328

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?count=1

​

Exemple de réponse

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "name": "nom de test",
      "completed_at": "2017-06-18T22:00:05Z",
      "text": "où vous voulez être",
      "user_id": "756201191646691328",
      "scheduled_status": "SUCCESS",
      "id": "875828692081037312",
      "nullcast": true,
      "created_at": "2017-06-16T21:33:27Z",
      "scheduled_at": "2017-06-18T22:00:00Z",
      "card_uri": null,
      "updated_at": "2017-06-19T18:02:20Z",
      "tweet_id": "876560168963645440",
      "media_keys": []
    }
  ],
  "next_cursor": "c-j41uw400"
}

Récupérez un Tweet programmé spécifique associé au compte actuel.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte publicitaire. Apparaît dans le chemin de la ressource et constitue généralement un paramètre requis pour toutes les requêtes vers l’Advertiser API, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type: string Example: 18ce54d4x5t
scheduled_tweet_id obligatoire	Référence au Scheduled Tweet concerné par la requête. Type: string Example: 917438609065623552

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/917438609065623552

​

Exemple de réponse

{
  "request": {
    "params": {
      "scheduled_tweet_id": "917438609065623552"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": "917438609065623552",
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

​

POST accounts/:account_id/scheduled_tweets

Crée un Tweet programmé pour l’utilisateur entièrement promouvable du compte (par défaut) ou pour l’utilisateur indiqué dans le paramètre as_user_id.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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
scheduled_at obligatoire	L’heure, exprimée en ISO 8601, à laquelle le Tweet doit être publié (ou mis en ligne). Remarque : les Tweets ne peuvent être programmés qu’à un an au maximum dans le futur. Remarque : les Tweets ne doivent être programmés qu’à la minute près ; les secondes seront ignorées. Type : string Exemple : 2017-12-31T23:59:00Z
as_user_id obligatoire	L’id utilisateur de l’annonceur pour le compte duquel vous publiez le Tweet. L’annonceur doit accorder à votre handle (ou à vos handles) l’accès à son compte publicitaire via ads.x.com. Cette autorisation vous permet d’appeler l’API en utilisant les jetons OAuth de votre propre handle plutôt que ceux de l’annonceur. Type : long Exemple : 756201191646691328
text parfois obligatoire	Le texte de la mise à jour de statut. Obligatoire si aucun media_keys n’est spécifié. Type : string Exemple : just setting up my twttr
card_uri optionnel	Associer une carte au Tweet à l’aide de la valeur card_uri renvoyée par n’importe quelle réponse de cartes, si disponible. Type : string Exemple : card://855591459410511943
media_keys optionnel	Associer des médias au Tweet en spécifiant une liste d’identifiants séparés par des virgules. Inclure jusqu’à 4 images, 1 GIF animé ou 1 vidéo. Remarque : l’actif média doit se trouver dans la Media Library du compte. Type : string Exemple : 13_1153584529292270722
nullcast optionnel	Indique s’il faut créer un Tweet diffusé en nullcast (ou « Promoted-only »). Type : boolean Par défaut : true Valeurs possibles : true, false
name optionnel	Le nom du Tweet programmé. Longueur maximale : 80 caractères. Type : string Exemple : Tweet with name

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?as_user_id=756201191646691328&media_keys=3_917438348871983104&scheduled_at=2018-01-01

​

Exemple de réponse

{
  "request": {
    "params": {
      "media_keys": [
        "3_917438348871983104"
      ],
      "scheduled_at": "2018-01-01T00:00:00Z",
      "as_user_id": 756201191646691328
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": "917438609065623552",
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

Mettre à jour le Tweet planifié spécifié appartenant au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	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
scheduled_tweet_id requis	Référence au Scheduled Tweet concerné par la requête. Type: string Exemple: 870321875435442177
card_uri optionnel	Associez une carte au Tweet en utilisant la valeur card_uri renvoyée par n’importe quelle réponse de cartes, si disponible. Note : Réinitialiser (supprimer) en spécifiant le paramètre sans valeur. Type: string Exemple: card://875146925316386347
media_keys optionnel	Associez des médias au Tweet en indiquant une liste d’identifiants séparés par des virgules. Incluez jusqu’à 4 images, 1 GIF animé ou 1 vidéo. Note : La ressource média doit se trouver dans la Media Library du compte. Note : Réinitialiser (supprimer) en spécifiant le paramètre sans valeur. Type: string Exemple: 13_1153584529292270722
nullcast optionnel	Indique s’il faut créer un Tweet « nullcasted » (ou « Promoted-only »). Type: boolean Valeurs possibles : true, false
scheduled_at optionnel	Heure, au format ISO 8601, à laquelle le Tweet doit être publié (ou mis en ligne). Type: string Exemple: 2017-12-31T23:59:59Z
text optionnel	Texte de la mise à jour de statut. Type: string Exemple: just setting up my twttr
name optionnel	Nom du Scheduled Tweet. Longueur maximale : 80 caractères. Type: string Exemple: Tweet with name

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875057751231037440?text=winter solstice

​

Exemple de réponse

{
  "request": {
    "params": {
      "scheduled_tweet_id": "875057751231037440",
      "text": "solstice d'hiver"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "SCHEDULED",
    "text": "solstice d'hiver",
    "user_id": "756201191646691328",
    "id": "875057751231037440",
    "nullcast": true,
    "created_at": "2017-06-14T18:30:00Z",
    "scheduled_at": "2017-12-21T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T18:30:00Z",
    "tweet_id": null,
    "media_keys": []
  }
}

Supprime définitivement le Tweet programmé spécifié appartenant au compte actuel.

Remarque : Il s’agit d’une suppression irréversible. Par conséquent, il n’est pas possible de récupérer les Tweets programmés supprimés.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_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 spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
scheduled_tweet_id requis	Référence au Tweet programmé avec lequel vous opérez dans la requête. Type : string Exemple : 870321875435442177

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875064008595787776

​

Exemple de réponse

{
  "request": {
    "params": {
      "scheduled_tweet_id": 875064008595787776
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "DELETED",
    "text": "bonjour, monde",
    "user_id": "756201191646691328",
    "id": "875064008595787776",
    "nullcast": true,
    "created_at": "2017-06-14T18:54:52Z",
    "scheduled_at": "2017-06-15T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T19:01:16Z",
    "tweet_id": null,
    "media_keys": []
  }
}

​

Aperçus de Tweets

Exécuter dans Postman

​

GET accounts/:account_id/tweet_previews

Aperçu des Tweets publiés, programmés ou en brouillon.

• Permet d’apercevoir plusieurs Tweets — jusqu’à 200 — dans une seule requête API
• Rendu fidèle et à jour de la mise en page et du style des Tweets
• Prend en charge tous les formats et types de cartes les plus récents
• Renvoie un iframe

​

URL de la ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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 des annonceurs, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
tweet_ids obligatoire	Liste d’identifiants séparés par des virgules. Jusqu’à 200 IDs peuvent être fournis. Remarque : Les IDs doivent correspondre au tweet_type spécifié. Par exemple, si un ID de Tweet planifié est transmis et que tweet_type=PUBLISHED est spécifié, aucun aperçu ne sera retourné pour cet ID. Type : long Exemple : 1122911801354510336,1102836745790316550
tweet_type obligatoire	Le type de Tweet pour les tweet_ids spécifiés. Type : enum Valeurs possibles : DRAFT, PUBLISHED, SCHEDULED

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet_previews?tweet_ids=1122911801354510336,1102836745790316550&tweet_type=PUBLISHED

​

Exemple de réponse

{
  "request": {
    "params": {
      "tweet_ids": [
        "1122911801354510336",
        "1102836745790316550"
      ],
      "tweet_type": "PUBLISHED",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "tweet_id": "1122911801354510336",
      "preview": "<iframe class='tweet-preview' src='https://ton.twimg.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAANVYW2%2FbNhT%2BKwJf59iiZDuSgWLI0suyrUXbZBuGaiAoibbZUKRGUk7TIP99h6Jsy4mdC5CX%2BiUiz%2F0cfueQuUH2ijGLZsENKjSjlpWEwhK9VzI4qXUQpQE%2BnuF4FofBTyH8gijEKRogXqIZxlGUYpyEOJ6MJziM46kjEGM1qNhDBbl5IwSx7JszsuIlU8EVyw23DGhWN7JwPqDZnArDBqjkphb0uhUgmsoFQ7Mv4QDH%2Fw4Qk5Zbzgya3aAlNUtLF%2FD9BSjmusqV6BaNYZpUjlnJ9Zb2xFtgVY0uQCnKmjCMCxosNZu%2FytDS2trMslE2oqU5ojUf2ituLdPDQlUZCjQTwCXVXAmhrjIvzi48T3BSmuBUVbUC214x6PEsLnWSaFYLiEpBqqhtDHHZlJCZA0Sf0fsMbWz7ZTvSIUkD1WaSSFqxNdlJuFw6fceTKdQZp3g6nk5THEdJr7D3iRCU14ROPp4F74sLZuycFi7YHUMIElkVdksVCuoNhQHSOZXBWyhxwU2hBsHpCWoLtfauZKCJ1x3zmbQqcHq4XARUlgHYNSBQa2VZ0T9BvkBMG1KoRsKpO8KwqTmT5c6W4MYd%2Fm7H29xBxMWyCX5rRBDhACezyXQWJVtEtCebruAwwUne0dvYgqj53LCNVssrRr4ruUn8winCJM1Fz%2B0V03zOexv%2BLOzqFgAI8IxJsF4oaTXPG6sg1LvauCEWUmsEBfK%2BXcjqPSHI5ZwLRnJaXC40WHXZEU4ehe0P7eXhFV0w0lauRZEHUW4cgKpFC59Ry2OykV2yavMXZ6N8MawhpIf1khabnXbzUuotrO%2BFvjeWetfYDi8YA3TE4yTGx%2BNJMgnTJJpko9cXvxefT%2BtzIpWuqBh%2BrftePBTZixvLqZTQGbYxPWjHc3tDdzCfjfAYvqbROMY9%2FYLLy8PnxEDHz6kmudIlePEoHyzEYa52KhykAlrunZ%2FtYGFz2ghLOuZD%2B3ekfDPhDnUeun4D2up%2FDTQjYti2eUhlAcG%2BvZkN9jcoJPa6dh1RukZw2zaBTdtRkB0uofVs5GAIFmxL30J9vadZO8jX3SH07ch1oz1bW4x3Yn3UK2N4DkMCYoGxzFfb6KEv137cbppqRwP%2FC6pLR%2BoafTRJpnEaHuPpDFJZKdLOerKd9f4AOqn2%2FOFwPI5DHKZpGOPpJBmnrqU6cpuouxh0hCNHOALCETdHJas1a%2B8OQy5XVMAQG6CcS8jjgsC68Y539olZKm2ZhN7eKr5BXTXOLz6ffXjnxhZkeC25AxQLAMlG32nJ%2Fjz%2F6zVOXO1cQaDypGy0b6WGwVZpnqA4GjsF7o4DcLjipV0%2BQQjGzVZobZyXT5GMSQroPR5HyRiuZfAVJWFP2ZLxxdI%2BQVHqhFZUcnv9xBSWbMUEHCDdv0k5LeualA5Bzy3HQa1dQOpKdlekR5Xuudb0EiPMs31rj3y%2Fq9KqFnx%2B7bGQje5XAhqvyEbmk%2F7FvEmrt6sPrE5Pvw2ruEl%2Bhuvtq8h5BLde17AedeT1OjXBR%2Bg4cxgG%2FWy%2FdKJBkNHqxXO0qmi9L1NDR%2BiZ9zPUwLzr2z97f%2FLujbtxt9TO%2Bg16ZPjtuEDssqny%2FcUCiWz0T56%2F%2B%2FTr6u%2FPX9Xbhf7jezdvOyxjYBygNayOI1hQ0c2I2zvu%2F7COE0H1j%2Bz%2Btx8wgHY0Pnt49aDbPs14zsglu%2B4mcatvo7xedw2w0P%2BGTsAL1pv18No9qTlqHy3Gv89w7LBJmxLeWTu8cBkom6J9xcF8bopLtonJGd6%2BaG4HAWpvDv5VJv2%2FDIKbzSYsrG7Y7e3%2FCm%2FIC8QQAAA%3D'>"
    },
    {
      "tweet_id": "1102836745790316550",
      "preview": "<iframe class='tweet-preview' src='https://ton.twimg.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAAO1YbW%2FbNhD%2BK4K%2Bzo3eZdlAMQQttqZrt6FNEXRVIVASJTOhSIWkHDeB%2F%2FuOomXLb%2BuHdQWGzV8s3T13vCOPz539ZKsHjJU9t57sQmCkcJkheLWvO2y9RcJyI8udzkN%2F7ofWDy58LN%2F1ZvbEJqU99zzXT4J4GkbTmRt4cRS5WpFJJcDFCS3YVR2lmcIrvcgNWmJpLZRq5Tx1UkddFDx16mUU8Lv4UhQAV6JjhQ7LnleISjyxSyJbir70PjKBWI3t%2BSd3En2e2JgpogiW9vzJXiC5UKiG50%2BgkV%2BanNPNSyexyBoN5mwQiUHZ4JIgeHwyGbpumLjh1PcDfxZ6XpSE4wyPtXpnWEkKHcSneOLPBpcZLAEmOtk%2B1zaXF%2BqBNDXk3KSOTkY9ZEtSYp6pRdfkqXPCPdh1qQNWYPFz%2BfHls7v7y6s3dZm%2Fci9u29oeLZb1%2B7pZUv6ja%2B5SO3uOw6kZaEsKHYhSWJhQ9rB41SJWQiUe%2BR2boJY0hcJSVajAqSMVUp2EBI6rLnX6FEGnC%2BpLi3UEC644vEryaOqlz18%2FPMCp6zpebL4F1hgwKQRv7bXZ4a4ZoL5rsPE0GmErojRUNojSDTJODDBIgmMgRULX8cblBjn13UMkQCu4pZ3og16vP6%2F1dincb9e4%2FP8v4%2F9EGfeSf2UZm%2BMirOIaj2SLC03nwMlQcV480RVXdr2AZQ2hlEhdx9MYnC2RIIgp2dd3ThSgwHUSQBKgLTiDCwE1Mdqi1Gna8MQR98pzxfQXZQT61IlDdxXEcC7Rm1fsHl96H8sau%2Fer1xew2I%2FQfJ4HsCmjCP0o%2Fr4Rwo6svAQivLvqXn14mRD%2FD%2BnWuX91NkJv%2Bp1D1GWyghJJnbD56HePt%2FjXG%2FJbVd3cHsR4EBFqW0qKvjxSZ%2FWsaXH94d2bbxhdS1Nn5r17CF7cTMurt6%2Ffh7fJRRN0yRDT5wMyntioLIkOCNHM8NdQ3sDLVAetGQTLQpBWw4wANzkuS5RrAEw7MOE0nGFFHo2on3oM0UveiUK7STvXDQpkLQSunqejXFEp9wjJtgSmgGC84pTyh9SY4muDsS5LaXyBqdH0xJ8J3FKYsHhm6CjTPYTB4HZGafrIMaAftE7bblTnLGGPMGYZQw0e1NpC76X2N41iGEO9mReHcTzzAj8ZtbNjJSRlPNmXv19Zb4vrDd1q4hwvZO%2BRMWgpNxUGqveIWT%2FBuFkQWfCJ9eJyKDUT3f6xXjHFLe2HsNqCJmDBuhIMWsEV8NxomjXngoXMCt4xGIqfeSAUBDr6ngjoT8%2FmG4lZc39gX3TW645avmd5yTyK536yG9hjPXijJdQPgajGfjtVZLyqJN56VaTB2SOU4CCogacx09W4C3uJBanISGBqYd83heEcIsPMNnwiSN4pDqkeeiMyA%2F5hkiJQn5LqHnBoBHtZEYqzHBV3tYBV9e5QbW%2B7%2Fcc%2BiSENqvHhFIP2J4oeA01YLXCz%2FfZSJ68vWlZ%2Fxe%2BJgeUbuFdkSwY7%2FclcDqajPSwsBrcjCJPAg8kiidxZ4kep8%2FL6l%2BLdi%2FZ9xriAVr8Zh45W%2Bfoo9vcXyxFjwAyHJH5mHYM2Cx3ceWD2EJ5iPwy8kX9K2N35OpHQE3IkspyLEqL4Kg5e6HlU%2Fwv1rBZuy1H97H7k4gp1VGUb8Dn5gZUhE6Jvnbm6RgC0et8BGWUS78iDcQU32NCb3N797S0c2izTRLDuSWBLOxx2hzCgnq0dzMQF3ul3V32QCdz%2FzzCwg2voSLPRCdHujm%2FMxreeS0lyaBKQi4Rmu9xlD7zcmiF4S6pD%2Bxxz0Xpi6TNouOFTZv6LsJ62QnjRfXi9%2FhONbe6QHREAAA%3D%3D'>"
    }
  ]
}

​

Tweets

Exécuter dans Postman

​

GET accounts/:account_id/tweets

Récupère les détails du Tweet pour l’utilisateur promouvable complet du compte (par défaut) ou pour l’utilisateur indiqué dans le paramètre user_id. Il peut s’agir de n’importe lequel des utilisateurs promouvables associés au compte.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id obligatoire	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
tweet_type obligatoire	Le type de Tweet pour les tweet_ids spécifiés. Type : enum Valeurs possibles : DRAFT, PUBLISHED, SCHEDULED
count optionnel	Spécifie le nombre d’enregistrements à tenter de récupérer par requête distincte. Type : int 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 : AAAAAFhLRpQLNF-sGBSgAA
include_mentions_and_replies optionnel	Indique s’il faut exclure les mentions et les réponses de la liste des Tweets disponibles. Type : boolean Par défaut : false Valeurs possibles : true, false
name optionnel	Une query optionnelle pour filtrer les Tweets par name. Omettez ce paramètre pour tout récupérer. Longueur maximale : 80 caractères. Note : effectue une correspondance de préfixe insensible à la casse. Type : string Exemple : dtc
timeline_type optionnel	Indique s’il faut renvoyer des Tweets nullcast (alias « Promoted-only »), des Tweets organiques ou les deux. Type : enum Par défaut : NULLCAST Valeurs possibles : ALL, NULLCAST, ORGANIC
trim_user optionnel	Indique s’il faut exclure l’objet utilisateur dans la réponse du Tweet. Lorsqu’il est activé, la seule partie de l’objet utilisateur renvoyée est l’id utilisateur de l’auteur du Tweet. Type : boolean Par défaut : false Valeurs possibles : true, false
tweet_ids optionnel	Une liste d’identifiants séparés par des virgules. Jusqu’à 200 id peuvent être fournis. Note : les id doivent correspondre au tweet_type spécifié. Par exemple, si un id de Tweet planifié est fourni, alors le tweet_type doit être SCHEDULED pour que ce Tweet soit renvoyé dans la réponse. Type : long Exemple : 1122911801354510336,1102836745790316550
user_id optionnel	Spécifie l’utilisateur auquel restreindre les Tweets. Par défaut, l’utilisateur promouvable FULL du compte lorsqu’il n’est pas défini. Type : long Exemple : 756201191646691328

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets?tweet_ids=1166476031668015104&tweet_type=PUBLISHED&trim_user=true

​

Exemple de réponse

{
  "request": {
    "params": {
      "tweet_ids": [
        "1166476031668015104"
      ],
      "tweet_type": "PUBLISHED",
      "trim_user": true,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "coordinates": null,
      "retweeted": false,
      "name": null,
      "source": "<a href="https://ads-api.x.com" rel="nofollow">X Ads API Internal Test App</a>",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        9
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "1166476031668015104",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "id": 1166476031668015104,
      "in_reply_to_status_id": null,
      "conversation_settings": "EVERYONE",
      "nullcast": true,
      "created_at": "Tue Aug 27 22:22:12 +0000 2019",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "hello, v6",
      "lang": "es",
      "contributors": [
        2417045708
      ],
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "id": 756201191646691328,
        "id_str": "756201191646691328"
      },
      "tweet_id": "1166476031668015104"
    }
  ]
}

​

POST accounts/:account_id/tweet

Créez un Tweet pour l’utilisateur promouvable « FULL » du compte (par défaut) ou pour l’utilisateur indiqué dans le paramètre as_user_id. La création de Tweets « nullcastés » (par défaut) et organiques est prise en charge. Les Tweets nullcastés n’apparaissent pas dans la timeline publique et ne sont pas diffusés aux abonnés. Les deux types peuvent être utilisés dans des campagnes.

Si l’utilisateur authentifié n’est pas l’utilisateur promouvable « FULL » de ce compte, vérifiez s’il est autorisé à Tweeter au nom de cet utilisateur en effectuant une requête vers l’endpoint GET accounts/:account_id/authenticated_user_access. Une permission TWEET_COMPOSER indique que l’utilisateur peut utiliser cet endpoint pour créer des Tweets nullcastés au nom de l’utilisateur promouvable « FULL ».

Lorsque vous utilisez l’endpoint upload.x.com pour les médias, transmettez la même valeur user_id pour le paramètre additional_owners que la valeur as_user_id transmise à cet endpoint.

​

URL de ressource

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

​

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 Annonceurs, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
as_user_id requis	L’id utilisateur de l’annonceur pour le compte duquel vous publiez le Tweet. L’annonceur doit accorder à votre handle (ou à vos handles) l’accès à son compte publicitaire via ads.x.com. Cette autorisation vous permet d’appeler l’API en utilisant les jetons OAuth de votre propre handle plutôt que ceux de l’annonceur. Type : long Exemple : 756201191646691328
text parfois requis	Le texte de votre mise à jour de statut. Requis si aucun media_keys n’est spécifié. Type : string Exemple : hello, world
card_uri optionnel	Associez une Card au Tweet en utilisant la valeur card_uri renvoyée par toute réponse de Cards, si disponible. Type : string Exemple : card://853503245793641682
conversation_settings optionnel	Choisissez qui peut répondre à ce Tweet. Toute personne mentionnée peut toujours répondre. Remarque : ce champ ne sera pas renvoyé dans la réponse à la requête POST, mais le sera lors d’une requête GET. Remarque : ce paramètre ne fonctionne que dans Ads API v8 et versions ultérieures. Type : enum Valeur par défaut : EVERYONE Valeurs possibles : EVERYONE, FOLLOWING, MENTIONED_USERS
media_keys optionnel	Associez des médias au Tweet en indiquant une liste d’identifiants séparés par des virgules. Jusqu’à 4 images, 1 GIF animé ou 1 vidéo. Type : string Exemple : 13_1153584529292270722
name optionnel	Le nom du Tweet. Longueur maximale : 80 caractères. Type : string Exemple : Tweet with name
nullcast optionnel	Indique s’il faut créer un Tweet nullcast (ou « Promoted-only »). Remarque : les Tweets organiques (nullcast=false) ne peuvent être créés que pour l’utilisateur authentifié. Type : boolean Valeur par défaut : true Valeurs possibles : true, false
trim_user optionnel	Indique s’il faut exclure l’objet utilisateur dans la réponse du Tweet. Lorsque cette option est activée, la seule partie de l’objet utilisateur renvoyée est l’id utilisateur de l’auteur du Tweet. Type : boolean Valeur par défaut : false Valeurs possibles : true, false
tweet_mode optionnel	Indique si la réponse doit être en mode compatibility ou extended. Voir ce document pour plus d’informations. Type : string Valeurs possibles : compat, extended
video_cta optionnel	L’appel à l’action (CTA) pour la vidéo. Type : enum Valeurs possibles : VISIT_SITE, WATCH_NOW
video_cta_value optionnel	La valeur du CTA correspondant sur la vidéo. Type : string Exemple : https://dev.x.com
video_description optionnel	La description qui apparaît sous la vidéo. Longueur maximale : 200 caractères. Type : string Exemple : Intégrez-vous à la plateforme publicitaire X
video_title optionnel	Le titre (accroche) qui apparaît sous la vidéo. Longueur maximale : 70 caractères. Type : string Exemple : X Ads API

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet?text=hello, world&as_user_id=756201191646691328&trim_user=true

​

Exemple de réponse

{
  "data": {
    "created_at": "Sat Jun 24 05:08:30 +0000 2017",
    "id": 878479925472251906,
    "id_str": "878479925472251906",
    "text": "bonjour le monde",
    "name": null,
    "truncated": false,
    "entities": {
      "hashtags": [],
      "symbols": [],
      "user_mentions": [],
      "urls": []
    },
    "source": "<a href='"https://ads-api.x.com"' rel='"nofollow"'>Application de test interne X Ads API</a>",
    "in_reply_to_status_id": null,
    "in_reply_to_status_id_str": null,
    "in_reply_to_user_id": null,
    "in_reply_to_user_id_str": null,
    "in_reply_to_screen_name": null,
    "user": {
      "id": 756201191646691328,
      "id_str": "756201191646691328"
    },
    "geo": null,
    "coordinates": null,
    "place": null,
    "contributors": null,
    "retweet_count": 0,
    "favorite_count": 0,
    "favorited": false,
    "retweeted": false,
    "scopes": {
      "followers": false
    },
    "lang": "en"
  },
  "request": {
    "params": {
      "text": "bonjour le monde",
      "trim_user": true,
      "as_user_id": 756201191646691328,
      "account_id": "18ce54d4x5t"
    }
  }
}

Mettre à jour le champ name du Tweet spécifié appartenant au compte actuel.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/tweets/:tweet_id/name

​

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 Advertiser, à l’exception de GET accounts. Le compte spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
tweet_id requis	Référence au Tweet concerné par la requête. Type : long Exemple : 994747471329873920
name optionnel	Nom du Tweet. Longueur maximale : 80 caractères. Type : string Exemple : Tweet with name

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets/994747471329873920/name?name=new Tweet name

​

Exemple de réponse

{
  "request": {
    "params": {
      "tweet_id": 994747471329873920,
      "name": "nouveau nom de Tweet",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
      "coordinates": null,
      "retweeted": false,
      "name": "nouveau nom de Tweet",
      "conversation_settings": "EVERYONE",
      "source": "<a href="https://ads-api.x.com" rel="nofollow">Application de test interne X Ads API</a>",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        5
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "994747471329873920",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "scheduled_status": null,
      "id": 994747471329873920,
      "in_reply_to_status_id": null,
      "nullcast": true,
      "created_at": "Wed Jan 01 00:00:00 +0000 2020",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "bonjour",
      "lang": "en",
      "contributors": null,
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "utc_offset": null,
        "name": "Tushar Bhushan",
        "friends_count": 1065,
        "screen_name": "imit8me",
        "location": "San Francisco, CA",
        "protected": false,
        "url": "https://tushdante.github.io",
        "profile_image_url": "http://pbs.twimg.com/profile_images/618551153131786241/g-MIydXB_normal.jpg",
        "profile_background_color": "C0DEED",
        "profile_use_background_image": true,
        "is_translator": false,
        "geo_enabled": true,
        "description": "Sorcier Open Source / Ingénieur Partenaire @twitter / Voyageur de l'Espace | Ancien évangéliste @sendgrid @keen_io",
        "profile_link_color": "1DA1F2",
        "id_str": "3271358660",
        "listed_count": 31,
        "default_profile_image": false,
        "followers_count": 407,
        "profile_image_url_https": "https://pbs.twimg.com/profile_images/618551153131786241/g-MIydXB_normal.jpg",
        "profile_sidebar_border_color": "C0DEED",
        "profile_background_image_url": "http://abs.twimg.com/images/themes/theme1/bg.png",
        "favourites_count": 5993,
        "following": null,
        "default_profile": true,
        "withheld_in_countries": [],
        "id": 3271358660,
        "profile_background_tile": false,
        "contributors_enabled": false,
        "follow_request_sent": null,
        "created_at": "Tue Jul 07 22:34:58 +0000 2015",
        "profile_sidebar_fill_color": "DDEEF6",
        "translator_type": "regular",
        "lang": null,
        "profile_text_color": "333333",
        "notifications": null,
        "verified": false,
        "time_zone": null,
        "profile_banner_url": "https://pbs.twimg.com/profile_banners/3271358660/1474853576",
        "statuses_count": 500,
        "profile_background_image_url_https": "https://abs.twimg.com/images/themes/theme1/bg.png",
        "is_translation_enabled": false
      },
      "tweet_id": "994747471329873920"
    }
}

​

Cartes de conversation vidéo

Exécuter dans Postman

Remarque : Pour associer une carte à un Tweet, utilisez le paramètre card_uri avec les endpoints POST accounts/:account_id/tweet, POST statuses/update ou POST accounts/:account_id/scheduled_tweets.

​

GET accounts/:account_id/cards/video_conversation

Récupère les détails de certaines ou de toutes les cartes de conversation vidéo associées au compte en cours.

​

URL de ressource

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

​

Paramètres

Nom	Description
account_id requis	L’identifiant du compte à effet de levier. Figure dans le chemin de la ressource et est 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
card_ids optionnel	Limite la réponse aux Video Conversation Cards souhaitées en indiquant une liste d’identifiants séparés par des virgules. Jusqu’à 200 IDs peuvent être fournis. Type : string Exemple : 5a86h
count optionnel	Spécifie le nombre d’enregistrements à tenter de récupérer par requête. Type : int 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
q optionnel	Une query facultative pour restreindre les cartes par name. Omettez ce paramètre pour tout récupérer. Longueur maximale : 80 caractères. Remarque : effectue une correspondance de préfixe insensible à la casse. Type : string Exemple : night sky
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	Inclut les résultats supprimés dans votre requête. Type : boolean Par défaut : false Valeurs possibles : true, false
with_total_count optionnel	Inclut l’attribut de réponse total_count. Remarque : ce paramètre et cursor sont mutuellement exclusifs. Remarque : les requêtes incluant total_count auront des limites de taux plus strictes, actuellement fixées à 200 par 15 minutes. Type : boolean Par défaut : false Valeurs possibles : true, false

​

Exemple de requête

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?card_ids=5a86h

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_ids": [
        "5a86h"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "carte de conversation vidéo",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Créez-le",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "id": "5a86h",
      "video_width": "16",
      "first_cta_tweet": "X Ads API",
      "created_at": "2018-01-30T17:53:04Z",
      "card_uri": "card://958397665015775232",
      "title": "Développeurs",
      "updated_at": "2018-01-30T17:53:04Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "deleted": false,
      "card_type": "VIDEO_CONVERSATION"
    }
  ]
}

Récupère une carte de conversation vidéo spécifique associée au compte actuel.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id

​

Paramètres

Nom	Description
account_id obligatoire	L’identifiant du compte à effet de levier. 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
card_id obligatoire	Référence à la Video Conversation Card utilisée dans la requête. Type: string Exemple: 4i0ya
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/cards/video_conversation/5a86h

​

Exemple de réponse

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_id": "5a86h",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "carte de conversation vidéo",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Créez-le",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "X Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Développeurs",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  }
}

​

POST accounts/:account_id/cards/video_conversation

Crée une nouvelle carte de conversation vidéo associée au compte spécifié.

Consultez Uploading Media pour des informations utiles sur le chargement d’images vers nos endpoints.

​

URL de ressource

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

​

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
first_cta requis	Le hashtag d’appel à l’action (CTA) pour la première option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #APIs
first_cta_tweet requis	Le texte du Tweet à utiliser lorsque le premier CTA est cliqué. Type : string Exemple : Ads API
media_key requis	La clé média d’une vidéo à utiliser dans cette carte. Remarque : La vidéo doit se trouver dans la Bibliothèque multimédia du compte. Remarque : Un ratio d’aspect de 16:9 est requis. Type : string Exemple : 13_1168079965037467209
name requis	Le nom de la carte. Type : string Exemple : carte de conversation vidéo
thank_you_text requis	Le texte à afficher après que le CTA ait été cliqué. Longueur maximale : 23 caractères. Type : string Exemple : Construisez-le
title parfois requis	Le titre de la carte, qui apparaît sous la vidéo et au-dessus des CTA. Longueur maximale : 23 caractères. Type : string Remarque : Requis si second_cta n’est pas défini. Exemple : Développeurs
second_cta parfois requis	Le hashtag d’appel à l’action (CTA) pour la deuxième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Remarque : Requis si title n’est pas défini. Exemple : #ShareAgain
second_cta_tweet parfois requis	Le texte du Tweet à utiliser lorsque le deuxième CTA est cliqué. Remarque : Requis si second_cta est défini. Type : string Exemple : I Heart @AdsAPI Again
poster_media_key optionnel	La clé média d’une image d’affiche à utiliser dans cette carte. Si non spécifiée, la première image sera utilisée. Remarque : La vidéo doit se trouver dans la Bibliothèque multimédia du compte. Type : long Exemple : 3_882726458191298561
third_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la troisième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareMore
third_cta_tweet parfois requis	Le texte du Tweet à utiliser lorsque le troisième CTA est cliqué. Type : string Remarque : Requis si third_cta est défini. Exemple : I Heart @TwitterDev
fourth_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la quatrième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareExtra
fourth_cta_tweet parfois requis	Le texte du Tweet à utiliser lorsque le quatrième CTA est cliqué. Type : string Remarque : Requis si fourth_cta est défini. Exemple : I Heart @TwitterDev Again
thank_you_url optionnel	L’URL à afficher avec le texte de remerciement. Type : string Exemple : https://example.com/thankyou
unlocked_image_media_key optionnel	Une media_key d’une image qui sera utilisée dans le scénario de déverrouillage instantané. Il s’agit d’un champ en écriture seule. Dans la réponse, l’API fournira une URL X pour cette image. Remarque : L’image doit se trouver dans la bibliothèque multimédia du compte. Type : string Exemple : 3_883112887618682880
unlocked_video_media_key optionnel	L’identifiant d’une vidéo de l’endpoint GET accounts/:account_id/media_library qui sera utilisée dans le scénario de déverrouillage instantané. Type : string Exemple : 13_867520357225418752

​

Exemple de requête

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?first_cta=#APIs&first_cta_tweet=Ads API&name=video conversation card&thank_you_text=Build it&title=Developers&media_key=13_958388276489895936

​

Exemple de réponse

{
  "data": {
    "name": "carte de conversation vidéo",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Créez-le",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "X Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Développeurs",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "video_poster_height": "9",
      "name": "carte de conversation vidéo",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Créez-le",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "account_id": "18ce54d4x5t",
      "video_width": "16",
      "first_cta_tweet": "X Ads API",
      "title": "Développeurs",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "video_poster_width": "16",
      "card_type": "VIDEO_CONVERSATION"
    }
  }
}

Met à jour la carte de conversation vidéo spécifiée appartenant au compte en cours.

Consultez Téléversement de médias pour des informations utiles sur le téléversement d’images vers nos endpoints.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id

​

Paramètres

Nom	Description
account_id requis	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
card_id requis	Une référence à la carte de conversation vidéo que vous utilisez dans la requête. Type : string Exemple : 5a86h
first_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la première option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #APIs
first_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le premier CTA est cliqué. Type : string Exemple : X Ads API
second_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la deuxième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Remarque : Requis si title n’est pas défini. Exemple : #ShareAgain
second_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le deuxième CTA est cliqué. Remarque : Requis si second_cta est défini. Type : string Exemple : I Heart @AdsAPI Again
third_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la troisième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareMore
third_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le troisième CTA est cliqué. Type : string Remarque : Requis si third_cta est défini. Exemple : I Heart @TwitterDev
fourth_cta optionnel	Le hashtag d’appel à l’action (CTA) pour la quatrième option. Longueur maximale : 20 caractères (sans compter le #). Type : string Exemple : #ShareExtra
fourth_cta_tweet optionnel	Le texte du Tweet à utiliser lorsque le quatrième CTA est cliqué. Type : string Remarque : Requis si fourth_cta est défini. Exemple : I Heart @TwitterDev Again
media_key optionnel	La clé média pour une vidéo à utiliser dans cette carte. Remarque : La vidéo doit se trouver dans la Bibliothèque multimédia du compte. Remarque : Un ratio d’aspect de 16:9 est requis. Type : string Exemple : 13_1168079965037467209
name optionnel	Le nom de la carte. Type : string Exemple : developers card
poster_media_key optionnel	La clé média pour une image d’affiche à utiliser dans cette carte. Si non spécifiée, la première image sera utilisée. Remarque : La vidéo doit se trouver dans la Bibliothèque multimédia du compte. Type : long Exemple : 3_882726458191298561
thank_you_text optionnel	Le texte à afficher après que le CTA ait été cliqué. Longueur maximale : 23 caractères. Type : string Exemple : Build it
thank_you_url optionnel	L’URL à afficher avec le texte de remerciement. Type : string Exemple : https://example.com/thankyou
title optionnel	Le titre de la carte, qui apparaît sous la vidéo et au-dessus des CTA. Longueur maximale : 23 caractères. Type : string Remarque : Requis si second_cta n’est pas défini. Exemple : Start a conversation
unlocked_image_media_key optionnel	Une media_key d’une image qui sera utilisée dans le scénario de déverrouillage instantané. Il s’agit d’un champ en écriture seule. Dans la réponse, l’API fournira une URL X pour cette image. Remarque : L’image doit se trouver dans la bibliothèque multimédia du compte. Type : string Exemple : 3_883112887618682880
unlocked_video_media_key optionnel	L’identifiant d’une vidéo de l’endpoint GET accounts/:account_id/media_library qui sera utilisée dans le scénario de déverrouillage instantané. Type : string Exemple : 13_867520357225418752

​

Exemple de requête

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/5a86h?name=developers card

​

Exemple de réponse

{
  "data": {
    "name": "carte développeurs",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Créez-le",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Développeurs",
    "updated_at": "2018-01-30T18:02:15Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_CONVERSATION",
      "card_id": "5a86h",
      "name": "carte développeurs"
    }
  }
}

Supprime définitivement la carte de conversation vidéo spécifiée appartenant au compte actuel.

Remarque : il s’agit d’une suppression irréversible. Par conséquent, il n’est pas possible de récupérer les cartes supprimées.

​

URL de ressource

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id

​

Paramètres

Nom	Description
account_id obligatoire	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 spécifié doit être associé à l’utilisateur authentifié. Type : string Exemple : 18ce54d4x5t
card_id obligatoire	Référence à la carte de conversation vidéo utilisée dans la requête. Type : string Exemple : 4i0ya

​

Exemple de requête

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/4i0ya

​

Exemple de réponse

{
  "data": {
    "name": "carte de conversation vidéo",
    "id": "4i0ya",
    "created_at": "2017-07-07T01:36:39Z",
    "updated_at": "2017-08-23T13:29:13Z",
    "deleted": true,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0ya",
      "card_type": "video_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}