Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0. Åbnes som en modal fra Ads: ads.createOverlay('campaign-creator'). Send props og callbacks i create-indstillingerne.
Dette element er kun modal. Åbn det med createOverlay; det har ingen inline-montering.

Eksempeldata. Åbn Playground.

Props

string
Den kampagne (adcamp_…), der skal åbnes. Tom bygger en ny. En kladde åbnes der, hvor den blev forladt; en lanceret kampagne åbnes i redigeringstilstand. Standard er "".
string
Den annoncegruppe (adgrp_…), der skal åbnes i fokus inden for campaignId. Ignoreres, når kampagnen ikke har en sådan gruppe, og når campaignId er tom. Standard er "".
string
Den annonce (ad_…), der skal åbnes i fokus inden for adGroupId. Ignoreres, når den gruppe ikke har en sådan annonce, og når adGroupId er tom. Standard er "".
"ads" | "ad-groups" | "campaign-settings"
Hvilket trin der skal åbnes på: campaign-settings, ad-groups eller ads. Dashboardet deep-linker dette ud fra sin egen URL; send det for at sende en kontoejer direkte til den del, vedkommende kom for at ændre. Læses én gang ved montering – en senere ændring flytter dem ikke mellem trin. Standard er "campaign-settings".
string[]
Fil-ID’er (file_…), som din app har uploadet via POST /api/v1/files, og som tilbydes i builderens kreative bibliotek. De vises først på bibliotekslisten i denne rækkefølge, og så længe nogen er sat, åbner medievælgerne på biblioteket i stedet for upload-zonen. Opret filerne med den samme API-nøgle, som udsteder ads-handlets accessToken – builderen læser dem tilbage i ét batch (GET /api/v1/files), og fillæsninger svarer kun de legitimationsoplysninger, der oprettede dem. Send højst 250 ID’er, batchlæsningens grænse. En fil vises, når dens upload er færdigbehandlet; et ID, der aldrig bliver færdigt, eller som peger på noget andet end et billede eller en video, udelades. Send nye ID’er med update({ externalMediaIds }) for at streame medier ind i en builder, der allerede er åben. Standard er [].

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onExited

Kontoejeren forlod builderen uden at lancere. Intet er blevet kasseret – en kampagnekladde, hvis en blev startet, er allerede gemt. Et overlay har allerede lukket sig selv, når dette udløses; reagér på det, hvis din side har brug for det.

onLaunched

En kampagne gik live. firstLaunch markerer kontoens allerførste lancerede kampagne, hvilket dashboardet bruger til at vise sin velkomsttilstand. Et overlay har allerede lukket sig selv; det er her, du sender videre.
object

onLoaderStart

Kører, efter at indlæsningsskelettet tegnes første gang, og før onReady.

onReady

Kører efter elementets første komplette optegning.

onError

Kører, når elementet ikke kan indlæses eller går ned. Fallback-visningen forbliver synlig. Brug code til programmatisk håndtering. sourceKey identificerer en host-state-kilde, der fejlede.
object

Metoder

Kald disse på det handle, der returneres af create, eller via en React-ref.

mount

Monterer elementet i target og starter indlæsningen. React-komponenter monterer sig selv. Parametre
string | HTMLElement
påkrævet

destroy

Fjerner elementet og frigiver dets frame og abonnementer. Du kan kalde det mere end én gang. React fjerner elementet automatisk.

update

Fletter nye props ind i det monterede element. I React skal du i stedet ændre komponentens props. Parametre
Partial<CampaignCreatorElementProps>
påkrævet

Styling

Style disse dele via appearance.classes. Brug camel case eller kebab case til egenskabsnavne, og inkludér enheder. Sidens stylesheets kan ikke nå elementets frame. Frameworket validerer hver deklaration, før den injiceres.
I React skal du sende appearance til <Ads>. Sæt det globalt med WhopElements({ appearance }).