Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0.

Playground

Stel de elementen samen met voorbeeldgegevens. Bedien de besturingselementen, voeg elementen toe en rangschik ze, en zie events live binnenkomen:

Opties

Geef deze door aan whop.ads.create({ … }), of als props op <Ads> in React.
string
Whop-account-ID, met voorvoegsel biz_, waarvan de advertenties worden gelezen. Verplicht; dit is geen advertentieaccount-ID. Standaard: "".
string
Een token met scopes waarmee elk oppervlak onder deze handle leest en schrijft. Maak één token aan voor de hele handle, niet één per element. Bepaal de scopes van elk element dat je gaat mounten, vraag ze aan op één token en stel dat hier in — de handle projecteert die ene set inloggegevens in het frame van elk element, dus een tweede token per oppervlak levert niets op en geeft je meerdere vervaldatums om bij te houden in plaats van één. Maak het aan op je server met POST /api/v1/access_tokens en stel met update({ accessToken }) een nieuw token in voordat het verloopt. Alles mounten vereist ad_campaign:read/:create, ad_group:read, ad:read, stats:read, de scopes :update/:delete die de rijacties van de tabel gebruiken, company:basic:read voor de pixelcontroles die campaign-creator uitvoert, en payment:charge plus user:email:read om een kaart voor advertentie-uitgaven toe te voegen; de factureringsslots tonen opgeslagen kaarten en besteedbare wallets met member:payment_methods:read. Minder oppervlakken mounten kan met minder scopes — nog steeds op dat ene token. Zonder token gebruiken de aanroepen de eigen sessie van de kijker, die alleen same-origin werkt.
Waarnaar de klik- en resultaataantallen van de rapportage-table op je site linken — meestal de pagina’s waar je de elementen people en events uit de namespace tracking hebt gemount. people en events zijn absolute basis-URL’s (https://…); de tabel voegt dezelfde queryparameters toe die die elementen als props accepteren (?source=whop:adcamp_…:*&event=…&from=…&to=…), zodat de doelpagina het element direct vanuit de URL kan hydrateren. Een relatieve URL zou worden opgelost ten opzichte van het frame van het element en wordt daarom als niet ingesteld behandeld; zonder ingestelde links worden de aantallen als gewone getallen weergegeven. Standaard: {}.
Appearance
Visuele aanpassing voor de elementen van deze groep. Overschrijft de globale WhopElements({ appearance }). Wijzig het live met update({ appearance }).
WhopElementsLocale
Locale voor de UI-tekst van de elementen in deze groep. Stel deze in op een van de ingebouwde locales van de app om de globale configuratie te overschrijven. Elke andere waarde valt terug op de standaardlocale.

Events

Geef callbacks door in de create-opties of als React-props.

onBillingChanged

De betaalmethoden voor advertentie-uitgaven van het account zijn gewijzigd en de wijziging is opgeslagen. De slotwaarden zijn de ID’s van de methoden zelf — payt_… voor een kaart, ldgr_… voor een saldo; een lege backup betekent dat er geen is ingesteld.
object

onLoadingChange

Wordt uitgevoerd wanneer de gegroepeerde laadstatus verandert. De waarde is true zolang een van de gemounte elementen nog laadt.
boolean

Methoden

Roep deze aan op de Ads-handle uit whop.ads.create({ … }) of useAds().

update

Voegt nieuwe handle-opties samen in elk gemount element. Wijzig in React in plaats daarvan de props van de namespace. Parameters
Partial<AdsOptions>
vereist

destroy

Vernietigt elk element en elke sub-controller die deze handle heeft aangemaakt, verwijdert het controllerframe en geeft de abonnementen ervan vrij. Je kunt dit meer dan eens aanroepen, maar een vernietigde handle weigert elke andere aanroep — maak een nieuwe handle aan om opnieuw te beginnen. React verwijdert de groep automatisch wanneer de provider wordt unmount.

Elementen

De elementen die deze groep mount. Elk element heeft een eigen pagina:

Rapportage

De rapportage van een advertentieaccount: wat het heeft uitgegeven en wat het heeft opgeleverd, over een tijdvenster, op elk niveau waarop je filtert. Mount chart, table of beide — ze lezen hetzelfde tijdvenster, dezelfde toeschrijvingsregel en dezelfde selectie, zodat twee oppervlakken naast elkaar het nooit oneens kunnen zijn over wat ze tonen. De configuratie links van de handle ads koppelt de klik- en resultaataantallen van de tabel aan je eigen pagina’s — de pagina’s waar je people en events uit de namespace tracking hebt gemount. (sub-controller, 3 elementen)

BillingSetupElement

Op welke betaalmethoden advertentie-uitgaven worden gefactureerd: een primaire methode die eerst wordt gebruikt, en een optionele back-up voor als die mislukt. Beide worden gekozen uit de methoden die al op het account zijn opgeslagen, en een keuze wordt direct opgeslagen — er is geen aparte verzendknop. Een kaart toevoegen opent een kaartformulier boven je pagina en keert daarna terug naar het slot dat erom vroeg. Het eigen saldo van het account verschijnt naast de kaarten, als het account een saldo heeft.

CampaignCreatorElement

De builder voor advertentiecampagnes: doel en budget, advertentiegroepen met hun targeting en planning, en de advertenties zelf met hun creatives — de hele flow tot aan de lancering. Opent leeg om een nieuwe campagne te bouwen, of op een bestaande campagne wanneer je campaignId doorgeeft. Het voert ook de pixelcontrole uit: een lancering kan pas doorgaan als het conversie-event van de advertentiegroep live is op de bestemmings-URL, en de wizard pixel-setup opent binnen dit element om een ontbrekende installatie te herstellen. Een lancering vereist ook dat het account de Whop Ads-overeenkomst heeft ondertekend: is dat niet zo, dan opent de handle ads-agreement boven de builder en gaat de lancering verder zodra die is ondertekend. Budgetten worden ingevoerd en weergegeven in de ads_reporting_currency van het account — de valuta die de rapporten al gebruiken — en omgerekend naar en gefactureerd in USD tegen de actuele wisselkoers. Het ene token dat je op de handle ads instelt, moet naast de campagnescopes ook de pixelscopes bevatten — ad_campaign:create en company:basic:read — in plaats van een apart token per element te gebruiken.

AdsAgreementElement

Ondertekent de Whop Ads Services and Payment Authorization Agreement voor een account. Het opslaan van de facturering voor advertentie-uitgaven van het account opent de overeenkomst; totdat een bevoegde vertegenwoordiger die ondertekent, kan er geen campagne worden gelanceerd. De ondertekenaar typt zijn volledige wettelijke naam en optioneel zijn functietitel, accepteert de voorwaarden, en de getypte handtekening wordt bij de overeenkomst gearchiveerd. Na ondertekening toont dit element wie heeft getekend en wanneer; zolang de facturering niet is ingesteld, valt er niets te ondertekenen en meldt het element dat. campaign-creator opent dit element zelf boven de builder wanneer een lancering een handtekening vereist, dus mount het alleen zelf als je vooraf ondertekening wilt aanbieden — bijvoorbeeld op een instellingen- of onboardingpagina.