Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0.

Playground

Sæt elementerne sammen med eksempeldata. Betjen kontrollerne, tilføj og arrangér elementer, og se hændelser blive udløst live:

Indstillinger

Send disse til whop.ads.create({ … }), eller som props på <Ads> i React.
string
Whop-konto-ID med præfikset biz_, hvis annoncering dette læser. Påkrævet; dette er ikke et annoncekonto-ID. Standard er "".
string
Et afgrænset token, som alle flader under dette handle læser og skriver med. Udsted ét token til hele handlet, ikke ét pr. element. Find ud af scopes for hvert element, du vil montere, anmod om dem på et enkelt token, og sæt det her – handlet projicerer den ene legitimationsoplysning ind i hvert elements frame, så et ekstra token pr. flade giver intet og efterlader dig med flere udløbsdatoer at holde styr på i stedet for én. Udsted det på din server med POST /api/v1/access_tokens, og sæt et nyt med update({ accessToken }), før det udløber. At montere alt kræver ad_campaign:read/:create, ad_group:read, ad:read, stats:read, de :update/:delete-scopes, som tabellens rækkehandlinger bruger, company:basic:read til de pixel-tjek, campaign-creator kører, og payment:charge plus user:email:read for at tilføje et kort til annonceforbrug; fakturerings-slots viser gemte kort og wallets med midler med member:payment_methods:read. Montering af færre flader kan kræve færre scopes – stadig på det ene token. Hvis det udelades, bærer kaldene seerens egen session, som kun svarer på same-origin.
Hvor rapporterings-table’s klik- og resultattal linker hen på dit websted – typisk de sider, hvor du har monteret tracking-namespacets people- og events-elementer. people og events er absolutte base-URL’er (https://…); tabellen tilføjer de samme forespørgselsparametre, som disse elementer tager som props (?source=whop:adcamp_…:*&event=…&from=…&to=…), så målsiden kan hydrere sit element direkte fra sin URL. En relativ URL ville blive opløst i forhold til elementets frame, så den behandles som ikke sat; links, der ikke er sat, viser tallene som almindelige tal. Standard er {}.
Appearance
Visuel tilpasning af denne gruppes elementer. Tilsidesætter den globale WhopElements({ appearance }). Ændr den live med update({ appearance }).
WhopElementsLocale
Sprogindstilling for UI-teksten i denne gruppes elementer. Sæt den til en af appens indbyggede sprogindstillinger for at tilsidesætte den globale konfiguration. Enhver anden værdi falder tilbage til standardsprogindstillingen.

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onBillingChanged

Kontoens betalingsmetoder til annonceforbrug er ændret, og ændringen er gemt. Slot-værdierne er selve metode-ID’erne – payt_… for et kort, ldgr_… for en saldo; en tom backup betyder, at ingen er sat.
object

onLoadingChange

Kører, når den samlede indlæsningstilstand ændres. Værdien er true, så længe et monteret element stadig indlæses.
boolean

Metoder

Kald disse på Ads-handlet fra whop.ads.create({ … }) eller useAds().

update

Fletter nye handle-indstillinger ind i alle monterede elementer. I React skal du i stedet ændre namespace-props. Parametre
Partial<AdsOptions>
påkrævet

destroy

Ødelægger alle elementer og sub-controllere, som dette handle har oprettet, fjerner controller-frame’en og frigiver dens abonnementer. Du kan kalde det mere end én gang, men et ødelagt handle afviser alle andre kald – opret et nyt handle for at starte forfra. React fjerner gruppen automatisk, når provideren afmonteres.

Elementer

De elementer, denne gruppe monterer. Hvert har sin egen side:

Rapportering

En annoncekontos rapportering: hvad den har brugt, og hvad der kom tilbage, over et tidsvindue, på det niveau du afgrænser til. Montér chart, table eller begge – de læser det samme tidsvindue, den samme tilskrivningsregel og det samme udvalg, så to flader side om side aldrig kan være uenige om, hvad de viser. ads-handlets links-konfiguration forbinder tabellens klik- og resultattal med dine egne sider – dem, hvor du har monteret tracking-namespacets people og events. (sub-controller, 3 elementer)

BillingSetupElement

Hvilke betalingsmetoder annonceforbrug faktureres til: en primær, der bruges først, og en valgfri reserve, hvis den fejler. Begge vælges blandt de metoder, der allerede er gemt på kontoen, og når du vælger en, gemmes den med det samme – der er ingen separat indsendelse. Tilføjelse af et kort åbner en kortformular over din side og vender tilbage til det slot, der bad om det. Kontoens egen saldo vises ved siden af dens kort, hvor kontoen har en.

CampaignCreatorElement

Builderen til annoncekampagner: mål og budget, annoncegrupper med deres målretning og tidsplan og selve annoncerne med deres kreative indhold – hele forløbet frem til lancering. Åbner tom for at bygge en ny kampagne, eller på en eksisterende, når du sender campaignId. Den kører også pixel-tjekket: en lancering kræver, at annoncegruppens konverteringshændelse er live på destinations-URL’en, og pixel-setup-guiden åbnes inde i dette element for at rette en manglende installation. En lancering kræver også, at kontoen har underskrevet Whop Ads-aftalen: når den ikke har, åbner handlet ads-agreement over builderen, og lanceringen fortsætter, når den er underskrevet. Budgetter indtastes og vises i kontoens ads_reporting_currency – den valuta, dens rapporter allerede bruger – og omregnes til og faktureres i USD til den aktuelle valutakurs. Det ene token, du sætter på ads-handlet, skal have pixel-scopes sammen med kampagne-scopes – ad_campaign:create og company:basic:read – i stedet for at bruge et separat token pr. element.

AdsAgreementElement

Underskriver Whop Ads Services and Payment Authorization Agreement for en konto. Når kontoens fakturering af annonceforbrug gemmes, åbnes aftalen; indtil en autoriseret repræsentant underskriver den, kan ingen kampagne lanceres. Underskriveren indtaster sit fulde juridiske navn og eventuelt sin titel, accepterer vilkårene, og den indtastede signatur arkiveres sammen med aftalen. Når den er underskrevet, viser dette, hvem der underskrev den og hvornår; før faktureringen er sat op, er der intet at underskrive, og det fremgår. campaign-creator åbner selv dette over builderen, når en lancering kræver en underskrift, så montér det kun selv for at tilbyde underskrift på forhånd – f.eks. på en indstillings- eller onboardingside.