Skip to main content
Bu sayfa @whop/elements@1.10.0 ve @whop/elements-react@1.10.0 sürümlerini belgeler.
v1.0.0 sürümünden beri. Ads üzerinden bir modal olarak açılır: ads.createOverlay('campaign-creator'). Props ve geri çağırmaları create seçeneklerinde iletin.
Bu öğe yalnızca modal olarak kullanılır. createOverlay ile açın; satır içi bağlama seçeneği yoktur.

Örnek veriler. Deneme alanını açın.

Props

string
Açılacak kampanya (adcamp_…). Boş bırakılırsa yeni bir kampanya oluşturulur. Bir taslak kaldığı yerden açılır; başlatılmış bir kampanya düzenleme modunda açılır. Varsayılan: "".
string
campaignId içinde odakta açılacak reklam grubu (adgrp_…). Kampanyada böyle bir grup yoksa veya campaignId boşsa yok sayılır. Varsayılan: "".
string
adGroupId içinde odakta açılacak reklam (ad_…). O grupta böyle bir reklam yoksa veya adGroupId boşsa yok sayılır. Varsayılan: "".
"ads" | "ad-groups" | "campaign-settings"
Hangi adımda açılacağı: campaign-settings, ad-groups veya ads. Kontrol paneli bunu kendi URL’sinden derin bağlantıyla belirler; bir hesap sahibini doğrudan değiştirmeye geldiği bölüme götürmek için iletin. Bağlama sırasında bir kez okunur; sonradan değiştirmek kullanıcıyı adımlar arasında taşımaz. Varsayılan: "campaign-settings".
string[]
Uygulamanızın POST /api/v1/files üzerinden yüklediği ve oluşturucunun kreatif kitaplığında sunulan dosya kimlikleri (file_…). Kitaplık listesinde bu sırayla ilk olarak görünürler ve herhangi biri ayarlıyken medya seçiciler yükleme bırakma alanı yerine kitaplıkta açılır. Dosyaları, ads tanıtıcısının accessToken değerini oluşturan aynı API anahtarıyla oluşturun; oluşturucu bunları tek bir toplu istekle geri okur (GET /api/v1/files) ve dosya okumaları yalnızca dosyaları oluşturan kimlik bilgisine yanıt verir. Toplu okumanın sınırı olan en fazla 250 kimlik iletin. Bir dosya, yüklemesinin işlenmesi bittiğinde görünür; hiç tamamlanmayan veya görsel ya da video dışında bir şeye işaret eden bir kimlik dışarıda bırakılır. Zaten açık olan bir oluşturucuya medya aktarmak için update({ externalMediaIds }) ile yeni kimlikler iletin. Varsayılan: [].

Olaylar

Geri çağırmaları create seçeneklerinde veya React props’larında iletin.

onExited

Hesap sahibi başlatmadan oluşturucudan çıktı. Hiçbir şey atılmadı; başlatılmışsa bir taslak kampanya zaten kaydedilmiştir. Bu olay tetiklendiğinde katman kendini zaten kapatmıştır; sayfanızın gerektirmesi durumunda buna tepki verin.

onLaunched

Bir kampanya yayına girdi. firstLaunch, hesabın ilk kez başlatılan kampanyasını işaretler; kontrol paneli karşılama durumunu göstermek için bunu kullanır. Katman kendini zaten kapatmıştır; sonraki yönlendirmeyi burada yapın.
object

onLoaderStart

Yükleme iskeleti ilk kez çizildikten sonra ve onReady öncesinde çalışır.

onReady

Öğenin ilk tam çiziminden sonra çalışır.

onError

Öğe yüklenemediğinde veya çöktüğünde çalışır. Yedek görünüm görünür kalır. Programatik işleme için code kullanın. sourceKey, başarısız olan bir host-state kaynağını tanımlar.
object

Yöntemler

Bunları create tarafından döndürülen tanıtıcı üzerinde veya bir React ref aracılığıyla çağırın.

mount

Öğeyi target içine bağlar ve yüklemeyi başlatır. React bileşenleri kendilerini bağlar. Parametreler
string | HTMLElement
gerekli

destroy

Öğeyi kaldırır, çerçevesini ve aboneliklerini serbest bırakır. Birden fazla kez çağırabilirsiniz. React öğeyi otomatik olarak kaldırır.

update

Yeni props’ları bağlı öğeyle birleştirir. React’te bunun yerine bileşen props’larını değiştirin. Parametreler
Partial<CampaignCreatorElementProps>
gerekli

Stil

Bu parçaları appearance.classes üzerinden stillendirin. Özellik adları için camel case veya kebab case kullanın ve birimleri ekleyin. Sayfa stil sayfaları öğenin çerçevesine ulaşamaz. Framework her bildirimi enjekte etmeden önce doğrular.
React’te appearance değerini <Ads> bileşenine iletin. Genel olarak WhopElements({ appearance }) ile ayarlayın.