Skip to main content
Een Ad Group bevindt zich binnen een advertentiecampagne en regelt de levering van advertenties. Deze bepaalt de doelgroep, planning en het budget voor de advertenties. Gebruik de Ad Groups API om advertentiegroepen in campagnes aan te maken, targeting- en leveringsinstellingen op te vragen of op te halen, budgetten of targeting bij te werken, groepen te verwijderen die moeten stoppen en de levering te pauzeren of te hervatten.

Endpoints

Targetingbeperkingen

Advertentiegroepen kunnen zich niet richten op de landen die in de advertentiegids worden genoemd. Verzoeken om een advertentiegroep aan te maken of de getargete landen bij te werken, worden afgewezen als ze een geblokkeerd land bevatten in regions.include.countries.

Attributen

string
vereist
Unieke identificatie van de advertentiegroep, met prefix adgrp_.
object
vereist
De advertentiecampagne waartoe deze advertentiegroep behoort.

Eigenschappen

string
vereist
De id van de entiteit waarnaar wordt verwezen.
number
vereist
USD-waarde toegeschreven aan add-to-cart-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven add-to-cart-events, last-click.
object
vereist
Opgeslagen doelgroepen waaraan deze advertentiegroep levert of die worden uitgesloten.

Eigenschappen

string[]
vereist
ID’s van opgeslagen doelgroepen die van levering zijn uitgesloten, met prefix adaud_.
string[]
vereist
ID’s van opgeslagen doelgroepen waaraan de advertentiegroep levert, met prefix adaud_.
string | null
vereist
Hoe biedingen voor levering in de advertentieveiling worden ingesteld. Op doelen gebaseerde strategieën gebruiken desired_cost_per_result.Beschikbare opties: minimum_cost, average_target, maximum_target
number | null
vereist
Het budget van deze advertentiegroep in USD, de valuta waarin het wordt opgeslagen en gefactureerd. null wanneer het budget in plaats daarvan op de campagne is ingesteld.
number | null
vereist
Hetzelfde budget uitgedrukt in budget_currency tegen de wisselkoers van vandaag, voor weergave in de advertentierapportagevaluta van het account. null wanneer budget_amount dat is.
string
vereist
De ISO 4217-code waarin budget_amount_local is uitgedrukt: de voorkeur ads_reporting_currency van het account. usd, tenzij het account dit heeft gewijzigd.
string | null
vereist
Of budget_amount per dag (daily) of over de volledige looptijd van de advertentiegroep (lifetime) wordt besteed. Een lifetime-advertentiegroep heeft ook ends_at nodig, minstens 24 uur na de start.Beschikbare opties: daily, lifetime
number
vereist
Klikken gedeeld door vertoningen, tussen 0 en 1.
number
vereist
Het aantal klikken.
number
vereist
USD-waarde toegeschreven aan complete-registration-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven complete-registration-events, last-click.
number
vereist
USD-waarde toegeschreven aan contact-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven contact-events, last-click.
string | null
vereist
Het pixel-event waarop wordt geoptimaliseerd. Een standaard-event of een willekeurige aangepaste pixel-eventnaam.
number | null
vereist
Uitgaven gedeeld door toegeschreven add-to-cart-events; null wanneer deze niet het doel zijn en er geen zijn toegeschreven.
number
vereist
Uitgaven gedeeld door klikken; 0 wanneer er geen klikken zijn.
number | null
vereist
Uitgaven gedeeld door toegeschreven complete-registration-events; null wanneer deze niet het doel zijn en er geen zijn toegeschreven.
number | null
vereist
Uitgaven gedeeld door toegeschreven contact-events; null wanneer contacten niet het doel zijn en er geen zijn toegeschreven.
number | null
vereist
Uitgaven gedeeld door toegeschreven leads; null wanneer leads geen doel zijn en er geen zijn toegeschreven.
number
vereist
Uitgaven per 1.000 vertoningen; 0 wanneer er geen vertoningen zijn.
number | null
vereist
Uitgaven gedeeld door toegeschreven aankopen; null wanneer aankopen geen doel zijn en er geen zijn toegeschreven.
number | null
vereist
Uitgaven gedeeld door door de Whop-pixel toegeschreven resultaten; null wanneer er niets wordt geoptimaliseerd dat aan Whop kan worden toegeschreven.
number | null
vereist
Uitgaven gedeeld door toegeschreven schedule-events; null wanneer afspraken niet het doel zijn en er geen zijn toegeschreven.
number | null
vereist
Uitgaven gedeeld door toegeschreven submit-application-events; null wanneer deze niet het doel zijn en er geen zijn toegeschreven.
number | null
vereist
Uitgaven gedeeld door unieke klikken; null wanneer er geen unieke klikken zijn.
number | null
vereist
Uitgaven gedeeld door toegeschreven view-content-events; null wanneer deze niet het doel zijn en er geen zijn toegeschreven.
string
vereist
Wanneer de advertentiegroep is aangemaakt, als ISO 8601-tijdstempel.
number
vereist
Door de Whop-pixel toegeschreven aangepaste (door de merchant gedefinieerde) conversie-events, last-click, over alle aangepaste eventnamen.
object
vereist
Door de Whop-pixel toegeschreven aangepaste conversies, met je eventnaam als sleutel en het last-click-aantal als waarde. Leeg wanneer er geen benoemde aangepaste events zijn toegeschreven. Aangepaste events die zonder naam zijn verstuurd, worden geteld in custom_conversions maar hier weggelaten, dus deze waarden tellen op tot maximaal custom_conversions.
object
vereist
Conversiewaarde toegeschreven aan elk aangepast event, met de eventnaam als sleutel, zoals bij custom_event_counts. Telt de waarde op die aan whop.track is doorgegeven, genormaliseerd naar USD; events die zonder waarde zijn verstuurd, dragen 0 bij.
object | null
vereist
Uren waarin de advertentiegroep elke week levert, per dag als sleutel. Dagen waarop niet wordt geleverd, worden weggelaten. null wanneer op elk uur wordt geleverd. Sommige platforms vereisen een lifetime-budget_type voor een planning, op de advertentiegroep of op de campagne wanneer de campagne het budget beheert.

Eigenschappen

object[]
Tijdvensters waarin de advertentiegroep op vrijdag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
object[]
Tijdvensters waarin de advertentiegroep op maandag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
object[]
Tijdvensters waarin de advertentiegroep op zaterdag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
object[]
Tijdvensters waarin de advertentiegroep op zondag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
object[]
Tijdvensters waarin de advertentiegroep op donderdag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
object[]
Tijdvensters waarin de advertentiegroep op dinsdag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
object[]
Tijdvensters waarin de advertentiegroep op woensdag levert, in chronologische volgorde. Weggelaten wanneer er die dag niet wordt geleverd.

Eigenschappen

string
vereist
Wanneer de levering stopt, als 24-uurstijd HH:00 tot en met 24:00 voor middernacht. Later dan start; een venster na middernacht wordt over twee dagen verdeeld.
string
vereist
Wanneer de levering start, als 24-uurstijd HH:00 van 00:00 tot en met 23:00.
string
vereist
Of advertenties in deze advertentiegroep op dit moment worden geleverd, en zo niet, waarom. Wanneer meerdere statussen tegelijk van toepassing zijn, wordt de status met de hoogste prioriteit geretourneerd.Beschikbare opties: all_ads_rejected, rejected, draft, campaign_paused, paused, in_review, processing, revise_content, issues, scheduled, completed, learning, active
object
vereist
Targeting op leeftijd, geslacht en automatische doelgroep.

Eigenschappen

boolean
vereist
Of automatische doelgroeptargeting is ingeschakeld. Wanneer true, kan de levering verder reiken dan de ingestelde leeftijden en geslachten, die dan als suggesties worden behandeld.
string
vereist
Getarget geslacht.Beschikbare opties: all, male, female
number | null
vereist
Hoogste getargete leeftijd. null wanneer er geen maximum is ingesteld.
number | null
vereist
Laagste getargete leeftijd. null wanneer er geen minimum is ingesteld.
number | null
vereist
Kosten per resultaat om naar te streven (average_target) of nooit te overschrijden (maximum_target). null bij minimum_cost-bieden.
object
vereist
Getargete apparaatplatforms en besturingssystemen.

Eigenschappen

object[]
vereist
Getargete besturingssystemen. Leeg betekent dat alle besturingssystemen worden getarget.

Eigenschappen

string
Laagste getargete OS-versie, zoals 18.0. Afwezig wanneer elke versie in aanmerking komt.
string
vereist
Getarget besturingssysteem.Beschikbare opties: ios, android
string[]
vereist
Getargete apparaattypen. Leeg betekent dat alle apparaten worden getarget.Beschikbare opties: mobile, desktop
string | null
vereist
Wanneer de advertentiegroep stopt met leveren, als ISO 8601-tijdstempel. null wanneer deze loopt totdat ze wordt gepauzeerd.
number | null
vereist
Vertoningen gedeeld door bereik.
number
vereist
Het aantal vertoningen.
object[]
vereist
Openstaande problemen die deze advertentiegroep en de advertenties ervan beïnvloeden. Leeg wanneer er geen zijn.

Eigenschappen

string
vereist
Unieke identificatie van het probleem.
string
vereist
Het soort probleem: informatie over levering, een waarschuwing of een fout die aandacht vereist.Beschikbare opties: information, warning, error
string
vereist
Een beschrijving van wat het probleem is en hoe het kan worden opgelost.
string | null
vereist
De ID van de campagne, advertentiegroep of advertentie waaraan het probleem is gekoppeld.
string
vereist
Het type resource waaraan het probleem is gekoppeld.Beschikbare opties: ad_campaign, ad_group, ad
string
vereist
Een korte titel voor het probleem, bedoeld voor de creator: de regel die bij een afwijzing door de contentbeoordeling wordt genoemd, of een algemeen label.
object[]
Zoektermen waarvoor de advertenties van deze advertentiegroep kunnen worden weergegeven, en termen waarvoor ze nooit worden weergegeven. Alleen voor zoekcampagnes, waarbij elke advertentiegroep er vóór de lancering minstens één nodig heeft.

Eigenschappen

string
vereist
Hoe nauwkeurig een zoekopdracht moet overeenkomen: broad bereikt ook gerelateerde zoekopdrachten, phrase vereist de betekenis van de woordgroep en exact vereist dezelfde betekenis als de term. Standaard broad.Beschikbare opties: broad, phrase, exact
boolean
vereist
Of deze term voorkomt dat de advertenties worden weergegeven in plaats van ze in aanmerking te laten komen. Standaard false.
string
vereist
De zoekterm, maximaal 80 tekens en 10 woorden.
string[]
vereist
Getargete talen, als ISO 639-codes zoals en of es. Een regiospecifieke locale zonder ISO-code verschijnt als numerieke locale-sleutel. Leeg betekent dat alle talen worden getarget.
number
vereist
USD-waarde toegeschreven aan lead-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven leads, last-click.
object | null
vereist
Voortgang richting de conversies die de leerfase van deze advertentiegroep nodig heeft. Null, tenzij de groep aan het leren is of beperkt aan het leren is en er geldige aantallen beschikbaar zijn. Het bereiken van de drempel bepaalt de leveringsstatus niet.

Eigenschappen

integer
vereist
De conversies die de leerfase van deze advertentiegroep nodig heeft. Dit kan tijdens de levering veranderen.
integer
vereist
Conversies geteld sinds de laatste significante wijziging tijdens de leerfase van deze advertentiegroep.
number
vereist
Conversies gedeeld door de drempel, als percentage begrensd tot 0–100. De delivery_status van de advertentiegroep blijft leidend.
Paginaweergaven op je bestemming door mensen die op de advertentie hebben geklikt, geregistreerd door de Whop-pixel. Op elk advertentieplatform op dezelfde manier geteld.
number
vereist
USD-waarde van door de pixel toegeschreven aankopen.
number
vereist
Door de Whop-pixel toegeschreven aankopen, last-click.
number
vereist
Het aantal unieke personen dat dit heeft gezien.
object
vereist
Getargete en uitgesloten locaties.

Eigenschappen

object
vereist
Locaties die van targeting zijn uitgesloten. Landengroepen kunnen niet worden uitgesloten.

Eigenschappen

object[]
vereist
Steden, met de locatietaxonomie als sleutel.

Eigenschappen

string
vereist
De sleutel van de stad in de locatietaxonomie.
string
Naam van de stad, zoals Austin. Afwezig wanneer de locatietaxonomie er geen heeft.
string[]
vereist
Landen, als ISO 3166-1 alpha-2-codes zoals US.
string[]
vereist
Groepen van meerdere landen, zoals worldwide of europe.
object[]
vereist
Cirkelvormige gebieden, elk een coördinaat plus een straal.

Eigenschappen

string
ISO 3166-1 alpha-2-land waarin het punt ligt. Stuur dit mee bij een speciale advertentiecategorie, waarbij de campagne de landen moet opgeven die de advertentiesets bereiken.
string
vereist
Eenheid voor radius.Beschikbare opties: mile, kilometer
number
vereist
Breedtegraad van het middelpunt.
number
vereist
Lengtegraad van het middelpunt.
string
Label voor de locatie, zoals een stad of adres. Afwezig wanneer de locatie geen label heeft.
number
vereist
Straal rond het middelpunt, in distance_unit.
string[]
vereist
Amerikaanse staten en DC, als ISO 3166-2-codes zoals US-CA. Amerikaanse territoria (PR, GU, VI, AS, MP) en alles buiten de VS worden getarget via countries.
string[]
vereist
Postcodes, met als sleutel COUNTRY:CODE, zoals US:78756.
object
vereist
Locaties waarop de advertentiegroep zich richt.

Eigenschappen

object[]
vereist
Steden, met de locatietaxonomie als sleutel.

Eigenschappen

string
vereist
De sleutel van de stad in de locatietaxonomie.
string
Naam van de stad, zoals Austin. Afwezig wanneer de locatietaxonomie er geen heeft.
string[]
vereist
Landen, als ISO 3166-1 alpha-2-codes zoals US.
string[]
vereist
Groepen van meerdere landen, zoals worldwide of europe.
object[]
vereist
Cirkelvormige gebieden, elk een coördinaat plus een straal.

Eigenschappen

string
ISO 3166-1 alpha-2-land waarin het punt ligt. Stuur dit mee bij een speciale advertentiecategorie, waarbij de campagne de landen moet opgeven die de advertentiesets bereiken.
string
vereist
Eenheid voor radius.Beschikbare opties: mile, kilometer
number
vereist
Breedtegraad van het middelpunt.
number
vereist
Lengtegraad van het middelpunt.
string
Label voor de locatie, zoals een stad of adres. Afwezig wanneer de locatie geen label heeft.
number
vereist
Straal rond het middelpunt, in distance_unit.
string[]
vereist
Amerikaanse staten en DC, als ISO 3166-2-codes zoals US-CA. Amerikaanse territoria (PR, GU, VI, AS, MP) en alles buiten de VS worden getarget via countries.
string[]
vereist
Postcodes, met als sleutel COUNTRY:CODE, zoals US:78756.
string | null
vereist
Het Whop-pixel-conversie-event waarvan het toegeschreven aantal de resultaten vertegenwoordigt — het optimalisatiedoel, of het event met het hoogste toegeschreven volume voor campagnes die per advertentiegroep budgetteren. Null wanneer het doel geen door Whop toegeschreven event is.Beschikbare opties: purchase, lead, schedule, submit_application, contact, complete_registration, view_content, add_to_cart, custom, messaging_conversation
string | null
vereist
De door de merchant gedefinieerde eventnaam wanneer result_event custom is; null voor de standaard-events.
number | null
vereist
Het door de Whop-pixel toegeschreven aantal achter result_event. Wanneer de advertentiegroepen van een campagne op verschillende doelen optimaliseren, is er geen enkele result_event (die is dan null), en is dit in plaats daarvan de som van de eigen toegeschreven resultaten van elke advertentiegroep. Null wanneer er niets wordt geoptimaliseerd dat aan Whop kan worden toegeschreven.
number
vereist
Aankoopwaarde gedeeld door uitgaven, beide in USD (een valuta-neutrale verhouding); 0 wanneer er geen uitgaven zijn.
number
vereist
USD-waarde toegeschreven aan schedule-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven schedule-events, last-click.
number
vereist
Het in rekening gebrachte bedrag, in spend_currency.
string | null
vereist
De ISO 4217-valutacode van alle monetaire statistieken.
string | null
vereist
Wanneer de advertentiegroep begint met leveren, als ISO 8601-tijdstempel. null wanneer deze start zodra ze actief is.
string
vereist
Of de advertentiegroep is ingeschakeld. active en paused stel je zelf in; rejected betekent dat de groep de advertentiebeoordeling niet heeft doorstaan; duplicating is een kopie die nog wordt gevuld.Beschikbare opties: active, paused, rejected, duplicating
number
vereist
USD-waarde toegeschreven aan submit-application-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven submit-application-events, last-click.
string | null
vereist
Weergavenaam van de advertentiegroep.
number | null
vereist
Unieke klikken gedeeld door vertoningen, tussen 0 en 1.
number
vereist
Personen die hebben geklikt, gerapporteerd door de Whop-pixel, één keer per persoon geteld.
string
vereist
Wanneer de advertentiegroep voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
number
vereist
USD-waarde toegeschreven aan view-content-events. Telt de waarde op die met elk event is meegestuurd, genormaliseerd naar USD; events zonder waarde dragen 0 bij.
number
vereist
Door de Whop-pixel toegeschreven view-content-events, last-click.
AdGroup