Engage SDK Shopping: Üçüncü taraf teknik entegrasyon talimatları

Kullanıcılarınıza bulundukları yerde ulaşarak uygulama etkileşimini artırın. Engage SDK'yı entegre ederek kişiselleştirilmiş önerileri ve devam içeriklerini doğrudan Koleksiyonlar, Entertainment Space ve Google Play Store gibi cihaz üzerindeki birden fazla yüzeyde kullanıcılara sunun. Entegrasyon, ortalama APK'ya 50 KB'tan daha az (sıkıştırılmış) boyut ekler ve çoğu uygulama için yaklaşık bir haftalık geliştirici süresi alır. Daha fazla bilgi için işletme sitemizi ziyaret edin.

Bu kılavuzda, geliştirici iş ortaklarının Engage içerik yüzeylerine alışveriş içeriği sunmasıyla ilgili talimatlar yer alır.

Kategori desteği ve yüzeyler

Engage SDK yüzey uygunluğu, uygulamanızın içerik kategorisine bağlıdır. Belirli platformlara uygunluk durumunuzu belirlemek için aşağıdaki tabloyu kullanın:

Durum İçerik kategorisi veya kullanım alanı Desteklenen yüzeyler
Desteklenir
(Tüm platformlarda kullanılabilir)
  • Kıyafet alışverişi
  • Online ticaret sitesi
  • Perakendeci
  • Yiyecek ve içecek alışverişi / market alışverişi
  • İndirimler ve kuponlar
  • Evcil hayvan / malzemeleri
  • Ev ve dekorasyon / Emlak
  • Koleksiyonlar
  • Google Play Store Uygulamalar sekmesi
  • Google Play Store'da "Siz" sekmesi
  • Google Play Store mağaza girişi sayfası
Desteklenmiyor
  • Alışveriş uygulaması
  • B2B Alışveriş
  • Satıcı uygulaması
  • Fiş Tarayıcı ödülleri
  • Telekomünikasyon hizmeti
  • Şimdi al sonra öde

Entegrasyon ayrıntıları

Bu bölümde, alışveriş içeriği için Engage SDK ile entegrasyon yapmak üzere gereken adımlar, veri modelleri ve terminoloji ayrıntılı olarak açıklanmaktadır.

Terminoloji

Bu entegrasyon şu beş küme türünü içerir: Öneri, Öne Çıkan, Alışveriş Sepeti, Alışveriş Listesi, Yeniden Sipariş Verme ve Alışveriş Siparişi Takibi.

  • Öneri kümeleri, tek bir geliştirici iş ortağının kişiselleştirilmiş alışveriş önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (ör. trend olan öğeler). Ürünleri, etkinlikleri, indirimleri, promosyonları ve abonelikleri öne çıkarmak için bu kartları kullanın.

    Önerileriniz aşağıdaki yapıya sahiptir:

    • Öneri kümesi: Aynı geliştirici iş ortağından gelen bir grup öneriyi içeren kullanıcı arayüzü görünümü.

    • ShoppingEntity: Bir kümedeki tek bir öğeyi temsil eden nesne.

  • Öne Çıkanlar kümesi, birden fazla geliştirici iş ortağının seçili öğelerini tek bir kullanıcı arayüzü grubunda gösterir. Tek bir Öne Çıkan kümesi olacak. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneri kümelerinin üzerinde öncelikli bir yerleşimle gösterilecek. Her geliştirici iş ortağının, Öne Çıkanlar kümesinde en fazla 10 öğe yayınlamasına izin verilir.

  • Alışveriş Sepeti kümesi, birçok geliştirici iş ortağının alışveriş sepetlerinin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıları bekleyen sepetlerini tamamlamaya teşvik eder. Kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm öneri kümelerinin üzerinde öncelikli yerleşime sahip tek bir Alışveriş Sepeti kümesi bulunur. Her geliştirici iş ortağının, Alışveriş Sepeti kümesinde en fazla 3 ShoppingCart örneği yayınlamasına izin verilir.

    Alışveriş sepetiniz aşağıdaki yapıya sahiptir:

    • Alışveriş Sepeti Kümesi: Birçok geliştirici iş ortağının alışveriş sepeti önizlemelerini içeren bir kullanıcı arayüzü görünümü.

    • ShoppingCart: Alışveriş sepeti kümesinde gösterilecek, tek bir geliştirici iş ortağının alışveriş sepeti önizlemesini temsil eden nesne. ShoppingCart, alışveriş sepetindeki toplam öğe sayısını göstermelidir ve kullanıcının alışveriş sepetindeki bazı öğelerin resimlerini de içerebilir.

  • Alışveriş Listesi kümesi, birden fazla geliştirici iş ortağının alışveriş listelerinin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıları, listelerini güncellemek ve tamamlamak için ilgili uygulamaya dönmeye yönlendirir. Tek bir Alışveriş Listesi kümesi vardır.

  • Yeniden sipariş ver kümesi, birden fazla geliştirici iş ortağından verilen önceki siparişlerin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıları yeniden sipariş vermeye teşvik eder. Tek bir yeniden sıralama kümesi vardır.

    • Yeniden sipariş kümesi, kullanıcının önceki siparişindeki toplam öğe sayısını göstermeli ve aşağıdakilerden birini de içermelidir:

      • Kullanıcının önceki siparişindeki X öğenin resimleri.
      • Kullanıcının önceki siparişindeki X öğe için etiketler.

  • Alışveriş Siparişi Takibi kümesi, birçok geliştirici iş ortağının bekleyen veya yakın zamanda tamamlanan alışveriş siparişlerinin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıların siparişlerini takip etmesine olanak tanır.

    Kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm öneri kümelerinin üzerinde öncelikli yerleşime sahip tek bir ShoppingOrderTracking kümesi gösterilir. Her geliştirici iş ortağının, Alışveriş Siparişi Takibi kümesinde birden fazla ShoppingOrderTrackingEntity öğesi yayınlamasına izin verilir.

    • ShoppingOrderTrackingCluster'ınız aşağıdaki yapıya sahiptir:

      • ShoppingOrderTracking Cluster: Birçok geliştirici iş ortağından gelen sipariş takibi önizlemelerini içeren bir kullanıcı arayüzü görünümü.
      • ShoppingOrderTrackingEntity: Alışveriş Siparişi Takibi kümesinde gösterilecek, tek bir geliştirici iş ortağı için alışveriş siparişi takibi önizlemesini temsil eden nesne. ShoppingOrderTrackingEntity, siparişin durumunu ve sipariş zamanını göstermelidir. ShoppingOrderTrackingEntity için beklenen teslimat süresini doldurmanızı önemle tavsiye ederiz. Bu bilgi, sağlandığında kullanıcılara gösterilir.

Ön çalışma

Minimum API düzeyi: 19

com.google.android.engage:engage-core kitaplığını uygulamanıza ekleyin:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.6.0'
}

Daha fazla bilgi için Android 11'de paket görünürlüğü başlıklı makaleyi inceleyin.

Özet

Tasarım, bağlama hizmetinin uygulanmasına dayanır.

Bir istemcinin yayınlayabileceği veriler, farklı küme türleri için aşağıdaki sınırlamalara tabidir:

Küme türü Küme sınırları Bir kümedeki maksimum öğe sınırları
Öneri kümeleri En fazla 7 En fazla 50 ShoppingEntity
Öne Çıkan Küme En fazla 1 En fazla 20 ShoppingEntity
Alışveriş Sepeti Kümesi En fazla 1 En fazla 3 ShoppingCart

Birden fazla alışveriş sepeti, yalnızca satıcı başına ayrı alışveriş sepeti olan uygulamalarda beklenir.

Alışveriş Listesi Kümesi En fazla 1 En fazla 3 ShoppingList
Alışveriş Yeniden Sipariş Kümesi En fazla 1 En fazla 1 ReorderEntity
Alışveriş Siparişi Takip Kümesi En fazla 3 En fazla 3 ShoppingOrderTrackingEntity

1. adım: Tüzel kişi verilerini sağlayın

SDK, her öğe türünü temsil etmek için farklı varlıklar tanımlamıştır. Alışveriş kategorisi için aşağıdaki varlıklar desteklenir:

  1. ShoppingEntity
  2. ShoppingCart
  3. ShoppingList
  4. Reorder
  5. ShoppingOrderTracking

Aşağıdaki grafiklerde, her tür için kullanılabilir özellikler ve şartlar özetlenmiştir.

ShoppingEntity

ShoppingEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bir ürünü, promosyonu, fırsatı, aboneliği veya etkinliği temsil eder.

ShoppingEntity
Özellik Şartlar Açıklama Biçim
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yönergeler için Resim Özellikleri'ni inceleyin.
İşlem URI'si Zorunlu

Uygulamada, öğeyle ilgili ayrıntıların gösterildiği sayfanın derin bağlantısı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

URI
Başlık İsteğe bağlı Varlığın adı.

Serbest metin

Önerilen metin boyutu: 90 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Fiyat - mevcut Koşula bağlı olarak gerekli

Varlığın geçerli fiyatı.

Üstü çizili fiyat sağlanmışsa bu değer de sağlanmalıdır.

Serbest metin
Fiyat - üstü çizili İsteğe bağlı Öğenin orijinal fiyatı. Kullanıcı arayüzünde bu fiyatın üzeri çizilir. Serbest metin
Açıklama metni İsteğe bağlı Varsa varlıkla ilgili bir promosyonu, etkinliği veya güncellemeyi öne çıkarmak için açıklama metni.

Serbest metin

Önerilen metin boyutu: 45 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Açıklama metniyle ilgili ayrıntılar İsteğe bağlı Açıklama metni için ek bilgi metni.

Serbest metin

Önerilen metin boyutu: 45 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Puan (İsteğe bağlı) - Not: Tüm puanlar standart yıldız puanı sistemimiz kullanılarak gösterilir.
Derecelendirme - Maksimum değer İsteğe bağlı

Derecelendirme ölçeğinin maksimum değeri.

Derecelendirmenin mevcut değeri de sağlanıyorsa sağlanmalıdır.

 Sayı >= 0,0
Derecelendirme - Geçerli değer İsteğe bağlı

Puan ölçeğinin mevcut değeri.

Derecelendirmenin maksimum değeri de sağlanıyorsa bu değer de sağlanmalıdır.

 Sayı >= 0,0
Puan - Sayı İsteğe bağlı

Öğenin puan sayısı.

Not: Uygulamanız, sayının kullanıcılara nasıl gösterileceğini kontrol ediyorsa bu alanı doldurun. Kısa bir dize kullanın. Örneğin, sayı 1.000.000 ise sayının daha küçük ekran boyutlarında kesilmemesi için 1M gibi bir kısaltma kullanabilirsiniz.

Dize
Derecelendirme - Sayı Değeri İsteğe bağlı

Öğenin puan sayısı.

Not: Görüntülenen kısaltma mantığını kendiniz yönetmiyorsanız bu alanı doldurun. Hem Sayı hem de Sayı Değeri mevcutsa kullanıcılara Sayı gösterilir.

 Uzun
DisplayTimeWindow (İsteğe bağlı) - İçeriğin yüzeyde gösterileceği bir zaman aralığı belirleyin
Başlangıç Zaman Damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmesi gereken zaman damgası.

Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur.

 Milisaniye cinsinden Unix zaman damgası
Bitiş Zaman Damgası İsteğe bağlı

İçeriğin artık yüzeyde gösterilmeyeceği zaman damgası.

Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur.

 Milisaniye cinsinden Unix zaman damgası

ShoppingCart

Özellik Şartlar Açıklama Biçim
İşlem URI'si Zorunlu

İş ortağının uygulamasındaki alışveriş sepetine yönlendiren derin bağlantı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

URI
Öğe sayısı Zorunlu

Alışveriş sepetindeki öğelerin sayısı (yalnızca ürün sayısı değil).

Örneğin: Alışveriş sepetinde 3 adet aynı gömlek ve 1 adet şapka varsa bu sayı 4 olmalıdır.

Tam sayı >= 1
İşlem Metni İsteğe bağlı

Alışveriş sepetindeki düğmenin harekete geçirici mesaj metni (ör. Alışveriş Çantanız).

Geliştirici tarafından işlem metni sağlanmazsa varsayılan olarak Alışveriş sepetini göster kullanılır.

Bu özellik, 1.1.0 ve sonraki sürümlerde desteklenir.

Dize
Başlık İsteğe bağlı

Alışveriş sepetinin başlığı (örneğin, Alışveriş Çantanız).

Geliştirici tarafından başlık sağlanmazsa varsayılan olarak Alışveriş sepetiniz kullanılır.

Geliştirici iş ortağı her satıcı için ayrı bir alışveriş sepeti yayınlıyorsa lütfen başlığa satıcı adını ekleyin.

Serbest metin

Önerilen metin boyutu: 25 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Alışveriş sepeti resimleri İsteğe bağlı

Sepetteki her ürünün resimleri.

Öncelik sırasına göre en fazla 10 resim sağlanabilir. Gösterilen resimlerin gerçek sayısı, cihazın form faktörüne bağlıdır.

 Yönergeler için Resim Özellikleri'ni inceleyin.
Öğe etiketleri İsteğe bağlı

Alışveriş listesindeki öğelerin etiket listesi.

Gösterilen etiket sayısı, cihazın form faktörüne bağlıdır.

Serbest metin etiketlerinin listesi

Önerilen metin boyutu: 20 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Son kullanıcı etkileşimi zaman damgası İsteğe bağlı Kullanıcının alışveriş sepetiyle son etkileşimde bulunduğu zamanı tanımlayan, başlangıçtan itibaren geçen milisaniye sayısı.

Bu, satıcı başına ayrı alışveriş sepeti yayınlayan geliştirici iş ortakları tarafından giriş olarak iletilir ve sıralama için kullanılabilir.

Milisaniye cinsinden Unix zaman damgası
DisplayTimeWindow (İsteğe bağlı) - İçeriğin yüzeyde gösterileceği bir zaman aralığı belirleyin
Başlangıç Zaman Damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmesi gereken zaman damgası.

Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur.

 Milisaniye cinsinden Unix zaman damgası
Bitiş Zaman Damgası İsteğe bağlı

İçeriğin artık yüzeyde gösterilmeyeceği zaman damgası.

Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur.

 Milisaniye cinsinden Unix zaman damgası

ShoppingList

Özellik Şartlar Açıklama Biçim
İşlem URI'si Zorunlu

İş ortağının uygulamasındaki alışveriş listesine yönlendiren derin bağlantı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

URI
Öğe sayısı Zorunlu Alışveriş listesindeki öğe sayısı. Tam sayı >= 1
Başlık İsteğe bağlı

Listenin başlığı (ör. Market Alışverişi Listeniz).

Geliştirici tarafından başlık sağlanmazsa varsayılan olarak Alışveriş listesi kullanılır.

Serbest metin

Önerilen metin boyutu: 25 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Öğe etiketleri Zorunlu

Alışveriş listesindeki öğelerin etiket listesi.

En az 1 etiket sağlanmalıdır ve öncelik sırasına göre en fazla 10 etiket sağlanabilir. Gösterilen etiketlerin gerçek sayısı, cihazın form faktörüne bağlıdır.

Serbest metin etiketlerinin listesi

Önerilen metin boyutu: 20 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Son kullanıcı etkileşimi zaman damgası Zorunlu Kullanıcının alışveriş listesiyle son etkileşimde bulunduğu zamanı tanımlayan, başlangıçtan itibaren geçen milisaniye sayısı. Milisaniye cinsinden Unix zaman damgası

ShoppingReorderCluster

Özellik Şartlar Açıklama Biçim
İşlem URI'si Zorunlu

İş ortağının uygulamasında yeniden sipariş vermek için kullanılan derin bağlantı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

URI
İşlem Metni İsteğe bağlı

Yeniden sipariş ver düğmesinin harekete geçirici mesaj metni (ör. Tekrar sipariş ver).

Geliştirici tarafından işlem metni sağlanmazsa varsayılan olarak Yeniden sipariş ver kullanılır.

Bu özellik, 1.1.0 ve sonraki sürümlerde desteklenir.

Dize
Öğe sayısı Zorunlu

Önceki siparişteki öğelerin sayısı (yalnızca ürün sayısı değil).

Örneğin: Önceki siparişte 3 küçük kahve ve 1 kruvasan varsa bu sayı 4 olmalıdır.

Tam sayı >= 1
Başlık Zorunlu Yeniden sipariş edilen öğenin başlığı.

Serbest metin

Önerilen metin boyutu: 40 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Öğe etiketleri

İsteğe bağlı

(Sağlanmazsa poster resimleri sağlanmalıdır)

Önceki siparişin öğe etiketlerinin listesi.

Öncelik sırasına göre en fazla 10 etiket sağlanabilir. Gösterilen etiket sayısı, cihazın form faktörüne bağlıdır.

Serbest metin listesi

Etiket başına önerilen metin boyutu: 20 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)

Poster resimleri

İsteğe bağlı

(Sağlanmazsa öğe etiketleri sağlanmalıdır.)

Önceki siparişteki ürünlerin resimleri.

Öncelik sırasına göre en fazla 10 resim sağlanabilir. Gösterilen resimlerin gerçek sayısı, cihazın form faktörüne bağlıdır.

 Yönergeler için Resim Özellikleri'ni inceleyin.

ShoppingOrderTrackingCluster

Özellik Şartlar Açıklama Biçim
Başlık Zorunlu

Takip edilen paketin/öğelerin kısa başlığı veya takip numarası.

Serbest metin

Önerilen metin boyutu: 50 karakter (Çok uzun metinlerde üç nokta gösterilir)

Sipariş Türü Zorunlu

Takip edilen paketin/öğelerin kısa başlığı veya takip numarası.

Enum: IN_STORE_PICKUP, SAME_DAY_DELIVERY, MULTI_DAY_DELIVERY
Durum Zorunlu

Siparişin mevcut durumu.

Örneğin: "Gecikme var", "Taşınıyor", "Gecikti", "Gönderildi", "Teslim edildi", "Stokta yok", "Sipariş hazır"

Serbest metin

Önerilen metin boyutu: 25 karakter (Çok uzun metinlerde üç nokta gösterilir)

Sipariş Zamanı Zorunlu

Siparişin verildiği milisaniye cinsinden sıfır zaman damgası.

Tahmini teslimat süresi aralığı yoksa sipariş süresi gösterilir

 Milisaniye cinsinden Unix zaman damgası
İşlem URI'si Zorunlu

İş ortağının uygulamasındaki sipariş takibine yönlendiren derin bağlantı.

 URI
OrderDeliveryTimeWindow (İsteğe bağlı) - Siparişin verildiği andan beklenen/gerçek teslimat zamanına kadar takip edilen sipariş için bir zaman aralığı belirleyin.
OrderDeliveryTimeWindow - Start Time İsteğe bağlı

Siparişin teslim edileceği veya teslim alınmaya hazır olacağı milisaniye cinsinden sıfır zaman damgası.

 Milisaniye cinsinden Unix zaman damgası
OrderDeliveryTimeWindow - End Time İsteğe bağlı

Siparişin teslim edileceği veya teslim alınmaya hazır olacağı milisaniye cinsinden zaman damgası.

Milisaniye cinsinden Unix zaman damgası
Poster resimleri İsteğe bağlı

Sipariş kapsamındaki bir öğenin/ürünün resmi.

Önerilen en-boy oranı 1:1'dir.

 Yönergeler için Resim Özellikleri'ni inceleyin.
Öğe sayısı İsteğe bağlı Siparişteki öğelerin sayısı. Tam sayı >= 1
Açıklama İsteğe bağlı

Siparişteki öğeleri açıklayan tek bir metin paragrafı.

Not: Kullanıcıya açıklama veya alt başlık listesinden biri gösterilir, ikisi birden gösterilmez.

Serbest metin

Önerilen metin boyutu: 180 karakter
Altyazı listesi İsteğe bağlı

Her biri tek satırlık metinden oluşan en fazla 3 alt başlık.

Not: Kullanıcıya açıklama veya alt başlık listesinden biri gösterilir, ikisi birden gösterilmez.

Serbest metin

Her alt yazı için önerilen metin boyutu: maks. 50 karakter
Sipariş Değeri - CurrentPrice İsteğe bağlı Siparişin mevcut değeri. Serbest metin
Sipariş numarası İsteğe bağlı Siparişi benzersiz şekilde tanımlamak için kullanılabilecek sipariş numarası/kimliği.

Serbest metin

Önerilen metin boyutu: Maksimum 25 karakter
Takip numarası İsteğe bağlı Siparişin teslimat gerektirmesi durumunda sipariş/paket teslimatının takip numarası.

Serbest metin

Önerilen metin boyutu: Maksimum 25 karakter

Resim özellikleri

Aşağıdaki tabloda, resim öğeleri için gerekli özellikler listelenmiştir:

En boy oranı Minimum piksel sayısı Önerilen piksel sayısı

Kare (1x1)

Öne çıkarılmayan kümeler için tercih edilir

 300x300 1200x1200

Yatay (1,91x1)

Öne çıkan kümeler için tercih edilen

 600x314 1200x628
Dikey (4x5) 480x600 960x1200

Dosya biçimleri

PNG, JPG, statik GIF, WebP

Maksimum dosya boyutu

5.120 KB

Ek öneriler

  • Resim güvenli alanı: Önemli içeriklerinizi yatay ve dikey yönde ortalanmış olarak resmin% 80'ini kaplayacak şekilde yerleştirin.
  • Resmin koyu ve açık tema ayarlarında düzgün şekilde gösterilebilmesi için şeffaf bir arka plan kullanın.

2. adım: Küme verilerini sağlama

İçerik yayınlama işinin arka planda yürütülmesi (ör. WorkManager kullanılarak) ve düzenli olarak ya da bir etkinliğe göre (ör. kullanıcı uygulamayı her açtığında veya sepetine bir şey eklediğinde) planlanması önerilir.

Alışveriş kümelerini yayınlamaktan AppEngageShoppingClient sorumludur.

İstemcideki kümeleri yayınlamak için aşağıdaki API'ler kullanılır:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishShoppingCarts
  • publishShoppingLists
  • publishShoppingReorderCluster
  • publishShoppingOrderTrackingCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteShoppingCartCluster
  • deleteShoppingListCluster
  • deleteReorderCluster
  • deleteShoppingOrderTrackingCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

Bu API, hizmetin entegrasyon için kullanılabilir olup olmadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.

Yayınlamayı planladığınız her küme türü için hizmet kullanılabilirliğini kontrol edebilirsiniz. isServiceAvailable API'si, hizmet kullanılabilirliğinin kontrol edilmesi gereken küme türlerini içeren bir istek nesnesi (ServiceAvailabilityRequest) kabul eder. ServiceAvailabilityRequest için gereken ClusterType enum değerlerini aşağıdaki tabloda bulabilirsiniz.

Cluster Type (Küme Türü) Küme Türü Sabiti Tam Sayı Değeri
Bilinmiyor TYPE_UNKNOWN 0
Öneri Kümesi TYPE_RECOMMENDATION 1
Öne Çıkan Küme TYPE_FEATURED 2
Devam Kümesi TYPE_CONTINUATION 3
Alışveriş Sepeti Kümesi TYPE_SHOPPING_CART 4
Kullanıcı Yönetimi Kümesi TYPE_ENGAGEMENT 8
Alışveriş Listesi Kümesi TYPE_SHOPPING_LIST 9
Alışveriş Yeniden Sipariş Kümesi TYPE_SHOPPING_REORDER 10
Alışveriş Siparişi Takip Kümesi TYPE_SHOPPING_ORDER_TRACKING 11
Abonelik Kümesi TYPE_SUBSCRIPTION 12

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});
Koşullu Hizmet Kullanılabilirliği Özelliği

Bazı entegre uygulamalar, yayınlama maliyetlerini azaltmak için Engage hizmetini aralıklı olarak etkinleştiren ve devre dışı bırakan özel bir yapılandırma ister. Ancak bu aralıklı içerik besleme stratejisi, kullanıcı deneyimini olumsuz etkiler: Eski içerikler sunulmaz ve bazı platformlarda yayınlanmaz.

Engage SDK'sı, 1.6.0 sürümünden itibaren belirli küme türlerinin kullanılabilirliğini kontrol etmenize olanak tanır. Uygulamanız aralıklı besleme kullanıyorsa:

  • Devam kümeleri (ör. Alışveriş Sepeti, Alışveriş Listesi, Yeniden Sipariş Verme ve Alışveriş Siparişi Takibi) desteklenen tüm cihazlarda varsayılan olarak etkin kalır.
  • Diğer küme türleri (ör. Öneriler) aralıklı olarak etkinleştirilir ve devre dışı bırakılır.

Bu varsayılan yapılandırma ihtiyaçlarınıza uygun değilse engage-developers@google.com ile iletişime geçin.

1.6.0 sürümünden önceki SDK sürümleri için (Desteği sonlandırıldı)

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

Bu API, RecommendationCluster nesnelerinin listesini yayınlamak için kullanılır.

Bir RecommendationCluster nesnesi aşağıdaki özelliklere sahip olabilir:

Özellik Şartlar Açıklama
ShoppingEntity listesi Zorunlu Bu Öneri Kümesi için önerileri oluşturan ShoppingEntity nesnelerinin listesi.
Başlık Zorunlu

Öneri kümesinin başlığı.

Önerilen metin boyutu: 25 karakterden az (Çok uzun metinlerde üç nokta gösterilebilir)
Alt başlık İsteğe bağlı Öneri kümesinin alt başlığı.
İşlem URI'si İsteğe bağlı

Kullanıcıların önerilerin tam listesini görebileceği iş ortağı uygulamasındaki sayfanın derin bağlantısı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build());

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Mevcut tüm Öneri Kümesi verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve yeni öneri kümelerinde depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

publishFeaturedCluster

Bu API, bir FeaturedCluster nesnesi yayınlamak için kullanılır.

Kotlin

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        ...
                        .build())
                .build());

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut FeaturedCluster verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenen Öne Çıkan Küme'de depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingCarts

Bu API, ShoppingCart nesnelerinin listesini yayınlamak için kullanılır. Bu, her satıcı için ayrı alışveriş sepetleri yayınlayan geliştirici iş ortakları için geçerlidir. Bu API'yi kullanırken başlığa satıcı adını ekleyin.

Kotlin

client.publishShoppingCarts(
            PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingCarts(
            new PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut ShoppingCart verileri kaldırılır.
  • İstekten alınan veriler ayrıştırılır ve güncellenen Alışveriş Sepeti Kümesi'nde depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingLists

Bu API, ShoppingList nesnelerinin listesini yayınlamak için kullanılır.

Kotlin

client.publishShoppingLists(
            PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    ShoppingList.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingLists(
            new PublishShoppingListsRequest.Builder()
                .addShoppingList(
                    new ShoppingList.Builder()
                        ...
                        .build())
                .build());

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut ShoppingList verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenen Alışveriş Listesi Kümesi'nde depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingReorderCluster

Bu API, bir ShoppingReorderCluster nesnesi yayınlamak için kullanılır.

Kotlin

client.publishShoppingReorderCluster(
            PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingReorderCluster(
            new PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    new ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build());

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut ShoppingReorderCluster verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenen yeniden sıralama kümesinde depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingOrderTrackingCluster

Bu API, bir ShoppingOrderTrackingCluster nesnesi yayınlamak için kullanılır.

Kotlin

client.publishShoppingOrderTrackingCluster(
            PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishShoppingOrderTrackingCluster(
            new PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    new ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build());

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut ShoppingOrderTrackingCluster verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenen Alışveriş Siparişi Takip Kümesi'nde depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

publishUserAccountManagementRequest

Bu API, oturum açma kartı yayınlamak için kullanılır . Oturum açma işlemi, kullanıcıları uygulamanın oturum açma sayfasına yönlendirir. Böylece uygulama, içerik yayınlayabilir (veya daha kişiselleştirilmiş içerik sunabilir).

Aşağıdaki meta veriler, Oturum Açma Kartı'nın bir parçasıdır:

Özellik Şartlar Açıklama
İşlem URI'si Zorunlu İşleme derin bağlantı (ör. uygulama oturum açma sayfasına yönlendirir)
Resim İsteğe bağlı: Sağlanmazsa başlık sağlanmalıdır.

Kartta gösterilen resim

1264x712 çözünürlüğe sahip 16x9 en boy oranlı resimler
Başlık İsteğe bağlı: Sağlanmazsa resim sağlanmalıdır. Karttaki başlık
İşlem Metni İsteğe bağlı CTA'da gösterilen metin (ör. Oturum açın)
Alt başlık İsteğe bağlı Karttaki İsteğe Bağlı Altyazı

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Hizmet isteği aldığında tek bir işlemde aşağıdaki eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut UserAccountManagementCluster verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenen UserAccountManagementCluster kümesinde depolanır.

Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

updatePublishStatus

Dahili bir işletme nedeni nedeniyle kümelerden hiçbiri yayınlanmazsa updatePublishStatus API'yi kullanarak yayınlama durumunu güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü :

  • İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumun sağlanması, entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu açık durumu kullanan kontrol panellerini doldurmak açısından çok önemlidir.
  • Hiçbir içerik yayınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemeyebilir. İçeriğin, sağlayıcı açısından beklenen bir durum nedeniyle yayınlanmadığını onaylar.
  • Geliştiricilerin, verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında bilgi vermesine yardımcı olur.
  • Google, kullanıcıyı uygulamada belirli işlemleri yapmaya teşvik etmek için durum kodlarını kullanabilir. Böylece kullanıcı, uygulama içeriğini görebilir veya sorunu çözebilir.

Uygun yayınlama durumu kodlarının listesi şunlardır :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

İçerik, kullanıcının giriş yapmaması nedeniyle yayınlanmıyorsa Google, oturum açma kartının yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamazsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini çağırmalarını öneririz.

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationsClusters

Bu API, öneri kümelerinin içeriğini silmek için kullanılır.

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

Hizmet, isteği aldığında mevcut verileri Öneri Kümeleri'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteFeaturedCluster

Bu API, Öne Çıkan Küme'nin içeriğini silmek için kullanılır.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Hizmet, isteği aldığında mevcut verileri Öne Çıkan Küme'den kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingCartCluster

Bu API, Alışveriş Sepeti Kümesi'nin içeriğini silmek için kullanılır.

Kotlin

client.deleteShoppingCartCluster()

Java

client.deleteShoppingCartCluster();

Hizmet, isteği aldığında mevcut verileri Alışveriş Sepeti Kümesi'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingListCluster

Bu API, Alışveriş Listesi Kümesi'nin içeriğini silmek için kullanılır.

Kotlin

client.deleteShoppingListCluster()

Java

client.deleteShoppingListCluster();

Hizmet, isteği aldığında mevcut verileri Alışveriş Listesi Kümesi'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteReorderCluster

Bu API, Alışveriş Yeniden Sipariş Kümesi'nin içeriğini silmek için kullanılır.

Kotlin

client.deleteReorderCluster()

Java

client.deleteReorderCluster();

Hizmet, isteği aldığında mevcut verileri Alışveriş Yeniden Sipariş Kümesi'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingOrderTrackingCluster

Bu API, Alışveriş Siparişi Takip Kümesi'nin içeriğini silmek için kullanılır.

Kotlin

client.deleteShoppingOrderTrackingCluster()

Java

client.deleteShoppingOrderTrackingCluster();

Hizmet, isteği aldığında mevcut verileri Alışveriş Siparişi Takip Kümesi'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteUserManagementCluster

Bu API, UserAccountManagement kümesinin içeriğini silmek için kullanılır.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Hizmet, isteği aldığında mevcut verileri UserAccountManagement kümesinden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteClusters

Bu API, belirli bir küme türünün içeriğini silmek için kullanılır.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                ...
                .build());

Hizmet, isteği aldığında mevcut verileri belirtilen küme türleriyle eşleşen tüm kümelerden kaldırır. İstemciler bir veya daha fazla küme türü iletmeyi seçebilir. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

Hata işleme

Başarılı bir görevi kurtarmak ve yeniden göndermek için takip işlemi yapılabilmesi amacıyla, yayınlama API'lerinden gelen görev sonucunu dinlemeniz önemle tavsiye edilir.

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

Hata, nedenini hata kodu olarak içeren bir AppEngageException olarak döndürülür.

Hata kodu Hata adı Not
1 SERVICE_NOT_FOUND Hizmet, belirtilen cihazda kullanılamıyor.
2 SERVICE_NOT_AVAILABLE Hizmet, belirtilen cihazda kullanılabilir ancak çağrı sırasında kullanılamaz (örneğin, açıkça devre dışı bırakılmıştır).
3 SERVICE_CALL_EXECUTION_FAILURE İş parçacığı sorunları nedeniyle görev yürütülemedi. Bu durumda işlem yeniden denenebilir.
4 SERVICE_CALL_PERMISSION_DENIED Arayanın hizmet çağrısı yapmasına izin verilmiyor.
5 SERVICE_CALL_INVALID_ARGUMENT İstek geçersiz veriler içeriyor (örneğin, izin verilen küme sayısından fazla küme).
6 SERVICE_CALL_INTERNAL Hizmet tarafında bir hata var.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Hizmet çağrısı çok sık yapılıyor.

3. adım: Yayın amaçlarını işleme

İçerik yayınlama Content API çağrılarını bir iş aracılığıyla yapmanın yanı sıra içerik yayınlama isteğini almak için bir BroadcastReceiver ayarlamanız da gerekir.

Yayın intent'lerinin amacı, genellikle uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorunlu kılmaktır. Yayın intent'leri çok sık gönderilecek şekilde tasarlanmamıştır. Yalnızca Engage hizmeti, içeriğin eski (ör. bir haftalık) olabileceğini belirlediğinde tetiklenir. Bu sayede, uygulama uzun bir süre çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğinden daha emin olunur.

BroadcastReceiver, aşağıdaki iki şekilde ayarlanmalıdır:

  • Context.registerReceiver() kullanarak BroadcastReceiver sınıfının bir örneğini dinamik olarak kaydedin. Bu sayede, bellekte hâlâ etkin olan uygulamalardan iletişim sağlanabilir.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION
  // broadcast is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is
  // received
  // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast
  // is received
  // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
  // received
  // Trigger shopping order tracking cluster publish when
  // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER broadcast is received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is
// received

// Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
// broadcast is received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Order Tracking Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

}

  • AndroidManifest.xml dosyanızda <receiver> etiketiyle bir uygulama statik olarak beyan edilmelidir. Bu, uygulamanın çalışmadığı zamanlarda yayın intent'lerini almasına ve içeriği yayınlamasına olanak tanır.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

Hizmet tarafından aşağıdaki intent'ler gönderilir:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu intent alındığında publishRecommendationClusters araması başlatılması önerilir.
  • com.google.android.engage.action.PUBLISH_FEATURED Bu intent alındığında publishFeaturedCluster çağrısı başlatılması önerilir.
  • com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Bu intent alındığında publishShoppingCarts çağrısı başlatılması önerilir.
  • com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Bu intent alındığında publishShoppingLists çağrısı başlatılması önerilir.
  • com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Bu intent alındığında publishReorderCluster çağrısı başlatılması önerilir.
  • com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Bu intent alındığında publishShoppingOrderTrackingCluster araması başlatmanız önerilir.

Entegrasyon iş akışı

Entegrasyonunuz tamamlandıktan sonra doğrulama işlemiyle ilgili adım adım açıklamalı kılavuz için Engage geliştirici entegrasyonu iş akışı başlıklı makaleyi inceleyin.

SSS

Sık sorulan sorular için Engage SDK Sık Sorulan Sorular bölümüne bakın.

İletişim

Entegrasyon sürecinde herhangi bir sorunuz olursa engage-developers@google.com ile iletişime geçin. Ekibimiz en kısa sürede yanıt verecektir.

Sonraki adımlar

Bu entegrasyonu tamamladıktan sonraki adımlarınız şunlardır:

  • engage-developers@google.com adresine bir e-posta gönderin ve Google tarafından test edilmeye hazır olan entegre APK'nızı ekleyin.
  • Google, entegrasyonun beklendiği gibi çalıştığından emin olmak için dahili olarak doğrulama ve inceleme yapar. Değişiklik gerekmesi durumunda Google, gerekli ayrıntıları paylaşmak için sizinle iletişime geçer.
  • Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre edilmiş APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
  • Google, güncellenmiş APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri, Öne Çıkanlar, Alışveriş Sepeti, Alışveriş Listesi, Yeniden Sipariş Kümesi ve Alışveriş Siparişi Takip Kümesi kümeleriniz yayınlanabilir ve kullanıcılara gösterilebilir.