API pour les annonceurs
Que pouvez-vous promouvoir ?
- Les annonces sponsorisées sont des publicités classiques achetées par des annonceurs qui souhaitent toucher un groupe d’utilisateurs plus large ou susciter l’engagement de leurs abonnés existants.
- Les annonces sponsorisées sont clairement identifiées comme sponsorisées lorsqu’un annonceur paie pour leur diffusion sur X. À tous les autres égards, les annonces sponsorisées se comportent comme des publicités classiques et peuvent être repartagées, recevoir des réponses, être aimées (likées), etc. Elles suivent des règles de diffusion classiques et sont créées à l’aide de POST statuses/update.
- Les Tweets « promoted-only », créés via POST accounts/:account_id/tweet, peuvent être utilisés dans des campagnes de Tweets sponsorisés, mais ne seront pas diffusés auprès des abonnés ni affichés sur le fil public. Pour récupérer la liste des Tweets « promoted-only » pour un certain compte, utilisez GET accounts/:account_id/scoped_timeline.
- Les comptes sponsorisés font partie de Who to Follow (Qui suivre), qui suggère des comptes que les utilisateurs ne suivent pas encore et qu’ils peuvent trouver intéressants. Les comptes sponsorisés permettent de présenter une gamme encore plus large de comptes susceptibles de leur plaire.
- Les comptes sponsorisés pour la Timeline associent un Tweet sponsorisé à une campagne de compte sponsorisé et s’affichent dans les timelines des utilisateurs.
Campagnes et groupes d’annonces (line items)
Analytics
L’API X Ads propose un ensemble d’endpoints d’analytics pour suivre et optimiser les performances des publicités. Veuillez consulter Analytics et Analytics Best Practices pour plus d’informations. Pour la métrique de facturation, les données peuvent ne pas être finalisées avant trois jours après l’événement. Avant ce délai, les données doivent être considérées comme provisoires. La valeur finale facturable sera toujours inférieure au montant provisoire. La valeur facturable est corrigée pour tenir compte du spam et du trafic de faible qualité associé. Consultez Timezones pour d’autres considérations liées au temps.Création d’une campagne - étape par étape
-t pour tracer l’appel, ce qui revient à peu près à l’option -v de cURL.
Pour cet exemple, nous allons créer une campagne de Promoted Ads ciblée par mot-clé.
- Récupérer l’id du compte.
- Récupérez l’identifiant de l’instrument de financement.
- Créez une campagne et associez-la à l’instrument de financement.
- Créez un élément de campagne (line item) associé à la campagne.
- Créez un profil de ciblage associé à l’élément de campagne.
- Enfin, réactivez l’élément de campagne.
Campagnes basées sur un objectif
objective approprié sur les line items.
Le paramètre utilisé dans les endpoints d’écriture de line item, et renvoyé dans les endpoints de lecture, est objective. Ce champ peut actuellement prendre les valeurs suivantes :
APP_ENGAGEMENTSAPP_INSTALLSFOLLOWERSENGAGEMENTSREACHVIDEO_VIEWSPREROLL_VIEWSWEBSITE_CLICKS
APP_ENGAGEMENTS, le CPAC ou le CPI pour APP_INSTALLS, le CPLC pour WEBSITE_CLICKS, le CPF pour FOLLOWERS, le CPE pour ENGAGEMENTS et le CPM pour REACH.
Les campagnes de promotion d’applications mobiles doivent obligatoirement contenir l’objectif APP_ENGAGEMENTS ou APP_INSTALLS.
Remarque : Les line items avec des objectifs différents ne sont pas autorisés au sein d’une même campagne.
Instruments de financement
funding_instruments d’un compte, consultez GET accounts/:account_id/funding_instruments et GET accounts/:account_id/funding_instruments/:funding_instrument_id pour les détails d’un instrument spécifique.
Attributs de l’instrument de financement
account_id, id de l’instrument de financement, type de l’instrument de financement, description et io_header (ID d’en‑tête d’ordre d’insertion). Notez qu’un même io_header peut être associé à plusieurs instruments de financement.
Capacité de financement : able_to_fund et reasons_not_able_to_fund.
Temps : created_at, updated_at, start_time et end_time représentés par une chaîne de caractères, au format « %Y-%m-%dT%l:%M:%S%z ».
Statut booléen : paused, deleted et cancelled (true ou false).
Financier : currency (format ISO-4217), credit_limit_local_micro, credit_remaining_local_micro et funded_amount_local_micro. La valeur d’une devise est représentée en micros. Pour l’USD, 5,50 $ est encodé comme 5.50*1e6, soit 5 500 000. Pour représenter une « valeur entière », vous devez multiplier la valeur locale en micros par 1e6 (1_000_000) pour toutes les devises.
Détails des attributs
credit_limit_local_micro n’est valide que pour les instruments de financement de type CREDIT_CARD ou CREDIT_LINE et représente la limite de crédit de cet instrument.
funded_amount_local_micro n’est valide que pour les instruments de financement de type INSERTION_ORDER et représente le budget alloué.
credit_remaining_local_micro est valide pour les instruments de financement de type CREDIT_LINE et AGENCY_CREDIT_LINE. Il représente credit_limit_local_micro moins le montant déjà dépensé au titre de cet instrument de financement. Il ne représente pas la différence entre funded_amount_local_micro et le montant dépensé. Nous établissons une distinction entre la limite de crédit et le montant financé, car ils correspondent à différentes méthodes de financement sous-jacentes et à différents accords de dépenses conclus avec les annonceurs.
Types de moyens de financement
CREDIT_LINE).
Ciblage
Options de ciblage par emplacement
- X Search : Ciblage par âge, Appareils, Événements, Sexe, Types de mots-clés (tous), Langue, Lieux, Activation du réseau, Opérateurs réseau, Plateforme, Version de la plateforme, Audiences personnalisées, Wi-Fi uniquement
- X Timeline : Ciblage par âge, Appareils, Événements, Abonnés de, Similaire aux abonnés de, Sexe, Centres d’intérêt, Langue, Lieux, Activation du réseau, Opérateurs réseau, Types de mots-clés non exacts, Types d’audience partenaire, Plateforme, Version de la plateforme, Types de reciblage, Audiences personnalisées, Types de ciblage TV, Wi-Fi uniquement
- X Profiles & Tweet Details : Ciblage par âge, Appareils, Événements, Abonnés de, Similaire aux abonnés de, Sexe, Centres d’intérêt, Langue, Lieux, Activation du réseau, Opérateurs réseau, Types de mots-clés non exacts, Types d’audience partenaire, Plateforme, Version de la plateforme, Types de reciblage, Audiences personnalisées, Types de ciblage TV, Wi-Fi uniquement
Comprendre les types de ciblage
NETWORK_OPERATOR depuis GET targeting_criteria/network_operators.
Ciblage des nouveaux appareils mobiles : Atteignez les utilisateurs en fonction de la date à laquelle ils ont accédé pour la première fois à X via leur appareil, en utilisant le type de ciblage NETWORK_ACTIVATION_DURATION avec un operator_type de LT pour « moins de » et GTE pour « supérieur ou égal ».
Plateformes, Versions de plateforme, Appareils et Wifi uniquement : Permettent de cibler les appareils mobiles selon différents axes. Les plateformes constituent un type de ciblage de haut niveau qui peut viser de larges catégories de téléphones. Des valeurs d’exemple sont iOS et Android. Les appareils vous permettent de cibler les utilisateurs de modèles d’appareils mobiles spécifiques, par exemple iPhone 5s, Nexus 4 ou Samsung Galaxy Note. Les versions de plateforme permettent de cibler les utilisateurs de versions spécifiques de systèmes d’exploitation mobiles, jusqu’à la version de correctif. Des exemples incluent iOS 7.1 et Android 4.4. Wifi uniquement vous permet de cibler uniquement les utilisateurs qui utilisent leurs appareils sur un réseau WiFi ; si ce paramètre n’est pas défini, les utilisateurs utilisant la connexion opérateur ainsi que le WiFi seront ciblés.
- Les utilisateurs peuvent cibler des plateformes et des appareils s’il n’y a pas de chevauchement. Je peux cibler Blackberry comme plateforme et iPad Air comme appareil simultanément.
- Les utilisateurs peuvent cibler des appareils et des versions d’OS simultanément. Je peux cibler iPad Air et iOS >= 7.0.
- Les utilisateurs ne peuvent pas cibler des plateformes plus larges que les appareils. Je ne peux pas cibler iOS et iPad Air.
TV_SHOW. Utilisez les points de terminaison GET targeting_criteria/tv_markets et GET targeting_criteria/tv_shows pour déterminer les émissions TV disponibles.
Tweet Engager Retargeting
Le Tweet engager retargeting permet aux annonceurs de cibler, sur plusieurs appareils, des audiences qui ont déjà été exposées à leurs Tweets sponsorisés ou organiques sur X, ou qui ont interagi avec eux. Avec ce ciblage, les annonceurs peuvent relancer les personnes qui ont vu ou interagi avec le contenu d’un annonceur sur X et qui sont les plus susceptibles d’interagir de nouveau ou de convertir après des messages ou des offres ultérieurs. Les utilisateurs deviennent éligibles au ciblage quelques minutes après l’exposition ou l’engagement et le restent jusqu’à 90 jours après pour les engagements et 30 jours pour les expositions.
Types de ciblage Tweet Engager :
ENGAGEMENT_TYPE, qui accepte soitIMPRESSION, soitENGAGEMENTcomme valeur de ciblage. Cela précise si vous souhaitez cibler des utilisateurs exposés (IMPRESSION) ou des utilisateurs engagés (ENGAGEMENT).CAMPAIGN_ENGAGEMENTutilise un id de campagne comme valeur de ciblage. Les utilisateurs qui ont interagi avec cette campagne ou y ont été exposés (en fonction deENGAGEMENT_TYPE) sont ceux qui seront ciblés.USER_ENGAGEMENT, qui utilise l’id d’utilisateur promu comme valeur de ciblage pour cibler les utilisateurs qui ont été exposés au contenu organique d’un annonceur ou qui ont interagi avec celui‑ci (en fonction deENGAGEMENT_TYPE). Il doit s’agir de l’id d’utilisateur promu associé au compte Ads.
ENGAGEMENT_TYPE est requis en plus d’au moins une valeur CAMPAIGN_ENGAGEMENT ou USER_ENGAGEMENT valide. Les deux types de ciblage Tweet engager peuvent être présents et plusieurs campagnes peuvent être ciblées sur un même line item.
Video Viewer Targeting : le ciblage Video viewer s’appuie sur le ciblage Tweet engager pour permettre aux annonceurs de cibler les audiences qui ont déjà regardé une partie ou la totalité d’une vidéo sur X. Les annonceurs peuvent cibler des vidéos organiques, des vidéos sponsorisées, ou les deux. Les vidéos sponsorisées ne sont pas limitées aux campagnes ou line items avec objectif de vues de vidéo.
Types de ciblage Video Viewer :
VIDEO_VIEWpour les utilisateurs qui ont cliqué pour lancer la vidéo ou ont regardé 3 secondes de lecture automatiqueVIDEO_VIEW_PARTIALpour les utilisateurs qui ont regardé 50 % de la vidéoVIDEO_VIEW_COMPLETEpour les utilisateurs qui ont regardé au moins 95 % de la vidéo
ENGAGEMENT_TYPE est utilisé :
CAMPAIGN_ENGAGEMENTutilise un id de campagne comme valeur de ciblage. Les utilisateurs qui ont regardé une vidéo (en fonction deENGAGEMENT_TYPE) dans le cadre de cette campagne sont ceux qui seront ciblés.USER_ENGAGEMENT, qui utilise l’id d’utilisateur promu comme valeur de ciblage pour cibler les utilisateurs qui ont regardé une vidéo (en fonction deENGAGEMENT_TYPE) dans le contenu organique d’un annonceur. Il doit s’agir de l’id d’utilisateur promu associé au compte Ads.
- Broad (valeur par défaut) : fait correspondre tous les mots, indépendamment de l’ordre. Insensible à la casse, aux pluriels ou au temps. Sera automatiquement étendu lorsque possible (par exemple, « car repair » correspondra également à « automobile fix »). Si vous souhaitez cibler sans extension, vous devez ajouter un signe + devant les mots‑clés, comme « +boat +jet ». L’utilisation de mots‑clés sans le + correspond par défaut à Broad Match.
- Unordered (obsolète) : fait correspondre tous les mots, indépendamment de l’ordre. Insensible à la casse, aux pluriels ou au temps.
- Phrase : fait correspondre exactement la chaîne de mots‑clés, d’autres mots‑clés peuvent être présents.
- Exact : fait correspondre exactement la chaîne de mots‑clés, et aucune autre.
- Negative : évite de faire correspondre les recherches qui incluent tous ces mots‑clés quelque part dans la requête, quel que soit l’ordre dans lequel ils sont écrits, même si d’autres mots sont présents.
- Negative Phrase : évite de faire correspondre les recherches qui incluent exactement cette chaîne de mots‑clés quelque part dans la requête, même si d’autres mots sont présents.
- Negative Exact : évite de faire correspondre les recherches qui correspondent exactement à ces mots‑clés et ne contiennent aucun autre mot.
Combinaisons de critères de ciblage
Les critères de ciblage seront combinés pour votre groupe de publicités de la façon suivante :
- Les types de ciblage « principaux » seront combinés par ∪ (c.-à-d. placés dans une union logique).
- Les autres types de ciblage seront combinés avec AND.
- Les types identiques seront combinés avec OR.
- les utilisateurs de X aux États-Unis, en Angleterre et au Canada (Lieu)
- qui sont des femmes (Genre)
- issus d’une liste d’audiences personnalisées (type « principal »)
- avec des mots-clés (type « principal »)
Exemples supplémentaires
- Sélectionnez le genre et la zone géographique mais aucun critère principal : (Homme) ET (US OU GB)
- Sélectionnez le genre, la zone géographique, les centres d’intérêt : (Femme) ET (CA) ET (Informatique OU Technologie OU Startups)
- Sélectionnez le genre, la zone géographique, les centres d’intérêt, les Tailored Audiences et les mots-clés : (Homme) ET (GB) ET (Voitures ∪ Tailored Audiences for CRM ∪ autocross)
Rythme de dépense du budget
standard_delivery sur false afin de passer à un rythme de diffusion accéléré (voir GET accounts/:account_id/campaigns).
Remarques
- Le « jour » est défini par le fuseau horaire du compte annonceur X (par exemple America/Los_Angeles).
- Les premiers résultats indiquent que la diffusion standard améliore le eCPE/CPF pour les annonceurs, avec une couverture plus régulière tout au long de la journée.
Enchères ciblées
Stratégie d’enchère
goal équivalent. Vous trouverez plus d’informations dans l’annonce ici.
Par exemple :
Enchères cibles
Avec les enchères cibles, vous pouvez définir un coût cible que vous souhaitez payer et la plateforme publicitaire X Ads optimisera les performances de votre campagne tout en restant proche ou en dessous de ce coût cible. Cette fonctionnalité vous donne la flexibilité d’atteindre les utilisateurs particulièrement susceptibles d’effectuer l’action souhaitée (comme un clic sur un lien, un lead ou un abonnement) tout en gardant le contrôle de vos coûts. Il s’agit d’une fonctionnalité puissante pour les annonceurs qui souhaitent davantage d’options pour la configuration et l’optimisation de leurs campagnes (y compris les options d’enchères). Pour les line items avec des objectifs de campagne compatibles, nous avons introduit un nouveau mécanisme de tarification du montant de l’enchère qui vous permet de définir un coût cible que vous souhaitez payer. Notre plateforme publicitaire enchérit dynamiquement en votre nom pour vous aider à générer davantage de résultats, tout en s’efforçant de maintenir votre coût moyen dans une fourchette de 20 % autour de la cible que vous avez spécifiée. Le paramètrebid_strategy sur les line items peut être défini sur la valeur TARGET pour activer les enchères cibles sur des objectifs de campagne pertinents, tels que :
WEBSITE_CLICKSWEBSITE_CONVERSIONSAPP_INSTALLSAPP_ENGAGEMENTSREACH
Exigences de ciblage par pays et d’affichage
Russie
Instruments de financement gérés par le partenaire
Configuration initiale du partenaire
- Le partenaire doit partager sa clé publique PGP/GPG. Une clé secrète partagée doit être échangée entre le partenaire Ads API et X. Elle sera utilisée pour vérifier les données lors du processus d’intégration.
- Le
app_idou leconsumer_secretpour l’App X qui sera utilisée pour l’accès à l’Ads API. Vous pouvez afficher et modifier vos Apps X existantes via le tableau de bord des apps si vous êtes connecté à votre compte X sur developer.x.com. Si vous devez créer une App X, vous devrez disposer d’un compte développeur approuvé. X autorise une app pour la production + sandbox et une app facultative pour un accès sandbox uniquement. L’App X doit être créée sur un handle X d’entreprise contrôlé par le partenaire.
Parcours d’onboarding de l’annonceur
- L’utilisateur démarre le parcours d’onboarding sur le site web du partenaire et saisit le handle qu’il souhaite intégrer.
- Le partenaire redirige l’utilisateur vers une URL sur ads.x.com avec une charge utile signée. Cette charge utile contient l’
app_idAPI du partenaire, leuser_idX du handle X à intégrer, ainsi qu’une URL de rappel et d’autres champs documentés ci‑dessous. - Il est demandé à l’utilisateur de se connecter à ads.x.com en utilisant la page de connexion standard de x.com.
- Une fois l’utilisateur connecté, le processus d’onboarding est lancé. Cette étape inclut l’examen des annonces, la validation du compte et d’autres vérifications.
- Lorsque toutes les tâches d’onboarding sont terminées, l’utilisateur est redirigé vers l’URL de rappel fournie par le partenaire Ads API, avec une charge utile qui indique la réussite ou l’échec. Cela inclut le processus d’autorisation en 3 étapes.
Charge utile de redirection d’intégration
Charge utile de l’URL de rappel
Pour garantir que l’URL de rappel n’est valide que pour le X
user_id auquel le processus de lien de compte est destiné, le X user_id doit être concaténé au secret partagé (en utilisant &) lors de la signature de la requête.
Signature de la requête et des URL de rappel
/link_managed_account et l’URL de rappel sont valides, les requêtes doivent être signées à la source et vérifiées par le destinataire avant que celui‑ci n’agisse en conséquence. Signer la requête avec un secret partagé entre X et le partenaire gestionnaire garantit que chaque partie n’accepte que les requêtes envoyées par la contrepartie autorisée.
L’algorithme de génération de la signature est similaire à celui utilisé par OAuth.
Créez une chaîne de base de la signature comme suit :
- Convertissez la méthode HTTP en majuscules et définissez la chaîne de base égale à cette valeur.
- Ajoutez le caractère « & » à la chaîne de base.
- Encodez en pourcentage l’URL (sans paramètres) et ajoutez‑la à la chaîne de base.
- Ajoutez le caractère « & » à la chaîne de base.
- Ajoutez la chaîne de requête encodée en pourcentage, construite comme suit :
- Encodez en pourcentage chaque clé et chaque valeur qui sera signée.
- Triez la liste des paramètres par ordre alphabétique selon la clé.
- Pour chaque paire clé/valeur (et avec primary_promotable_user_id pour l’URL de redirection du partenaire) :
- Ajoutez la clé encodée en pourcentage à la chaîne de requête.
- Ajoutez le caractère « = » à la chaîne de base.
- Ajoutez la valeur encodée en pourcentage à la chaîne de requête.
- Séparez les paires clé=valeur encodées en pourcentage avec le caractère « & ».
- Utilisez l’algorithme HMAC-SHA1, en utilisant comme clé le secret partagé échangé précédemment et comme valeur la chaîne de base pour générer la signature.
- Encodez en Base64 la sortie de l’étape 2, supprimez le caractère de nouvelle ligne final, encodez en pourcentage la signature générée à l’étape 3 et ajoutez‑la à l’URL dans un paramètre de signature.
Exemples de signature
KBxQMMSpKRrtg9aw3qxK4fTXvUc=
Cette signature est ensuite ajoutée (encodée en pourcent) à la fin de l’URL d’origine dans le paramètre signature (étape 4) :
https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D
Signature d’une URL de redirection du partenaire (rappel de requête de liaison de compte) L’URL à signer, en supposant une requête GET :
https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF
Cette URL comporte les paramètres suivants :
account_id = ABC, funding_instrument_id = DEF et status = OK
La chaîne de base composée de la méthode HTTP et de l’URL sans paramètres, étapes a - d, est la suivante :
GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“
La chaîne de requête, produite par les sous-étapes de e, est la suivante :
account_id=ABC&funding_instrument_id=DEF&status=OK
La chaîne de requête encodée en pourcent est la suivante :
account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK
La chaîne de base complète, combinant les étapes a - d et e :
GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK
En utilisant l’algorithme hmac-sha1, nous allons signer cette chaîne avec le mot « secret » et l’id de l’utilisateur X pour lequel la requête de liaison d’origine a été effectuée, 1 (promotable_user_id = 1 ci-dessus) comme clé, « secret&1 ».
Le résultat est encodé en Base64 et présenté sans le « \n » final (étapes 2 et 3) : jDSHDkHJIFXpPLVxtA3a9d4bPjM=
Cette signature est ensuite ajoutée, après encodage en pourcentage, à la fin de l’URL d’origine dans le paramètre signature (étape 4) :
https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D
L’algorithme de signature doit pouvoir être réutilisé avec plusieurs clés. Cela permet d’utiliser plusieurs clés partagées et de procéder à leur rotation périodique.
Création de partner_managed_funding_instrument
Appels répétés du flux d’onboarding / actualisation du jeton
promotable_user_id, que le compte publicitaire associé est trouvé et que tout est en ordre, l’utilisateur sera redirigé vers l’URL de rappel, et le partenaire pourra initier le flux OAuth pour obtenir un jeton d’accès.
Flux d’erreur sans redirection
Mises à jour en continu du PMFI
Emplacements
placements. Les valeurs possibles sont :
ALL_ON_TWITTERPUBLISHER_NETWORKTWITTER_PROFILETWITTER_SEARCHTWITTER_TIMELINESPOTLIGHTTREND
product_type et l’objective de l’élément de campagne déterminent quels emplacements sont autorisés. L’endpoint GET line_items/placements permet de récupérer les options d’emplacement valides pour chaque type de produit.
Par ailleurs, le tableau suivant répertorie les combinaisons valides d’emplacement et d’objectif.
Remarque : il n’est pas possible de spécifier uniquement l’emplacement
TWITTER_PROFILE.
Remarque : TWITTER_SEARCH nécessite un ciblage par mots-clés.
Remarque : l’objectif REACH doit inclure l’emplacement TWITTER_TIMELINE. Il peut comporter ALL_ON_TWITTER, n’importe quelle combinaison d’emplacements qui inclut TWITTER_TIMELINE, ou TWITTER_TIMELINE seul.
FAQ sur les groupes d’annonces
Qu’est-ce qu’un Ad Group ?
Comment créer un groupe de publicités ?
Pourquoi devrions-nous ajouter la prise en charge des Ad Groups ?
Quel est le lien entre le budget de l’élément de campagne (line item) et le budget de la campagne dans une campagne Ad Groups ?
Les groupes d’annonces offrent-ils de meilleures performances qu’un seul élément de campagne ?
Guides
Objectif de vues pour les pré-roll vidéo
PREROLL_VIEWS sur l’API Ads. De manière générale, ces campagnes sont réparties en deux types : « Curated Categories » et « Content Categories » (appelées « Standard Categories » dans l’interface utilisateur Ads).
Points de terminaison requis
- Chunked media upload (pour le téléversement de vidéos)
- POST accounts/:account_id/media_library (pour l’association de la vidéo au compte publicitaire)
- POST accounts/:account_id/campaigns (créer une campagne)
- GET content_categories (pour obtenir la correspondance entre les catégories de contenu et les catégories IAB)
- GET accounts/:account_id/curated_categories
- GET publishers
- POST accounts/:account_id/line_item_curated_categories
- POST accounts/:account_id/line_items (créer un groupe de publicités)
- POST accounts/:account_id/media_creatives (pour associer la vidéo au groupe de publicités)
- POST accounts/:account_id/preroll_call_to_action (pour définir l’appel à l’action (CTA) et l’URL de redirection)
- POST batch/accounts/:account_id/targeting_criteria (ciblage)
Étapes
Téléverser la vidéo
Importer le média vidéo
media_category=amplify_video lors de l’appel initial INIT en utilisant cet endpoint. Vous téléverserez la vidéo en plusieurs segments. Une fois que la réponse STATUS renvoie un state égal à succeeded, vous pouvez poursuivre avec les étapes suivantes. Vous trouverez davantage d’informations sur le téléversement de médias avec l’endpoint segmenté dans notre page Présentation de la vidéo sponsorisée.
Ajouter la vidéo au compte publicitaire
STATUS est succeeded, vous utiliserez le media_key renvoyé par cet endpoint pour ajouter la vidéo à la bibliothèque de médias de l’annonceur, en utilisant l’endpoint POST accounts/:account_id/media_library.
Configurer la campagne
Création de campagne
objective VIDEO_VIEWS_PREROLL et le product_type MEDIA. Le paramètre categories doit également être renseigné avec les catégories d’activité de l’annonceur appropriées.
Création de line item
categories sur la valeur “Science & Education”, l’ensemble des iab_categories, c’est‑à‑dire "IAB5", "IAB15", doit être défini pour le line item, comme suit :
Sélection de l’éditeur
Catégories sélectionnées
- Le line item doit cibler le pays approprié en fonction du country_code de la catégorie sélectionnée.
- L’endpoint POST line_item_curated_categories doit être utilisé pour associer le line item à un curated_category_id spécifique.
Catégories de contenu
Remarque : L’ensemble des iab_categories dans la réponse GET curated_categories doit être ciblé via l’endpoint de critères de ciblage. Dans le cas contraire, une erreur de validation sera renvoyée.
Associer le média du compte (vidéo) à l’élément de campagne
Définir l’appel à l’action (CTA) et l’URL de destination
VIDEO_VIEWS_PREROLL n’utilise pas de Tweets sponsorisés ni de Cards. À la place, le créatif vidéo est associé à votre groupe d’annonces (line item) et les informations de CTA sont associées à une entité preroll_call_to_action. L’endpoint POST accounts/:account_id/preroll_call_to_action vous permet de contrôler le bouton d’appel à l’action (CTA) et l’URL de destination.
Définir les critères de ciblage
CONTENT_PUBLISHER_USER en ciblage négatif pour empêcher que la publicité soit associée à un ensemble d’utilisateurs. Indiquez le user_id X ou le publisher_user_id correspondant aux comptes à exclure.
L’endpoint GET publishers peut être utilisé pour récupérer la liste des user_id à exclure pour les catégories de contenu (Content Categories). Le publisher_user_id retourné dans la réponse de GET curated_categories peut être utilisé pour récupérer une liste d’exclusion similaire pour les catégories organisées (Curated Categories).
Remarque : Un maximum de 5 publisher_user_id peuvent être exclus pour les catégories organisées (Curated Categories) et 50 user_id pour les catégories de contenu (Content Categories).
Lancer la campagne
Analytics
VIDEO_VIEWS_PREROLL sont disponibles via nos points de terminaison de statistiques.
Ciblage par mots-clés dans les fils
Comment ça fonctionne ?
targeting_type sur unordered_keywords ou phrase_keywords pour les line items (éléments de campagne).
Guide de démarrage rapide
- Créez un nouvel élément de campagne dont le placement inclut soit
ALL_ON_TWITTERsoitTWITTER_TIMELINE. POST accounts/:account_id/line_items - Créez les critères de ciblage pour ce nouvel élément de campagne en utilisant
BROAD_KEYWORDet en définissant la ou les valeurs de votre mot-clé. POST accounts/:account_id/targeting_criteria - Vous pouvez mettre à jour les mots-clés avec PUT accounts/:account_id/targeting_criteria
- Une fois votre campagne lancée, récupérez les statistiques de votre élément de campagne pour mesurer ses performances. GET stats/accounts/:account_id
Référence de l’API
Comptes
https://ads-api.x.com/12/accounts
Parameters
https://ads-api.x.com/12/accounts/:account_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t
Exemple de réponse
https://ads-api-sandbox.x.com/12/accounts
Paramètres
Aucun
Exemple de requête
POST https://ads-api-sandbox.x.com/12/accounts
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id
Paramètres
Exemple de requête
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY
Exemple de réponse
https://ads-api-sandbox.x.com/12/accounts/:account_id
Paramètres
Requête d’exemple
DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh
Réponse d’exemple
Apps du compte
https://ads-api.x.com/12/accounts/:account_id/account_apps
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps
Example Response
Historique du compte
entity_id spécifié dans la requête.
Remarque : Cet endpoint est actuellement en bêta et nécessite un ajout à une liste d’autorisation (allowlisting).
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/account_history
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1
Exemple de réponse
Catégories d’activité des annonceurs
categories d’activité commerciales valides pour les groupes de publicités (line_items) afin de décrire la marque d’un annonceur aux éditeurs.
Remarque : ces catégories s’appliquent uniquement aux line_items avec l’objectif PREROLL_VIEWS et sont distinctes des content_categories utilisées pour les critères de ciblage.
Chaque advertiser_business_categories représente un ensemble de catégories IAB. Lors de la création d’un groupe de publicités avec l’objectif PREROLL_VIEWS, une ou deux advertiser_business_categories doivent être définies pour ce groupe. Cela peut être fait en définissant, pour le paramètre de requête categories de l’endpoint line item, l’ensemble des iab_categories correspondantes disponibles via cet endpoint.
Des informations supplémentaires sont disponibles dans le guide sur l’objectif Video Views Preroll
URL de la ressource
https://ads-api.x.com/12/advertiser_business_categories
Paramètres
Aucun paramètre de requête
Exemple de requête
GET https://ads-api.x.com/12/advertiser_business_categories
Exemple de réponse
Estimation de l’audience
Déterminer la taille approximative de l’audience de vos campagnes.
Content-Type: application/json.
Remarque : vous devez spécifier au moins un critère de ciblage principal ; vous pouvez consulter la liste de tous les critères de ciblage principaux sur notre page de ciblage des campagnes.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/audience_estimate
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate
Accès de l’utilisateur authentifié
access_token) en lien avec le compte publicitaire spécifié. Ces autorisations correspondent à celles exposées sur ads.x.com.
Les valeurs possibles incluent :
ACCOUNT_ADMIN: Accès complet pour modifier les campagnes et consulter les statistiques, y compris la possibilité d’ajouter ou de supprimer des utilisateurs et de modifier les paramètresAD_MANAGER: Accès complet pour modifier les campagnes et consulter les statistiques, mais ne peut pas ajouter ou supprimer des utilisateurs ni modifier les paramètresCREATIVE_MANAGER: Accès pour modifier les créations publicitaires et afficher les aperçus, mais aucun accès pour créer ou modifier des campagnesCAMPAIGN_ANALYST: Accès pour afficher les campagnes et consulter les statistiques, mais aucun accès pour créer ou modifier des campagnesANALYST(« Organic Analyst » sur ads.x.com) : Accès pour consulter les analyses organiques et les informations sur l’audience, mais aucun accès pour créer, modifier ou afficher des campagnesPARTNER_AUDIENCE_MANAGER: Accès réservé à l’API pour consulter et modifier les audiences des partenaires de données, mais aucun accès aux campagnes, créations ou autres types d’audiences.
TWEET_COMPOSER indique que l’utilisateur authentifié peut créer des Tweets nullcastés (ou « Promoted-only ») au nom de l’annonceur. Ceci n’est disponible que pour les utilisateurs disposant des accès ACCOUNT_ADMIN, AD_MANAGER ou CREATIVE_MANAGER.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access
Parameters
Aucun
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access
Example Response
Règles d’enchères
https://ads-api.x.com/12/bidding_rules
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/bidding_rules?currency=USD
Exemple de réponse
Campagnes
https://ads-api.x.com/12/accounts/:account_id/campaigns
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2
Example Response
https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/campaigns
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false
Exemple de réponse
- La taille maximale actuelle d’un lot est de 40.
- Tous les paramètres sont envoyés dans le corps de la requête et un
Content-Typedeapplication/jsonest requis. - Les requêtes par lot échouent ou réussissent ensemble en tant que groupe et toutes les réponses de l’API, qu’il s’agisse d’erreur ou de succès, préservent l’ordre des éléments de la requête initiale.
- Les erreurs au niveau de la requête (par ex. taille maximale du lot dépassée) sont indiquées dans la réponse sous l’objet
errors. - Les erreurs au niveau de l’élément (par ex. paramètre de campagne requis manquant) sont indiquées dans la réponse sous l’objet
operation_errors.
https://ads-api.x.com/12/batch/accounts/:account_id/campaigns
Parameters
Example Request
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns
https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
Parameters
Example Request
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000
Example Response
https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m
Exemple de réponse
Catégories de contenu
categories de contenu valides à définir comme targeting_criteria pour un line item.
Chaque content_category correspond à une ou plusieurs catégories IAB. Pour ce faire, définissez targeting_type sur IAB_CATEGORY sur le endpoint batch targeting_critera afin d’inclure l’ensemble des iab_categories correspondantes renvoyées par la requête content_categories. Le non‑respect de cette étape entraînera une erreur de validation.
Les informations éditeur pour chacune de ces catégories de contenu peuvent être récupérées via le endpoint GET publishers.
Des informations supplémentaires sont disponibles dans le guide sur l’objectif pré-roll vues de vidéo.
URL de la ressource
https://ads-api.x.com/12/content_categories
Paramètres
Aucun paramètre de requête
Exemple de requête
GET https://ads-api.x.com/12/content_categories
Exemple de réponse
Catégories sélectionnées
country_codes fournis.
Chaque curated_category n’est disponible que dans certains pays, indiqués par les country_codes dans la réponse.
Des informations supplémentaires sont disponibles dans le Guide sur l’objectif Video Views Pre-roll.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/curated_categories
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US
Exemple de réponse
curated_category_id spécifique
Chaque curated_category n’est disponible que dans certains pays, spécifiés par les country_codes dans la réponse.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o
Exemple de réponse
Fonctionnalités
https://ads-api.x.com/12/accounts/:account_id/features
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features
Exemple de réponse
https://ads-api-sandbox.x.com/12/accounts/:account_id/features
Paramètres
Exemple de requête
POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING
Exemple de réponse
https://ads-api-sandbox.x.com/12/accounts/:account_id/features
Paramètres
Requête d’exemple
DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE
Réponse d’exemple
Instruments de financement
https://ads-api.x.com/12/accounts/:account_id/funding_instruments
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi
Example Response
https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments
Paramètres
Exemple de requête
POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000
Exemple de réponse
https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id
Parameters
Example Request
DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82
Example Response
Catégories IAB
categories d’applications valides pour les groupes d’annonces (line_items).
URL de la ressource
https://ads-api.x.com/12/iab_categories
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/iab_categories?count=2
Exemple de réponse
Éléments de campagne
https://ads-api.x.com/12/accounts/:account_id/line_items
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx
Exemple de réponse
product_type et le même objective.
Lorsque vous utilisez le type de produit PROMOTED_ACCOUNT, associer un Tweet au line_item ajoutera des emplacements dans le fil mobile en plus de l’emplacement PROMOTED_ACCOUNT standard.
Le fait de définir android_app_store_identifier ou ios_app_store_identifier ajoutera automatiquement les critères de ciblage pour l’élément de campagne correspondant à l’application mobile promue ; par exemple, fournir ios_app_store_identifier ajouterait le critère de ciblage PLATFORM (critères de ciblage) pour iOS.
Remarque : la limite est de 100 éléments de campagne par campagne et de 256 éléments de campagne actifs pour l’ensemble des campagnes.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/line_items
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15
Exemple de réponse
- La taille maximale actuelle d’un lot est de 40.
- Tous les paramètres sont envoyés dans le corps de la requête et un
Content-Typedeapplication/jsonest requis. - Les requêtes par lot échouent ou réussissent ensemble en tant que groupe et toutes les réponses de l’API, qu’il s’agisse d’erreurs ou de succès, préservent l’ordre des éléments de la requête initiale.
- Les erreurs au niveau de la requête (par exemple, taille maximale du lot dépassée) sont indiquées dans la réponse sous l’objet
errors. - Les erreurs au niveau d’un élément (par exemple, paramètre de line item requis manquant) sont indiquées dans la réponse sous l’objet
operation_errors.
https://ads-api.x.com/12/batch/accounts/:account_id/line_items
Parameters
Example Request
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Paramètres
Exemple de requête
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000
Exemple de réponse
with_deleted=true est spécifié dans la requête. Ces promoted_tweets ne sont toutefois pas réellement supprimés ("deleted": false dans la réponse). Nous n’effectuons pas de suppressions en cascade.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix
Exemple de réponse
Catégories sélectionnées pour les éléments de campagne
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Parameters
Example Request
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g
Example Response
https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq
Exemple de réponse
Emplacements des éléments de campagne
placement et de product_type.
Resource URL
https://ads-api.x.com/12/line_items/placements
Parameters
Example Request
GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT
Example Response
Créations média
https://ads-api.x.com/12/accounts/:account_id/media_creatives
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3
Example Response
https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
Example Response
creative_type de l’account media est PREROLL) ou des publicités image (telles que BANNER ou INTERSTITIAL) sur la Twitter Audience Platform.
Remarque : pour ajouter des ressources média à la ressource Account Media, utilisez l’endpoint POST accounts/:account_id/media_library.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/media_creatives
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
Exemple de réponse
Comptes sponsorisés
Récupérer les détails de certains ou de tous les comptes sponsorisés associés à un ou plusieurs éléments de campagne (line items) du compte actuel. Utilisez GET users/lookup pour obtenir les données des comptes utilisateur identifiés paruser_id dans la réponse.
Un code HTTP 400 sera renvoyé si aucun des éléments de campagne spécifiés n’est configuré pour contenir des comptes sponsorisés.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2
Example Response
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
Example Response
user_id) à l’élément de campagne (line item) spécifié.
Si l’élément de campagne spécifié n’est pas configuré pour être associé à des comptes sponsorisés (Promoted Accounts), une erreur HTTP 400 INCOMPATIBLE_LINE_ITEM sera renvoyée. Si l’utilisateur spécifié n’est pas éligible à la promotion, une erreur HTTP 400 sera renvoyée et aucun utilisateur ne sera promu. Si l’utilisateur fourni est déjà promu, la requête sera ignorée.
Pour plus d’informations sur les Promoted Accounts, consultez notre page de gestion de campagnes.
Remarque : il n’est pas possible de mettre à jour (PUT) des entités de comptes promus.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id
Parameters
Example Request
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
Example Response
Tweets sponsorisés
tweet_id pour chaque objet promoted_tweets.
Remarque : lorsque les éléments de ligne (line items) parents sont supprimés, les promoted_tweets ne sont renvoyés que si with_deleted=true est spécifié dans la requête. Ces promoted_tweets ne sont toutefois pas réellement supprimés ("deleted": false dans la réponse).
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo
Exemple de réponse
with_deleted=true est spécifié dans la requête. Ces promoted_tweets ne sont toutefois pas réellement supprimés ("deleted": false dans la réponse).
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo
Exemple de réponse
PROMOTED_ACCOUNT, le fait d’associer un Tweet au line_item ajoutera des emplacements dans le fil (timeline) sur mobile en plus de l’emplacement PROMOTED_ACCOUNT standard.
Remarque : il n’est pas possible de mettre à jour (PUT) des entités de Tweets promus.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384
Exemple de réponse
promoted_tweets supprimée sera indiquée comme « Paused » dans l’interface ads.x.com. De même, le fait de la mettre en « pause » depuis l’interface dissociera le Tweet de son élément de campagne.
URL de ressource
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5
Exemple de réponse
Utilisateurs pouvant être promus
FULL, soit RETWEETS_ONLY. Cela détermine le type de contenu que le compte est autorisé à promouvoir. Les annonceurs doivent obtenir l’autorisation de promouvoir le contenu d’un autre utilisateur et contacter X pour que cet utilisateur soit ajouté à votre compte en tant qu’utilisateur promouvable RETWEETS_ONLY.
À condition que les autorisations soient correctement définies, vous pouvez effectuer des requêtes vers les endpoints de produits promus qui font directement référence à l’ID du Tweet que vous souhaitez promouvoir. Vous pouvez utiliser l’endpoint POST accounts/:account_id/promoted-tweets pour promouvoir des Tweets publiés et l’endpoint POST accounts/:account_id/scheduled-promoted-tweets pour promouvoir les Tweets programmés d’un autre compte Twitter Ads.
Vous n’êtes pas obligé de retweeter le Tweet cible. Lorsque vous faites la promotion d’un Tweet avec cette approche, le tweet_id renvoyé sera différent de l’ID du Tweet fourni. En coulisses, le Tweet est retweeté comme un Tweet « nullcasted », puis promu. Le tweet_id renvoyé correspond à ce nouveau Tweet.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/promotable_users
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s
Exemple de réponse
FULL, soit RETWEETS_ONLY. Cela détermine le type de contenu que le compte est autorisé à promouvoir.
Les annonceurs doivent obtenir l’autorisation de promouvoir le contenu d’un autre utilisateur. À condition que les autorisations soient correctement définies, vous pouvez envoyer des requêtes aux endpoints de produits promus qui font directement référence à l’ID du Tweet que vous souhaitez promouvoir.
Vous n’êtes pas obligé de retweeter le Tweet cible. Lorsque vous faites la promotion d’un Tweet avec cette approche, le tweet_id renvoyé sera différent de l’ID du Tweet fourni. En coulisses, le Tweet est retweeté en tant que Tweet nullcasté, puis promu. Le tweet_id renvoyé correspond à ce nouveau Tweet.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s
Exemple de réponse
Éditeurs
https://ads-api.x.com/12/publishers
Paramètres
Aucun paramètre de requête
Exemple de requête
GET https://ads-api.x.com/12/publishers
Exemple de réponse
Recommandations
https://ads-api.x.com/5/accounts/:account_id/recommendations
Paramètres
Exemple de requête
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations
Exemple de réponse
https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w
Exemple de réponse
Promoted Tweets programmés
https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq
Example Response
https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992
Exemple de réponse
scheduled_promoted_tweets ne peuvent être supprimés qu’avant l’heure scheduled_at du Tweet programmé.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl
Exemple de réponse
Critères de ciblage
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria
Paramètres
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t
Example Response
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y
Example Response
targeting_value correspondant à des types de ciblage spécifiques. Nous vous recommandons d’actualiser toutes les données chaque semaine afin de vous assurer que vous utilisez l’ensemble le plus récent de valeurs de types de ciblage. Nous modifions les valeurs et les critères de ciblage disponibles de temps à autre ; bien que la majorité ne change pas souvent, certains oui. Il n’y a aucune garantie que ces valeurs ne changeront pas.
Utilisez les types de ciblage BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD ou UNORDERED_KEYWORD avec les mots-clés spécifiés dans targeting_value. Excluez des mots-clés en utilisant le paramètre de requête operator_type défini sur NE. Consultez les types de mots-clés de ciblage pour une description détaillée de chaque type.
Remarque : il n’est possible de cibler qu’un seul segment d’âge par élément de campagne.
Remarque : pour cibler une Custom Audience, cette audience doit être ciblable. C’est-à-dire que targerable doit être égal à true.
Remarque : lorsque vous utilisez le type de ciblage TV_SHOW, il doit y avoir au moins un critère de ciblage LOCATION sur l’élément de campagne avant de définir le ciblage TV_SHOW, et tous les LOCATION doivent se trouver dans la même zone géographique que le TV_SHOW ciblé.
URL de la ressource
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology
Exemple de réponse
- La taille maximale actuelle d’un lot est de 500.
- Tous les paramètres sont envoyés dans le corps de la requête et un
Content-Typedeapplication/jsonest requis. - Les requêtes par lot échouent ou réussissent ensemble en tant que groupe et toutes les réponses de l’API, en cas d’erreur comme de succès, conservent l’ordre des éléments de la requête initiale.
- Les erreurs au niveau de la requête (par exemple, taille de lot maximale dépassée) apparaissent dans la réponse sous l’objet
errors. - Les erreurs au niveau de l’élément (par exemple, paramètre de critère de ciblage requis manquant) apparaissent dans la réponse sous l’objet
operation_errors.
https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria
Paramètres
Exemple de requête
POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6
Exemple de réponse
Options de ciblage
- Catégories de l’App Store
- Conversation
- Appareils
- Événements
- Centres d’intérêt
- Langues
- Lieux
- Opérateurs de réseau
- Versions de plateforme
- Plateformes
- Marchés TV
- Émissions TV
https://ads-api.x.com/12/targeting_criteria/app_store_categories
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS
Exemple de réponse
https://ads-api.x.com/12/targeting_criteria/conversations
Parameters
Example Request
GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2
Example Response
https://ads-api.x.com/12/targeting_criteria/devices
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone
Exemple de réponse
start_time et end_time des événements pour cet endpoint sont représentées en UTC±00:00, indépendamment de la langue et du fuseau horaire de l’événement. Il convient de garder cette conception à l’esprit lors de l’interrogation et de l’utilisation des valeurs start_time et end_time des événements. Par exemple, la fête de l’Indépendance aux États‑Unis est représentée comme start_time=2017-07-04T00:00:00Z et end_time=2017-07-05T00:00:00Z en UTC±00:00, ce qui évite ainsi le problème de l’existence de cette fête sur plusieurs fuseaux horaires au sein des États‑Unis.
Resource URL
https://ads-api.x.com/12/targeting_criteria/events
Parameters
Example Request
GET https://ads-api.x.com/12/targeting_criteria/events?count=1
Example Response
https://ads-api.x.com/12/targeting_criteria/interests
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/interests?q=books
Exemple de réponse
https://ads-api.x.com/12/targeting_criteria/languages
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/languages?q=english
Exemple de réponse
CITIES avec le paramètre de requête location_type.
Pour cibler des Designated Market Areas (DMA), utilisez l’énumération METROS.
Resource URL
https://ads-api.x.com/12/targeting_criteria/locations
Parameters
Example Request
GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles
Example Response
https://ads-api.x.com/12/targeting_criteria/network_operators
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US
Exemple de réponse
https://ads-api.x.com/12/targeting_criteria/platform_versions
Parameters
Example Request
GET https://ads-api.x.com/12/targeting_criteria/platform_versions
Example Response
https://ads-api.x.com/12/targeting_criteria/platforms
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/platforms
Exemple de réponse
https://ads-api.x.com/12/targeting_criteria/tv_markets
Paramètres
Aucun
Exemple de requête
GET https://ads-api.x.com/12/targeting_criteria/tv_markets
Exemple de réponse
estimated_users de 1000.
Remarque : les options de ciblage par chaîne TV et par genre ne sont plus prises en charge.
Resource URL
https://ads-api.x.com/12/targeting_criteria/tv_shows
Parameters
Example Request
GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1
Example Response
Suggestions de ciblage
https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"
Example Response
Paramètres fiscaux
https://ads-api.x.com/12/accounts/:account_id/tax_settings
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/tax_settings
Paramètres
Exemple de requête
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/tracking_tags
Parameters
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82
Example Response
https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/tracking_tags
Parameters
Example Request
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Response
https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
Paramètres
Exemple de requête
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
Paramètres
Exemple de requête
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
Exemple de réponse
Paramètres utilisateur
https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id
Paramètres
Exemple de requête
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328
Exemple de réponse
https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id
Paramètres
Exemple de requête
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"
Exemple de réponse