Skip to main content
Une Ad Campaign est le conteneur de premier niveau des publicités payantes. Elle définit l’objectif et la stratégie budgétaire partagés par ses groupes d’annonces et ses annonces. Utilisez l’API Ad Campaigns pour créer des campagnes, lister les campagnes d’un compte, récupérer ou mettre à jour les paramètres d’une campagne, et mettre en pause ou reprendre la diffusion d’une campagne. La facturation publicitaire regroupe les dépenses éligibles de toutes les campagnes du compte. Un paiement échoué bloque la diffusion avec delivery_status: payment_failed tout en conservant le status actif/en pause configuré. Corrigez le moyen de paiement du compte et relancez son paiement publicitaire une seule fois pour le compte. La relance est asynchrone : son acceptation ne confirme pas le paiement. Un règlement réussi lève le blocage ; les campagnes actives peuvent reprendre si elles sont par ailleurs éligibles, tandis que les campagnes en pause restent en pause. Consultez facturation et relances.

Endpoints

Attributs

string
requis
Identifiant unique de la campagne publicitaire, préfixé par adcamp_.
object | null
requis
L’entreprise qui gère cette campagne, avec le nom et le logo affichés par ses annonces.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string | null
requis
URL de l’image du logo du compte. null lorsque le compte n’en a pas défini.
string
requis
Identifiant de route public du compte, utilisé dans le chemin de la vitrine whop.com/\{route}.
string
requis
Nom d’affichage du compte.
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.
number | null
requis
Le budget de la campagne en USD, devise dans laquelle il est stocké et facturé. null lorsque chaque groupe d’annonces définit plutôt son propre budget.
number | null
requis
Le même budget exprimé en budget_currency au taux de change du jour, pour l’affichage dans la devise de reporting publicitaire du compte. null lorsque budget_amount l’est.
string
requis
Le code ISO 4217 dans lequel est exprimé budget_amount_local : la préférence ads_reporting_currency du compte. usd sauf si le compte l’a modifiée.
string | null
requis
Le niveau qui détient le budget : la campagne entière (ad_campaign) ou chaque groupe d’annonces individuellement (ad_group).Options disponibles : ad_campaign, ad_group
string | null
requis
Indique si budget_amount est dépensé par jour (daily) ou sur toute la durée de la campagne (lifetime).Options disponibles : daily, lifetime
string
requis
Le type de campagne, fixé à la création. standard diffuse des annonces image et vidéo ; search affiche des annonces textuelles dans les résultats de recherche pour les mots-clés des groupes d’annonces.Options disponibles : standard, search
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.
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 la campagne, sous forme d’horodatage ISO 8601.
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 les annonces de la campagne sont actuellement diffusées et, sinon, pourquoi. La vérification du contenu correspond à in_review ; une campagne en attente de démarrage est en processing. Les échecs de facturation du compte définissent payment_failed sans modifier le statut configuré. Une relance de paiement réussie lève ce blocage et recalcule la diffusion. Lorsque plusieurs états s’appliquent simultanément, celui ayant la priorité la plus élevée est renvoyé.Options disponibles : payment_failed, all_ads_rejected, draft, paused, in_review, learning, processing, revise_content, issues, scheduled, completed, active
number | null
Le coût par résultat, en USD, que l’annonceur souhaite atteindre pour cette campagne. Il s’agit uniquement d’une cible : ce n’est ni une enchère, ni un plafond de coût, ni un plafond d’enchère, et cela ne modifie pas la façon dont les annonces de la campagne enchérissent. null lorsqu’aucune cible n’est définie.
string | null
requis
Date à laquelle la campagne cesse d’être diffusée, sous forme d’horodatage ISO 8601. null lorsqu’elle est diffusée jusqu’à sa mise en pause, ou lorsque ses groupes d’annonces définissent leur propre calendrier.
number | null
requis
Impressions divisées par la couverture.
number
requis
Le nombre d’impressions.
object[]
requis
Problèmes ouverts affectant la campagne ainsi que ses groupes d’annonces et annonces descendants.

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.
string | null
requis
L’objectif vers lequel la campagne optimise. awareness n’apparaît que sur les campagnes créées avant son retrait ; ces campagnes ne peuvent pas être lancées.Options disponibles : awareness, traffic, engagement, leads, sales
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.
string[]
requis
Catégories réglementées sous lesquelles la campagne est déclarée. Les annonces de ces catégories sont soumises à des restrictions de ciblage supplémentaires. Vide lorsqu’aucune ne s’applique.Options disponibles : housing, employment, financial_products, politics
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 | null
requis
Date à laquelle la campagne commence à être diffusée, sous forme d’horodatage ISO 8601. null lorsqu’elle démarre dès son lancement, ou lorsque ses groupes d’annonces définissent leur propre calendrier.
string
requis
Le statut de cycle de vie configuré de la campagne publicitaire. Les échecs de facturation conservent ici active ou paused et définissent delivery_status sur payment_failed.Options disponibles : active, paused, inactive, payment_failed, draft, duplicating
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.
number | null
requis
Le coût par résultat souhaité pour target_result_event, en USD. null lorsqu’aucun n’est défini.
string | null
requis
L’événement sur la base duquel target_cost_per_result est calculé, par exemple purchase ou lead. null lorsque la campagne n’a pas d’objectif unique.
string
requis
Nom d’affichage de la campagne publicitaire.
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 la campagne, sous forme d’horodatage ISO 8601.
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.
AdCampaign