Skip to main content
En Ad Group ligger inde i en annoncekampagne og styrer levering af annoncer. Den angiver målgruppen, tidsplanen og budgettet for sine annoncer. Brug Ad Groups API’et til at oprette annoncegrupper i kampagner, vise eller hente målretnings- og leveringsindstillinger, opdatere budgetter eller målretning, slette grupper, der skal stoppe med at køre, og sætte levering på pause eller genoptage den.

Endpoints

Målretningsbegrænsninger

Annoncegrupper kan ikke målrette de lande, der er angivet i annonceguiden. Anmodninger om at oprette en annoncegruppe eller opdatere dens målrettede lande afvises, hvis de indeholder et blokeret land i regions.include.countries.

Attributter

string
påkrævet
Unik identifikator for annoncegruppen med præfikset adgrp_.
object
påkrævet
Den annoncekampagne, som denne annoncegruppe tilhører.

Egenskaber

string
påkrævet
Den refererede enheds id.
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.
object
påkrævet
Gemte audiences, som denne annoncegruppe leverer til eller udelukker.

Egenskaber

string[]
påkrævet
ID’er for gemte audiences, der er udelukket fra levering, med præfikset adaud_.
string[]
påkrævet
ID’er for gemte audiences, som annoncegruppen leverer til, med præfikset adaud_.
string | null
påkrævet
Hvordan leveringsbud fastsættes i annonceauktionen. Målbaserede strategier bruger desired_cost_per_result.Tilgængelige muligheder: minimum_cost, average_target, maximum_target
number | null
påkrævet
Denne annoncegruppes budget i USD, som er den valuta, det gemmes og faktureres i. null, når budgettet i stedet er angivet på kampagnen.
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
Om budget_amount bruges pr. dag (daily) eller over annoncegruppens samlede løbetid (lifetime). En lifetime-annoncegruppe kræver også ends_at, mindst 24 timer efter at den starter.Tilgængelige muligheder: daily, lifetime
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.
string | null
påkrævet
Den pixelhændelse, der optimeres efter. En standardhændelse eller en vilkårlig brugerdefineret pixelhændelse name.
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 annoncegruppen 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.
object | null
påkrævet
Timer, hvor annoncegruppen leverer hver uge, med dagen som nøgle. Dage, hvor den ikke leverer, udelades. null, når den leverer alle timer. Nogle platforme kræver en lifetime-budget_type for en tidsplan, på annoncegruppen eller på dens kampagne, når kampagnen har budgettet.

Egenskaber

object[]
Tidsvinduer, hvor annoncegruppen leverer om fredagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
object[]
Tidsvinduer, hvor annoncegruppen leverer om mandagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
object[]
Tidsvinduer, hvor annoncegruppen leverer om lørdagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
object[]
Tidsvinduer, hvor annoncegruppen leverer om søndagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
object[]
Tidsvinduer, hvor annoncegruppen leverer om torsdagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
object[]
Tidsvinduer, hvor annoncegruppen leverer om tirsdagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
object[]
Tidsvinduer, hvor annoncegruppen leverer om onsdagen, i tidsrækkefølge. Udeladt, når den ikke leverer den dag.

Egenskaber

string
påkrævet
Hvornår levering stopper, som et 24-timers HH:00-tidspunkt op til 24:00 for midnat. Senere end start; et vindue efter midnat deles over to dage.
string
påkrævet
Hvornår levering starter, som et 24-timers HH:00-tidspunkt fra 00:00 til 23:00.
string
påkrævet
Om annoncer i denne annoncegruppe leveres lige nu, og hvis ikke, hvorfor. Når flere tilstande gælder på én gang, returneres den med højest prioritet.Tilgængelige muligheder: all_ads_rejected, rejected, draft, campaign_paused, paused, in_review, processing, revise_content, issues, scheduled, completed, learning, active
object
påkrævet
Målretning efter alder, køn og automatisk målgruppe.

Egenskaber

boolean
påkrævet
Om automatisk målgruppemålretning er slået til. Når den er true, kan levering nå ud over de aldre og køn, du angiver, idet de behandles som forslag.
string
påkrævet
Målrettet køn.Tilgængelige muligheder: all, male, female
number | null
påkrævet
Højeste målrettede alder. null, når der ikke er angivet et maksimum.
number | null
påkrævet
Laveste målrettede alder. null, når der ikke er angivet et minimum.
number | null
påkrævet
Pris pr. resultat, der skal sigtes efter (average_target) eller aldrig overskrides (maximum_target). null for minimum_cost-budgivning.
object
påkrævet
Målrettede enhedsplatforme og operativsystemer.

Egenskaber

object[]
påkrævet
Målrettede operativsystemer. Tom målretter alle operativsystemer.

Egenskaber

string
Laveste målrettede OS-version, såsom 18.0. Fraværende, når enhver version kvalificerer.
string
påkrævet
Målrettet operativsystem.Tilgængelige muligheder: ios, android
string[]
påkrævet
Målrettede enhedstyper. Tom målretter alle enheder.Tilgængelige muligheder: mobile, desktop
string | null
påkrævet
Hvornår annoncegruppen stopper med at levere, som et ISO 8601-tidsstempel. null, når den kører, indtil den sættes på pause.
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 denne annoncegruppe og dens annoncer. Tom, når der ikke er nogen.

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.
object[]
Søgetermer, som denne annoncegruppes annoncer kan vises for, og termer, de aldrig vises for. Kun søgekampagner, hvor hver annoncegruppe skal have mindst én før lancering.

Egenskaber

string
påkrævet
Hvor tæt en søgning skal matche: broad når også relaterede søgninger, phrase kræver frasens betydning, og exact kræver samme betydning som termen. Standard er broad.Tilgængelige muligheder: broad, phrase, exact
boolean
påkrævet
Om denne term forhindrer annoncerne i at blive vist i stedet for at gøre dem berettigede. Standard er false.
string
påkrævet
Søgetermen, op til 80 tegn og 10 ord.
string[]
påkrævet
Målrettede sprog som ISO 639-koder, såsom en eller es. En regionsspecifik locale uden ISO-kode vises som en numerisk locale-nøgle. Tom målretter alle sprog.
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.
object | null
påkrævet
Fremskridt mod de konverteringer, som denne annoncegruppes læringsfase kræver. Null, medmindre den er i læring eller begrænset læring, og gyldige antal er tilgængelige. At nå tærsklen afgør ikke leveringsstatus.

Egenskaber

integer
påkrævet
De konverteringer, som denne annoncegruppes læringsfase kræver. Det kan ændre sig under levering.
integer
påkrævet
Konverteringer talt siden den seneste væsentlige redigering i denne annoncegruppes læringsfase.
number
påkrævet
Konverteringer divideret med tærsklen, som en procentdel begrænset til 0–100. Annoncegruppens delivery_status er fortsat afgørende.
Sidevisninger på din destination fra personer, der klikkede på annoncen, registreret af Whop-pixelen. Tælles på samme måde på alle annonceplatforme.
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.
object
påkrævet
Målrettede og udelukkede lokationer.

Egenskaber

object
påkrævet
Lokationer, der er udelukket fra målretning. Landegrupper kan ikke udelukkes.

Egenskaber

object[]
påkrævet
Byer med lokationstaksonomien som nøgle.

Egenskaber

string
påkrævet
Byens nøgle i lokationstaksonomien.
string
Bynavn, såsom Austin. Fraværende, når lokationstaksonomien ikke har et.
string[]
påkrævet
Lande som ISO 3166-1 alpha-2-koder, såsom US.
string[]
påkrævet
Grupper af flere lande, såsom worldwide eller europe.
object[]
påkrævet
Cirkulære områder, hver en koordinat plus en radius.

Egenskaber

string
ISO 3166-1 alpha-2-landet, som punktet ligger i. Send det under en særlig annoncekategori, hvor kampagnen skal erklære de lande, dens annoncesæt når.
string
påkrævet
Enhed for radius.Tilgængelige muligheder: mile, kilometer
number
påkrævet
Centrumpunktets breddegrad.
number
påkrævet
Centrumpunktets længdegrad.
string
Etiket for lokationen, såsom en by eller adresse. Fraværende, når lokationen ikke har en etiket.
number
påkrævet
Radius omkring centrumpunktet i distance_unit.
string[]
påkrævet
Amerikanske delstater og DC som ISO 3166-2-koder, såsom US-CA. Amerikanske territorier (PR, GU, VI, AS, MP) og alt uden for USA målrettes via countries.
string[]
påkrævet
Post- og ZIP-koder med nøglen COUNTRY:CODE, såsom US:78756.
object
påkrævet
Lokationer, som annoncegruppen målretter.

Egenskaber

object[]
påkrævet
Byer med lokationstaksonomien som nøgle.

Egenskaber

string
påkrævet
Byens nøgle i lokationstaksonomien.
string
Bynavn, såsom Austin. Fraværende, når lokationstaksonomien ikke har et.
string[]
påkrævet
Lande som ISO 3166-1 alpha-2-koder, såsom US.
string[]
påkrævet
Grupper af flere lande, såsom worldwide eller europe.
object[]
påkrævet
Cirkulære områder, hver en koordinat plus en radius.

Egenskaber

string
ISO 3166-1 alpha-2-landet, som punktet ligger i. Send det under en særlig annoncekategori, hvor kampagnen skal erklære de lande, dens annoncesæt når.
string
påkrævet
Enhed for radius.Tilgængelige muligheder: mile, kilometer
number
påkrævet
Centrumpunktets breddegrad.
number
påkrævet
Centrumpunktets længdegrad.
string
Etiket for lokationen, såsom en by eller adresse. Fraværende, når lokationen ikke har en etiket.
number
påkrævet
Radius omkring centrumpunktet i distance_unit.
string[]
påkrævet
Amerikanske delstater og DC som ISO 3166-2-koder, såsom US-CA. Amerikanske territorier (PR, GU, VI, AS, MP) og alt uden for USA målrettes via countries.
string[]
påkrævet
Post- og ZIP-koder med nøglen COUNTRY:CODE, såsom US:78756.
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.
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 annoncegruppen begynder at levere, som et ISO 8601-tidsstempel. null, når den starter, så snart den er aktiv.
string
påkrævet
Om annoncegruppen er aktiveret. active og paused angives af dig; rejected betyder, at den ikke bestod annoncegennemgangen; duplicating er en kopi, der stadig udfyldes.Tilgængelige muligheder: active, paused, rejected, 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.
string | null
påkrævet
Annoncegruppens 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 annoncegruppen 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.
AdGroup