Skip to main content
En Ad Campaign er containeren på øverste niveau for betalte annoncer. Den angiver det mål og den budgetstrategi, som dens annoncegrupper og annoncer deler. Brug Ad Campaigns API’et til at oprette kampagner, vise kampagner for en konto, hente eller opdatere kampagneindstillinger og sætte kampagnelevering på pause eller genoptage den. Annoncefakturering samler berettiget forbrug på tværs af kontoens kampagner. En mislykket betaling blokerer levering med delivery_status: payment_failed, mens den konfigurerede active/paused-status bevares. Ret kontoens betalingsmetode, og prøv annoncebetalingen igen én gang for kontoen. Det nye forsøg er asynkront: accept bekræfter ikke betalingen. En vellykket afregning fjerner blokeringen; aktive kampagner kan genoptages, hvis de ellers er berettigede, mens pausede kampagner forbliver pausede. Se fakturering og nye forsøg.

Endpoints

Attributter

string
påkrævet
Unik identifikator for annoncekampagnen med præfikset adcamp_.
object | null
påkrævet
Virksomheden, der kører denne kampagne, med det navn og logo, som dens annoncer viser.

Egenskaber

string
påkrævet
Konto-ID med præfikset biz_.
string | null
påkrævet
URL til kontoens logobillede. null, når kontoen ikke har angivet et.
string
påkrævet
Kontoens offentlige rute-identifikator, der bruges i butiksstien whop.com/\{route}.
string
påkrævet
Kontoens visningsnavn.
number
påkrævet
USD-værdi tilskrevet add-to-cart-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne add-to-cart-hændelser, last-click.
number | null
påkrævet
Kampagnens budget i USD, som er den valuta, det gemmes og faktureres i. null, når hver annoncegruppe i stedet angiver sit eget budget.
number | null
påkrævet
Det samme budget angivet i budget_currency til dagens vekselkurs, til visning i kontoens rapporteringsvaluta for annoncer. null, når budget_amount er det.
string
påkrævet
ISO 4217-koden, som budget_amount_local er i: kontoens ads_reporting_currency-præference. usd, medmindre kontoen har ændret den.
string | null
påkrævet
Hvilket niveau der ejer budgettet: hele kampagnen (ad_campaign) eller hver annoncegruppe individuelt (ad_group).Tilgængelige muligheder: ad_campaign, ad_group
string | null
påkrævet
Om budget_amount bruges pr. dag (daily) eller over kampagnens samlede løbetid (lifetime).Tilgængelige muligheder: daily, lifetime
string
påkrævet
Kampagnetypen, fastlagt ved oprettelsen. standard kører billed- og videoannoncer; search viser tekstannoncer i søgeresultater for annoncegruppernes søgeord.Tilgængelige muligheder: standard, search
number
påkrævet
Klik divideret med visninger, mellem 0 og 1.
number
påkrævet
Antallet af klik.
number
påkrævet
USD-værdi tilskrevet complete-registration-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne complete-registration-hændelser, last-click.
number
påkrævet
USD-værdi tilskrevet contact-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne contact-hændelser, last-click.
number | null
påkrævet
Forbrug divideret med tilskrevne add-to-cart-hændelser; null, når de ikke er målet, og ingen er tilskrevet.
number
påkrævet
Forbrug divideret med klik; 0, når der ikke er nogen klik.
number | null
påkrævet
Forbrug divideret med tilskrevne complete-registration-hændelser; null, når de ikke er målet, og ingen er tilskrevet.
number | null
påkrævet
Forbrug divideret med tilskrevne contact-hændelser; null, når kontakter ikke er målet, og ingen er tilskrevet.
number | null
påkrævet
Forbrug divideret med tilskrevne leads; null, når leads ikke er et mål, og ingen er tilskrevet.
number
påkrævet
Forbrug pr. 1.000 visninger; 0, når der ikke er nogen visninger.
number | null
påkrævet
Forbrug divideret med tilskrevne køb; null, når køb ikke er et mål, og ingen er tilskrevet.
number | null
påkrævet
Forbrug divideret med Whop-pixel-tilskrevne resultater; null, når der ikke optimeres efter noget, Whop kan tilskrive.
number | null
påkrævet
Forbrug divideret med tilskrevne schedule-hændelser; null, når bookinger ikke er målet, og ingen er tilskrevet.
number | null
påkrævet
Forbrug divideret med tilskrevne submit-application-hændelser; null, når de ikke er målet, og ingen er tilskrevet.
number | null
påkrævet
Forbrug divideret med unikke klik; null, når der ikke er nogen unikke klik.
number | null
påkrævet
Forbrug divideret med tilskrevne view-content-hændelser; null, når de ikke er målet, og ingen er tilskrevet.
string
påkrævet
Hvornår kampagnen blev oprettet, som et ISO 8601-tidsstempel.
number
påkrævet
Whop-pixel-tilskrevne brugerdefinerede (forhandlerdefinerede) konverteringshændelser, last-click, på tværs af alle brugerdefinerede hændelsesnavne.
object
påkrævet
Whop-pixel-tilskrevne brugerdefinerede konverteringer med dit hændelsesnavn som nøgle og dets last-click-antal som værdi. Tom, når ingen navngivne brugerdefinerede hændelser er tilskrevet. Brugerdefinerede hændelser, der udløses uden et navn, tælles med i custom_conversions, men udelades her, så disse værdier summerer til højst custom_conversions.
object
påkrævet
Konverteringsværdi tilskrevet hver brugerdefineret hændelse med hændelsesnavnet som nøgle ligesom custom_event_counts. Summerer den værdi, der sendes til whop.track, normaliseret til USD; hændelser, der udløses uden en værdi, bidrager med 0.
string
påkrævet
Om kampagnens annoncer leveres lige nu, og hvis ikke, hvorfor. Indholdsgennemgang er in_review; en kampagne, der venter på at starte, er processing. Fejl i kontoens fakturering sætter payment_failed uden at ændre den konfigurerede status. Et vellykket nyt betalingsforsøg fjerner den blokering og genberegner leveringen. Når flere tilstande gælder på én gang, returneres den med højest prioritet.Tilgængelige muligheder: payment_failed, all_ads_rejected, draft, paused, in_review, learning, processing, revise_content, issues, scheduled, completed, active
number | null
Den pris pr. resultat i USD, som annoncøren ønsker, at denne kampagne opnår. Kun et mål: det er ikke et bud, et omkostningsloft eller et budloft og ændrer ikke, hvordan kampagnens annoncer byder. null, når der ikke er angivet et mål.
string | null
påkrævet
Hvornår kampagnen stopper med at levere, som et ISO 8601-tidsstempel. null, når den kører, indtil den sættes på pause, eller når dens annoncegrupper angiver deres egen tidsplan.
number | null
påkrævet
Visninger divideret med rækkevidde.
number
påkrævet
Antallet af visninger.
object[]
påkrævet
Åbne problemer, der påvirker kampagnen og dens underliggende annoncegrupper og annoncer.

Egenskaber

string
påkrævet
Unik identifikator for problemet.
string
påkrævet
Problemets type: information om levering, en advarsel eller en fejl, der kræver opmærksomhed.Tilgængelige muligheder: information, warning, error
string
påkrævet
En beskrivelse af, hvad problemet er, og hvordan det kan løses.
string | null
påkrævet
ID’et for den kampagne, annoncegruppe eller annonce, som problemet er knyttet til.
string
påkrævet
Typen af den ressource, som problemet er knyttet til.Tilgængelige muligheder: ad_campaign, ad_group, ad
string
påkrævet
En kort titel til skaberen for problemet: den regel, en afvisning ved indholdsgennemgang nævner, eller en generisk etiket.
number
påkrævet
USD-værdi tilskrevet lead-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne leads, last-click.
Sidevisninger på din destination fra personer, der klikkede på annoncen, registreret af Whop-pixelen. Tælles på samme måde på alle annonceplatforme.
string | null
påkrævet
Det mål, kampagnen optimerer mod. awareness vises kun på kampagner, der er oprettet, før det blev udfaset; disse kampagner kan ikke lanceres.Tilgængelige muligheder: awareness, traffic, engagement, leads, sales
number
påkrævet
USD-værdi af pixel-tilskrevne køb.
number
påkrævet
Whop-pixel-tilskrevne køb, last-click.
number
påkrævet
Antallet af unikke personer, der så dette.
string | null
påkrævet
Den Whop-pixel-konverteringshændelse, hvis tilskrevne antal repræsenterer resultater — optimeringsmålet eller den tilskrevne hændelse med størst volumen for kampagner, der budgetterer pr. annoncegruppe. Null, når målet ikke er en Whop-tilskrevet hændelse.Tilgængelige muligheder: purchase, lead, schedule, submit_application, contact, complete_registration, view_content, add_to_cart, custom, messaging_conversation
string | null
påkrævet
Det forhandlerdefinerede hændelsesnavn, når result_event er custom; null for standardhændelserne.
number | null
påkrævet
Det Whop-pixel-tilskrevne antal bag result_event. Når en kampagnes annoncegrupper optimerer efter forskellige mål, er der ingen enkelt result_event (den er null), og dette er i stedet summen af hver annoncegruppes egne tilskrevne resultater. Null, når der ikke optimeres efter noget, Whop kan tilskrive.
number
påkrævet
Købsværdi divideret med forbrug, begge i USD (et valutaneutralt forhold); 0, når der ikke er noget forbrug.
number
påkrævet
USD-værdi tilskrevet schedule-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne schedule-hændelser, last-click.
string[]
påkrævet
Regulerede kategorier, som kampagnen er erklæret under. Annoncer i disse kategorier er underlagt ekstra målretningsbegrænsninger. Tom, når ingen gælder.Tilgængelige muligheder: housing, employment, financial_products, politics
number
påkrævet
Det opkrævede beløb i spend_currency.
string | null
påkrævet
ISO 4217-valutakoden for alle monetære målinger.
string | null
påkrævet
Hvornår kampagnen begynder at levere, som et ISO 8601-tidsstempel. null, når den starter, så snart den lanceres, eller når dens annoncegrupper angiver deres egen tidsplan.
string
påkrævet
Annoncekampagnens konfigurerede livscyklusstatus. Faktureringsfejl bevarer active eller paused her og sætter delivery_status til payment_failed.Tilgængelige muligheder: active, paused, inactive, payment_failed, draft, duplicating
number
påkrævet
USD-værdi tilskrevet submit-application-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne submit-application-hændelser, last-click.
number | null
påkrævet
Den ønskede pris pr. resultat for target_result_event i USD. null, når ingen er angivet.
string | null
påkrævet
Den hændelse, som target_cost_per_result er prissat pr., såsom purchase eller lead. null, når kampagnen ikke har et enkelt mål.
string
påkrævet
Annoncekampagnens visningsnavn.
number | null
påkrævet
Unikke klik divideret med visninger, mellem 0 og 1.
number
påkrævet
Personer, der klikkede, rapporteret af Whop-pixelen, talt én gang pr. person.
string
påkrævet
Hvornår kampagnen sidst blev opdateret, som et ISO 8601-tidsstempel.
number
påkrævet
USD-værdi tilskrevet view-content-hændelser. Summerer den værdi, der sendes med hver hændelse, normaliseret til USD; hændelser uden en værdi bidrager med 0.
number
påkrævet
Whop-pixel-tilskrevne view-content-hændelser, last-click.
AdCampaign