Skip to main content
Un Ad est l’unité créative individuelle diffusée par un groupe d’annonces. Il contient le texte, les ressources créatives et l’URL de destination d’une annonce. Utilisez l’API Ads pour lister les annonces d’un compte, créer des annonces dans des groupes d’annonces, récupérer ou mettre à jour les détails créatifs, supprimer les annonces qui doivent cesser d’être diffusées, et mettre en pause ou reprendre la diffusion.

Endpoints

Attributs

string
requis
Identifiant unique de l’annonce, préfixé par ad_.
object
requis
La campagne publicitaire à laquelle appartient cette annonce.

Propriétés

string
requis
L’id de l’entité référencée.
object
requis
Le groupe d’annonces auquel appartient cette annonce.

Propriétés

string
requis
L’id de l’entité référencée.
number
requis
Valeur en USD attribuée aux événements d’ajout au panier. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Événements d’ajout au panier attribués par le pixel Whop, au dernier clic.
string | null
requis
Le bouton d’appel à l’action affiché sur l’annonce.Options disponibles : learn_more, shop_now, sign_up, subscribe, get_started, book_now, apply_now, contact_us, download, order_now, buy_now, get_quote, message_page, whatsapp_message, instagram_message, call_now, get_directions, send_updates, get_offer, watch_more, listen_now, play_game, open_link, no_button, get_offer_view, get_event_tickets, see_menu, request_time, event_rsvp, see_details, view_instagram_profile, donate_now, see_more, visit_site
number
requis
Clics divisés par les impressions, entre 0 et 1.
number
requis
Le nombre de clics.
number
requis
Valeur en USD attribuée aux événements d’inscription terminée. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Événements d’inscription terminée attribués par le pixel Whop, au dernier clic.
number
requis
Valeur en USD attribuée aux événements de contact. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Événements de contact attribués par le pixel Whop, au dernier clic.
object
requis
La vérification du contenu de cette annonce par Whop : si elle est terminée, les réseaux publicitaires pour lesquels l’annonce est recommandée, et les règles de contenu qu’elle enfreint.

Propriétés

object[]
requis
Indique si chaque réseau peut diffuser l’annonce. Vide jusqu’à la fin de la vérification.

Propriétés

Indique si l’annonce respecte la politique de contenu de Whop et celle de ce réseau.
string
requis
Le réseau. whop correspond à la politique de contenu propre à Whop, que tous les autres réseaux exigent également.Options disponibles : whop, meta, tiktok, google
string
requis
reviewed une fois la vérification du contenu par Whop terminée, in_review pendant son exécution, not_reviewed lorsqu’elle n’a jamais eu lieu.Options disponibles : reviewed, in_review, not_reviewed
object[]
requis
Toutes les règles que la vérification a identifiées comme enfreintes par l’annonce, sur n’importe quel réseau. Vide lorsqu’elle n’en enfreint aucune ou que la vérification n’est pas terminée.

Propriétés

string
requis
Les éléments de preuve enregistrés par la vérification pour cette règle.
string
requis
La règle que la vérification du contenu par Whop a identifiée comme enfreinte par l’annonce.
number | null
requis
Dépenses divisées par les événements d’ajout au panier attribués ; null lorsqu’ils ne sont pas l’objectif et qu’aucun n’est attribué.
number
requis
Dépenses divisées par les clics ; 0 en l’absence de clics.
number | null
requis
Dépenses divisées par les événements d’inscription terminée attribués ; null lorsqu’ils ne sont pas l’objectif et qu’aucun n’est attribué.
number | null
requis
Dépenses divisées par les événements de contact attribués ; null lorsque les contacts ne sont pas l’objectif et qu’aucun n’est attribué.
number | null
requis
Dépenses divisées par les leads attribués ; null lorsque les leads ne sont pas un objectif et qu’aucun n’est attribué.
number
requis
Dépenses pour 1 000 impressions ; 0 en l’absence d’impressions.
number | null
requis
Dépenses divisées par les achats attribués ; null lorsque les achats ne sont pas un objectif et qu’aucun n’est attribué.
number | null
requis
Dépenses divisées par les résultats attribués par le pixel Whop ; null lorsque rien d’attribuable par Whop n’est optimisé.
number | null
requis
Dépenses divisées par les événements de prise de rendez-vous attribués ; null lorsque les rendez-vous ne sont pas l’objectif et qu’aucun n’est attribué.
number | null
requis
Dépenses divisées par les événements de soumission de candidature attribués ; null lorsqu’ils ne sont pas l’objectif et qu’aucun n’est attribué.
number | null
requis
Dépenses divisées par les clics uniques ; null en l’absence de clics uniques.
number | null
requis
Dépenses divisées par les événements de consultation de contenu attribués ; null lorsqu’ils ne sont pas l’objectif et qu’aucun n’est attribué.
string
requis
Date de création de l’annonce, sous forme d’horodatage ISO 8601.
object[]
requis
Les ressources créatives utilisées par cette annonce. La ressource d’origine a un format null ; les entrées square, vertical et horizontal sont des variantes propres à un emplacement. Une annonce carrousel renvoie une entrée de format null par pièce jointe, dans l’ordre.

Propriétés

string
requis
L’id de fichier de la pièce jointe créative.
object | null
requis
La fenêtre de recadrage enregistrée pour cette création, en pixels de l’image source. Null pour la ressource d’origine ou pour un format qui n’a pas été recadré.

Propriétés

number
requis
Hauteur de la fenêtre de recadrage en pixels source.
number
requis
Largeur de la fenêtre de recadrage en pixels source.
number
requis
Bord gauche de la fenêtre de recadrage en pixels source.
number
requis
Bord supérieur de la fenêtre de recadrage en pixels source.
string | null
requis
La variante d’emplacement couverte par cette ressource, ou null pour la ressource d’origine.Options disponibles : square, vertical, horizontal
string | null
requis
Toujours null. Les traductions ne sont plus disponibles.
string | null
requis
Le type de ressource, image ou vidéo.
string | null
requis
URL CDN de la ressource.
number
requis
Événements de conversion personnalisés (définis par le marchand) attribués par le pixel Whop, au dernier clic, tous noms d’événements personnalisés confondus.
object
requis
Conversions personnalisées attribuées par le pixel Whop, indexées par le nom de votre événement, avec leur nombre au dernier clic comme valeur. Vide lorsqu’aucun événement personnalisé nommé n’est attribué. Les événements personnalisés déclenchés sans nom sont comptés dans custom_conversions mais omis ici, de sorte que la somme de ces valeurs est au plus égale à custom_conversions.
object
requis
Valeur de conversion attribuée à chaque événement personnalisé, indexée par nom d’événement comme custom_event_counts. Additionne la valeur transmise à whop.track, normalisée en USD ; les événements déclenchés sans valeur comptent pour 0.
string
requis
Indique si l’annonce est actuellement diffusée et, sinon, pourquoi. Lorsque plusieurs états s’appliquent simultanément, celui ayant la priorité la plus élevée est renvoyé.Options disponibles : rejected, in_review, draft, campaign_paused, paused, processing, revise_content, issues, scheduled, learning, active
object[]
requis
La description affichée sur l’annonce.

Propriétés

string | null
requis
Toujours null. Les traductions ne sont plus disponibles.
string
requis
Le texte affiché aux spectateurs.
number | null
requis
Impressions divisées par la couverture.
object[]
requis
Le titre affiché sur l’annonce.

Propriétés

string | null
requis
Toujours null. Les traductions ne sont plus disponibles.
string
requis
Le texte affiché aux spectateurs.
number
requis
Le nombre d’impressions.
object[]
requis
Problèmes ouverts affectant cette annonce. Vide lorsqu’il n’y en a aucun.

Propriétés

string
requis
Identifiant unique du problème.
string
requis
Le type de problème : une information sur la diffusion, un avertissement ou une erreur nécessitant une action.Options disponibles : information, warning, error
string
requis
Une description du problème et de la manière de le résoudre.
string | null
requis
L’ID de la campagne, du groupe d’annonces ou de l’annonce auquel le problème est rattaché.
string
requis
Le type de ressource auquel le problème est rattaché.Options disponibles : ad_campaign, ad_group, ad
string
requis
Un titre court du problème, destiné au créateur : la règle citée par un rejet lors de la vérification du contenu, ou un libellé générique.
number
requis
Valeur en USD attribuée aux événements de lead. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Leads attribués par le pixel Whop, au dernier clic.
Pages vues sur votre destination par les personnes ayant cliqué sur l’annonce, enregistrées par le pixel Whop. Comptabilisées de la même manière sur toutes les plateformes publicitaires.
object[]
requis
Le texte principal affiché dans le corps de l’annonce. Plusieurs entrées créent des variantes de texte.

Propriétés

string | null
requis
Toujours null. Les traductions ne sont plus disponibles.
string
requis
Le texte affiché aux spectateurs.
number
requis
Valeur en USD des achats attribués par le pixel.
number
requis
Achats attribués par le pixel Whop, au dernier clic.
number
requis
Le nombre de personnes uniques ayant vu ceci.
string | null
requis
L’événement de conversion du pixel Whop dont le nombre attribué représente les résultats : l’objectif d’optimisation, ou l’événement attribué au volume le plus élevé pour les campagnes budgétées par groupe d’annonces. Null lorsque l’objectif n’est pas un événement attribué par Whop.Options disponibles : purchase, lead, schedule, submit_application, contact, complete_registration, view_content, add_to_cart, custom, messaging_conversation
string | null
requis
Le nom d’événement défini par le marchand lorsque result_event vaut custom ; null pour les événements standard.
number | null
requis
Le nombre attribué par le pixel Whop derrière result_event. Lorsque les groupes d’annonces d’une campagne optimisent des objectifs différents, il n’y a pas de result_event unique (il vaut null), et cette valeur correspond alors à la somme des résultats attribués propres à chaque groupe d’annonces. Null lorsque rien d’attribuable par Whop n’est optimisé.
number
requis
Valeur des achats divisée par les dépenses, toutes deux en USD (un ratio indépendant de la devise) ; 0 en l’absence de dépenses.
number
requis
Valeur en USD attribuée aux événements de prise de rendez-vous. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Événements de prise de rendez-vous attribués par le pixel Whop, au dernier clic.
number
requis
Le montant facturé, en spend_currency.
string | null
requis
Le code de devise ISO 4217 de toutes les métriques monétaires.
string
requis
Indique si l’annonce est activée. active et paused sont définis par vous ; in_review et rejected proviennent de la vérification publicitaire.Options disponibles : active, paused, in_review, rejected
number
requis
Valeur en USD attribuée aux événements de soumission de candidature. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Événements de soumission de candidature attribués par le pixel Whop, au dernier clic.
string | null
requis
Titre d’affichage de l’annonce.
number | null
requis
Clics uniques divisés par les impressions, entre 0 et 1.
number
requis
Personnes ayant cliqué, signalées par le pixel Whop, comptées une seule fois par personne.
string
requis
Date de dernière mise à jour de l’annonce, sous forme d’horodatage ISO 8601.
string | null
requis
L’URL vers laquelle renvoie l’annonce, sans sa chaîne de requête. Les paramètres doivent figurer dans url_parameters ; ceux que vous envoyez dans url y sont déplacés.
object
requis
Paramètres de requête ajoutés à url, indexés par nom. Les paramètres d’attribution des clics de Whop sont réservés.
number
requis
Valeur en USD attribuée aux événements de consultation de contenu. Additionne la valeur envoyée avec chaque événement, normalisée en USD ; les événements sans valeur comptent pour 0.
number
requis
Événements de consultation de contenu attribués par le pixel Whop, au dernier clic.
Ad