Capacitor SDK'da onboarding'leri alma

Warning

Onboardings, Adapty SDK v4 itibarıyla kullanımdan kaldırılmıştır. Bunun yerine flow oluşturun: onboarding’lerin WebView içinde çalışmasının aksine, flow’lar cihazda yerel olarak render edilir — daha akıcı animasyonlar, tutarlı bir yerel görünüm, daha hızlı yükleme süreleri ve WebView bağımlılığı olmadan çalışma.

Adapty Kontrol Paneli’ndeki builder ile onboarding’inizin görsel kısmını tasarladıktan sonra, bunu Capacitor uygulamanızda gösterebilirsiniz. Bu süreçteki ilk adım, aşağıda açıklandığı gibi placement ile ilişkilendirilmiş onboarding’i ve onun görünüm yapılandırmasını almaktır.

Başlamadan önce şunları kontrol edin:

Bir onboarding oluşturdunuz.
Onboarding’i bir placement’a eklediniz.

Onboarding’i getirme

No-code builder’ımızla bir onboarding oluşturduğunuzda, bu onboarding uygulamanızın getirmesi ve görüntülemesi gereken bir yapılandırma içeren container olarak saklanır. Bu container tüm deneyimi yönetir: hangi içeriğin görüneceği, nasıl sunulacağı ve kullanıcı etkileşimlerinin (quiz yanıtları veya form girişleri gibi) nasıl işleneceği. Container ayrıca analitik olaylarını otomatik olarak izlediğinden ayrı görünüm takibi uygulamanız gerekmez.

En iyi performans için, kullanıcılara göstermeden önce görsellerin indirilmesine yeterli zaman tanımak amacıyla onboarding yapılandırmasını erken getirin.

Bir onboarding almak için getOnboarding metodunu kullanın:


try {
  const onboarding = await adapty.getOnboarding({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data', // Load from server, fallback to cache
      loadTimeoutMs: 5000 // 5 second timeout
    }
  });
  console.log('Onboarding fetched successfully');
} catch (error) {
  console.error('Failed to fetch onboarding:', error);
}

Ardından, bir görünüm örneği oluşturmak için createOnboardingView metodunu çağırın.

Warning

createOnboardingView metodunun sonucu yalnızca bir kez kullanılabilir. Tekrar kullanmanız gerekiyorsa createOnboardingView metodunu yeniden çağırın.


if (onboarding.hasViewConfiguration) {
  try {
    const view = await createOnboardingView(onboarding);
    console.log('Onboarding view created successfully');
  } catch (error) {
    console.error('Failed to create onboarding view:', error);
  }
} else {
  // Use your custom logic
  console.log('Onboarding does not have view configuration');
}

Parametreler:

Parametre	Varlık	Açıklama
placementId	zorunlu	İstenen Placement’ın tanımlayıcısı. Bu, Adapty Kontrol Paneli’nde bir placement oluştururken belirttiğiniz değerdir.
locale	isteğe bağlı varsayılan: `en`	Onboarding yerelleştirmesinin tanımlayıcısı. Bu parametrenin, eksi (-) karakteriyle ayrılmış bir veya iki alt etiketten oluşan bir dil kodu olması beklenir. İlk alt etiket dil içindir, ikincisi bölge içindir. Örnek: `en` İngilizce anlamına gelir, `pt-br` Brezilya Portekizcesini temsil eder. Yerel ayar kodları ve bunların nasıl kullanılması gerektiği hakkında daha fazla bilgi için Localizations and locale codes bölümüne bakın.
params.fetchPolicy	isteğe bağlı varsayılan: `'reload_revalidating_cache_data'`	SDK varsayılan olarak sunucudan veri yüklemeye çalışır; başarısızlık durumunda önbelleğe alınmış verileri döndürür. Kullanıcılarınızın her zaman en güncel verilere erişmesini sağladığından bu seçeneği öneririz. Ancak kullanıcılarınızın kararsız bir internet bağlantısıyla karşılaştığını düşünüyorsanız, önbelleğe alınmış veriler mevcutsa bunları döndürmek için `'return_cache_data_else_load'` seçeneğini kullanmayı düşünün. Bu senaryoda kullanıcılar en güncel verilere ulaşamayabilir; ancak internet bağlantıları ne kadar düzensiz olursa olsun daha hızlı yükleme süreleri yaşarlar. Önbellek düzenli olarak güncellenir, dolayısıyla ağ isteklerini önlemek için oturum boyunca kullanmak güvenlidir. Önbelleğin uygulama yeniden başlatıldığında korunduğunu, yalnızca uygulama yeniden yüklendiğinde veya manuel temizleme yapıldığında silindiğini unutmayın.
params.loadTimeoutMs	isteğe bağlı varsayılan: 5000 ms	Bu değer, söz konusu yöntem için zaman aşımını (milisaniye cinsinden) sınırlar. Adapty sunucusu zamanında yanıt vermez veya hata döndürürse SDK önbelleğe alınmış onboarding’i döndürür. Önbellekte hiçbir şey yoksa ve sunucu zaman aşımına uğramış ya da sunucu hatası döndürmüşse, SDK onboarding’i yedek sunucudan ister (yalnızca placement’ın All Users kitlesine hizmet eden bir CDN kopyası). Son çare olarak SDK, onboarding’i yedek dosyanızdan döndürür. SDK v3, aynı üç kaynağı farklı bir sırayla kullanır. Nadir durumlarda bu yöntemin `loadTimeoutMs` içinde belirtilenden biraz daha geç zaman aşımına uğrayabileceğini unutmayın; çünkü işlem arka planda farklı isteklerden oluşabilir.

Yanıt parametreleri:

Parametre	Açıklama
onboarding	Onboarding tanımlayıcısı ve yapılandırması, remote config ve diğer çeşitli özellikleri içeren bir `AdaptyOnboarding` nesnesi.

Varsayılan kitle onboarding’i ile onboarding getirmeyi hızlandırın

Onboarding’ler genellikle neredeyse anında getirilir, bu nedenle bu süreci hızlandırmak için endişelenmenize gerek yoktur. Ancak çok sayıda kitleniz ve onboarding’iniz varsa ve kullanıcılarınızın internet bağlantısı zayıfsa, bir onboarding’i getirmek istediğinizden daha uzun sürebilir. Bu gibi durumlarda, hiç onboarding göstermemek yerine sorunsuz bir kullanıcı deneyimi sağlamak amacıyla varsayılan bir onboarding görüntülemek isteyebilirsiniz.

Bu sorunu gidermek için, belirtilen placement’ın Tüm Kullanıcılar kitlesi için onboarding’i getiren getOnboardingForDefaultAudience metodunu kullanabilirsiniz. Ancak önerilen yaklaşımın, yukarıdaki Onboarding’i Getirme bölümünde açıklandığı şekilde getOnboarding metoduyla onboarding getirmek olduğunu anlamak önemlidir.

Warning

getOnboardingForDefaultAudience yerine getOnboarding kullanmayı değerlendirin; çünkü ikincisinin önemli sınırlamaları vardır:

Uyumluluk sorunları: Birden fazla uygulama sürümünü desteklerken sorunlara yol açabilir; geriye dönük uyumlu tasarımlar yapmanızı ya da eski sürümlerin hatalı görüntülenebileceğini kabul etmenizi gerektirir.
Kişiselleştirme yok: Yalnızca “Tüm Kullanıcılar” kitlesi için içerik gösterir; ülke, attribution veya özel niteliklere dayalı hedeflemeyi ortadan kaldırır.

Kullanım durumunuzda daha hızlı getirme bu dezavantajlardan daha önemliyse aşağıda gösterildiği gibi getOnboardingForDefaultAudience kullanın. Aksi takdirde yukarıda açıklandığı gibi getOnboarding kullanın.


try {
  const onboarding = await adapty.getOnboardingForDefaultAudience({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data' // Load from server, fallback to cache
    }
  });
  console.log('Default audience onboarding fetched successfully');
} catch (error) {
  console.error('Failed to fetch default audience onboarding:', error);
}

Parametreler:

Parametre Zorunluluk Açıklama

placementId zorunlu İstenen Placement’ın tanımlayıcısı. Bu, Adapty Kontrol Paneli’nde placement oluştururken belirttiğiniz değerdir.

Parametre	Zorunluluk	Açıklama
placementId	zorunlu	İstenen Placement’ın tanımlayıcısı. Bu, Adapty Kontrol Paneli’nde placement oluştururken belirttiğiniz değerdir.
locale	isteğe bağlı varsayılan: `en`	Onboarding yerelleştirmesinin tanımlayıcısı. Bu parametre, eksi (-) karakteriyle ayrılmış bir veya iki alt etiketten oluşan bir dil kodu olmalıdır. İlk alt etiket dil, ikincisi bölge içindir. Örnek: `en` İngilizce anlamına gelir, `pt-br` Brezilya Portekizcesini temsil eder. Yerel ayar kodları ve bunların nasıl kullanılması gerektiği hakkında daha fazla bilgi için Yerelleştirmeler ve yerel ayar kodları sayfasına bakın.
params.fetchPolicy	isteğe bağlı varsayılan: `'reload_revalidating_cache_data'`	Varsayılan olarak SDK, sunucudan veri yüklemeye çalışır ve hata durumunda önbelleğe alınmış verileri döndürür. Kullanıcılarınızın her zaman en güncel verileri almasını sağladığından bu seçeneği öneriyoruz. Ancak kullanıcılarınızın kararsız bir internet bağlantısıyla uğraştığını düşünüyorsanız, mevcut olduğunda önbelleğe alınmış verileri döndürmek için `'return_cache_data_else_load'` kullanmayı değerlendirin. Bu durumda kullanıcılar en son verilere ulaşamayabilir; ancak internet bağlantısı ne kadar kesintili olursa olsun daha hızlı yükleme süreleri yaşarlar. Önbellek düzenli olarak güncellendiğinden, ağ isteklerini önlemek amacıyla oturum sırasında kullanmak güvenlidir. Önbelleğin, uygulama yeniden başlatıldığında bozulmadan kaldığını ve yalnızca uygulama yeniden yüklendiğinde veya manuel temizlik yapıldığında silindiğini unutmayın.

locale

isteğe bağlı

varsayılan: en

Onboarding yerelleştirmesinin tanımlayıcısı. Bu parametre, eksi (-) karakteriyle ayrılmış bir veya iki alt etiketten oluşan bir dil kodu olmalıdır. İlk alt etiket dil, ikincisi bölge içindir.

Örnek: en İngilizce anlamına gelir, pt-br Brezilya Portekizcesini temsil eder.

Yerel ayar kodları ve bunların nasıl kullanılması gerektiği hakkında daha fazla bilgi için Yerelleştirmeler ve yerel ayar kodları sayfasına bakın.

params.fetchPolicy

isteğe bağlı

varsayılan: 'reload_revalidating_cache_data'

Varsayılan olarak SDK, sunucudan veri yüklemeye çalışır ve hata durumunda önbelleğe alınmış verileri döndürür. Kullanıcılarınızın her zaman en güncel verileri almasını sağladığından bu seçeneği öneriyoruz.

Ancak kullanıcılarınızın kararsız bir internet bağlantısıyla uğraştığını düşünüyorsanız, mevcut olduğunda önbelleğe alınmış verileri döndürmek için 'return_cache_data_else_load' kullanmayı değerlendirin. Bu durumda kullanıcılar en son verilere ulaşamayabilir; ancak internet bağlantısı ne kadar kesintili olursa olsun daha hızlı yükleme süreleri yaşarlar. Önbellek düzenli olarak güncellendiğinden, ağ isteklerini önlemek amacıyla oturum sırasında kullanmak güvenlidir.

Önbelleğin, uygulama yeniden başlatıldığında bozulmadan kaldığını ve yalnızca uygulama yeniden yüklendiğinde veya manuel temizlik yapıldığında silindiğini unutmayın.