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

Google, kullanıcıların uygulamalarını sektörlere göre düzenleyen ve kişiselleştirilmiş uygulama içeriği tüketimi ve keşfi için yeni bir sürükleyici deneyim sunan cihaz üzerinde bir yüzey oluşturuyor. Bu tam ekran deneyimi, geliştirici iş ortaklarına en iyi zengin içeriklerini uygulamalarının dışında özel bir kanalda sergileme fırsatı sunar.

Bu kılavuzda, geliştirici iş ortaklarının hem bu yeni platform alanını hem de mevcut Google platformlarını doldurmak için Engage SDK'sını kullanarak yemek içeriklerini entegre etme talimatları yer almaktadır.

Entegrasyon ayrıntısı

Terminoloji

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

  • Öneri kümeleri, belirli bir geliştirici iş ortağının yemekle ilgili kişiselleştirilmiş önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (örneğin, indirimde yeni). Yemek tarifleri, mağazalar, yemekler, market ürünleri ve benzeri yerleri uygun gördüğünüz şekilde sergilemek için bu etiketleri kullanabilirsiniz.

    • Öneri kümesi, ProductEntity, StoreEntity veya RecipeEntity girişlerinden oluşabilir ancak farklı öğe türlerinin bir karışımı olamaz.
    Şekil : "ProductEntity", "StoreEntity" ve "RecipeEntity". (*UI yalnızca açıklama amaçlıdır)

  • Öne Çıkan kümesi, birden fazla geliştirici iş ortağından alınmış çeşitli varlıkları tek bir kullanıcı arayüzü gruplandırmasında gösterir. Tek bir Öne Çıkan küme bulunur. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneriler kümelerinin üzerinde öncelikli olarak yerleştirilir. Her geliştirici iş ortağının, Öne Çıkanlar kümesinde en fazla 10 öğe yayınlamasına izin verilir.

    Şekil : "RecipeEntity" ile öne çıkan küme. (*Kullanıcı arayüzü yalnızca örnek amaçlıdır)

  • Food Shopping Cart kümesi, tek bir kullanıcı arayüzü grubunda birden fazla geliştirici iş ortağından gelen market alışveriş sepetlerine kısa bir bakış sunarak kullanıcılardan bekleyen alışveriş sepetlerini tamamlamalarını istiyor. Tek bir gıda alışveriş sepeti kümesi vardır.

    • Gıda Alışveriş Sepeti Kümesi, sepetteki toplam öğe sayısını göstermelidir ve kullanıcının sepetindeki X öğenin resimlerini de içerebilir.

      Şekil: Tek bir iş ortağından alınan gıda alışveriş sepeti kümesi. (*Yalnızca örnek amaçlı kullanıcı arayüzü)

  • Market Alışveriş Listesi kümesi, birden fazla geliştirici iş ortağının market alışverişi listelerinin bir kullanıcı arayüzü gruplandırmasında önizlemesini gösterir. Bu sayede kullanıcılar listelerini güncellemek ve tamamlamak için ilgili uygulamaya geri dönebilir. Tek bir Gıda Alışveriş Listesi kümesi vardır.

    Şekil: Tek bir iş ortağından alınan gıda alışveriş listesi kümesi. (*Kullanıcı arayüzü yalnızca örnek amaçlıdır)

  • Yeniden sipariş ver kümesi, birden fazla geliştirici iş ortağının önceki siparişlerini tek bir kullanıcı arayüzü gruplandırmasında gösterir ve kullanıcıları yeniden sipariş vermeye teşvik eder. Tek bir Yeniden sıralama kümesi var.

    • Yeniden sipariş kümesi, kullanıcının önceki siparişindeki toplam öğe sayısını göstermelidir 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.
    Şekil: Tek bir iş ortağından alınan yiyecek yeniden siparişi kümesi. (*Yalnızca örnek amaçlı kullanıcı arayüzü)

Ö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.5.2'
}

Özet

Tasarım, bağlı hizmet uygulamasına dayanır.

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

Küme türü Küme sınırları Bir kümedeki maksimum öğe sınırları
Öneri Kümeleri En fazla 5 En fazla 25 (ProductEntity, RecipeEntity veya StoreEntity)
Öne Çıkan Küme En fazla 1 En fazla 10 (ProductEntity, RecipeEntity veya StoreEntity)
Yemek Alışveriş Sepeti Kümesi En fazla 1 En fazla 1 ShoppingCartEntity
Yemek Alışveriş Listesi Kümesi En fazla 1 En fazla 1 ShoppingListEntity
Yemek Yeniden Sipariş Kümesi En fazla 1 En fazla 1 ReorderEntity

1. adım: Öğe verilerini sağlayın

SDK'da her öğe türünü temsil eden farklı varlıklar tanımlanmıştır. Gıda kategorisi için aşağıdaki varlıkları destekliyoruz:

  1. ProductEntity
  2. StoreEntity
  3. RecipeEntity
  4. FoodShoppingCart
  5. FoodShoppingList
  6. FoodReorderCluster

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

ProductEntity

ProductEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bağımsız bir öğeyi (ör. market ürünü, restoran yemeği veya promosyon) temsil eder.

Şekil : ProductEntity öğesinin özellikleri

Özellik Şartlar Açıklama Biçim
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın.
İşlem Uri Zorunlu

Uygulamadaki, ürünle ilgili ayrıntıları gösteren sayfanın derin bağlantısı.

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

URI
Başlık İsteğe bağlı Ürünün adı.

Serbest metin

Önerilen metin boyutu: 90 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Fiyat - mevcut Koşullu olarak zorunlu

Ürünün mevcut fiyatı.

Üzeri çizili fiyat sağlanıyorsa belirtilmelidir.

Serbest metin
Fiyat - üstü çizili İsteğe bağlı Öğenin orijinal fiyatı (kullanıcı arayüzünde üstü çizili olarak gösterilir). Serbest metin
Açıklama metni İsteğe bağlı Ürünle ilgili bir promosyonu, etkinliği veya güncellemeyi (varsa) öne çıkaran açıklama metni.

Serbest metin

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

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Derecelendirme (İsteğe bağlı) - Not: Tüm derecelendirmeler, standart yıldız derecelendirme sistemimiz kullanılarak gösterilir.
Puan - 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
Puan - Geçerli değer İsteğe bağlı

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

Maksimum puan değeri de sağlanmışsa sağlanmalıdır.

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

Ürünün aldığı puanların sayısı.

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

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

Ürünün aldığı puanların sayısı.

Not: Gösterim kısaltması mantığını kendiniz yönetmezseniz bu alanı sağlayın. Hem Sayı hem de Sayı Değeri varsa kullanıcılara Sayı gösterilir.

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

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

Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur.

 Milisaniye cinsinden Unix sıfır zaman damgası
Bitiş zaman damgası İsteğe bağlı

İçeriğin artık ilk sayfada gösterilmediği dönem zaman damgası.

Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur.

 Milisaniye cinsinden Unix sıfır zaman damgası

StoreEntity

StoreEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bağımsız bir mağazayı (ör. restoran veya market) temsil eder.

Şekil : StoreEntity öğesinin özellikleri

Özellik Şartlar Açıklama Biçim
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri bölümüne bakın.
İşlem Uri Zorunlu

Uygulamadaki mağazayla 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'ye bakın

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

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinde üç nokta gösterilebilir)
Konum İsteğe bağlı Mağazanın konumu.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Açıklama metni İsteğe bağlı Mağazanın promosyonunu, etkinliğini veya güncellemesini öne çıkaran açıklama metni (varsa).

Serbest metin

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

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinde üç nokta gösterilebilir)
Açıklama İsteğe bağlı Mağazayla ilgili açıklama.

Serbest metin

Önerilen metin boyutu: 90 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
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
Puan - Geçerli değer İsteğe bağlı

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

Maksimum puan değeri de sağlanmışsa sağlanmalıdır.

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

Mağazanın puan sayısı.

Not: Uygulamanız bu öğenin kullanıcılara nasıl gösterileceğini kontrol etmek istiyorsa bu alanı sağlayın. Kullanıcıya gösterilebilecek kısa bir dize sağlayın. Örneğin, sayı 1.000.000 ise daha küçük ekran boyutlarında kısaltılmaması için 1M gibi kısaltmalar kullanabilirsiniz.

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

Mağazanın puan sayısı.

Not: Gösterim kısaltması mantığını kendiniz yönetmek istemiyorsanız bu alanı sağlayın. Hem Sayı hem de Sayı Değeri varsa kullanıcılara göstermek için Sayı değerini kullanırız

 Uzun

RecipeEntity

RecipeEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bir yemek tarifi öğesini temsil eder.

Şekil : RecipeEntity Özelliğinin Özellikleri

Özellik Şartlar Açıklama Biçim
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri'ne bakın.
İşlem Uri Zorunlu

Tarifle ilgili ayrıntıların gösterildiği uygulamadaki sayfanın derin bağlantısı.

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

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

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Yazar İsteğe bağlı Tarifin yazarı.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Pişirme/Hazırlık süresi İsteğe bağlı Tarifin pişirme süresi.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Açıklama metni İsteğe bağlı Tarifle ilgili bir promosyonu, etkinliği veya güncellemeyi (varsa) öne çıkaran açıklama metni.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Kategori İsteğe bağlı Tarifin kategorisi.

Serbest metin

Önerilen metin boyutu: 45 karakterden kısa (Çok uzun metinde üç nokta gösterilebilir)
Açıklama İsteğe bağlı Tarifin açıklaması.

Serbest metin

Önerilen metin boyutu: 90 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Not: Tüm puanlar standart yıldız puanlama sistemimizle 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
Puan - Geçerli değer İsteğe bağlı

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

Maksimum puan değeri de sağlanmışsa sağlanmalıdır.

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

Tarifin aldığı puanların sayısı.

Not: Uygulamanız bu öğenin kullanıcılara nasıl gösterileceğini kontrol etmek istiyorsa bu alanı sağlayın. Kullanıcıya gösterilebilecek kısa bir dize sağlayın. Örneğin, sayı 1.000.000 ise daha küçük ekran boyutlarında kısaltılmaması için 1M gibi kısaltmalar kullanabilirsiniz.

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

Tarifin aldığı puanların sayısı.

Not: Gösterim kısaltması mantığını kendiniz yönetmek istemiyorsanız bu alanı sağlayın. Hem Sayı hem de Sayı Değeri varsa kullanıcılara göstermek için Sayı değerini kullanırız

 Uzun

FoodShoppingCart

Şekil: Gıda Alışveriş Sepeti küme özellikleri.

Özellik Şartlar Açıklama Biçim
İşlem Uri Zorunlu

İş ortağının uygulamasındaki alışveriş sepetinin derin bağlantısı.

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

URI
Ürün sayısı Zorunlu

Alışveriş sepeti

Örneğin: Alışveriş sepetinde 3 portakal ve 1 elma varsa bu sayı 4 olmalıdır.

 Tam sayı >= 1
Başlık İsteğe bağlı

Alışveriş sepetinin başlığı (örneğin, Alışveriş sepetiniz).

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

Serbest metin

Önerilen metin boyutu: 25 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
İşlem Metni İsteğe bağlı

Alışveriş sepeti düğmesinin 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örüntüle kullanılır.

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

Dize
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 form faktörüne bağlıdır.

 Yardım için Resim Özellikleri bölümüne bakın.
Öğe etiketleri İsteğe bağlı

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

Görüntülenen etiketlerin gerçek sayısı, cihazın form faktörüne bağlıdır.

Serbest metin etiketlerinin listesi

Önerilen metin boyutu: 20 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
DisplayTimeWindow (İsteğe bağlı) - Bir içeriğin yüzeyde gösterileceği bir zaman aralığı belirleme
Başlangıç zaman damgası İsteğe bağlı

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

Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur.

 Milisaniye cinsinden Unix sıfır zaman damgası
Bitiş zaman damgası İsteğe bağlı

İçeriğin artık ilk sayfada gösterilmediği dönem zaman damgası.

Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur.

 Milisaniye cinsinden Unix sıfır zaman damgası

FoodShoppingList

Şekil: Gıda Alışveriş Listesi kümesi.

Özellik Şartlar Açıklama Biçim
İşlem Uri Zorunlu

İş ortağının uygulamasındaki alışveriş listesinin derin bağlantısı.

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

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

Listenin başlığı (ör. Alışveriş 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 kısa (Çok uzun metinde üç nokta gösterilebilir)
Öğe etiketleri Zorunlu

Alışveriş listesindeki öğelerin etiketlerinin 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 form faktörüne bağlıdır.

Serbest metin etiketlerinin listesi

Önerilen metin boyutu: 20 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)

FoodReorderCluster

Şekil: Yemek Siparişini Yeniden Düzenle kümesi.

Özellik Şartlar Açıklama Biçim
İşlem Uri Zorunlu

İş ortağının uygulamasında yeniden sipariş verilecek derin bağlantı.

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

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

Yeniden sırala düğmesindeki 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 sürümü ve sonraki sürümlerde desteklenir.

Dize
Ürün sayısı Zorunlu

Önceki siparişteki öğe 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 verilen öğenin başlığı.

Serbest metin

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

İsteğe bağlı

(Yayınlanmamışsa 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 etiketlerin gerçek sayısı cihaz form faktörüne bağlıdır.

Serbest metin listesi

Etiket başına önerilen metin boyutu: 20 karakterden kısa (Çok uzun metinler üç noktayla gösterilebilir)
Poster resimleri

İsteğe bağlı

(Yok ise öğe etiketleri sağlanmalıdır)

Önceki siparişteki öğelerin resimleri.

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

 Yardım için Resim Özellikleri bölümüne bakın.

Resim özellikleri

Resim öğeleri için gerekli özellikler aşağıda listelenmiştir:

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

Kare (1x1)

Tercih edilen

 300x300 1.200x1.200
Yatay (1,91x1) 600x314 1.200x628
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 ortaya, resmin% 80'lik kısmına yerleştirin.
  • Resmin Koyu ve Açık tema ayarlarında düzgün bir şekilde gösterilebilmesi için şeffaf bir arka plan kullanın.

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

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

AppEngageFoodClient, gıda kümelerini yayınlamaktan sorumludur.

İstemcide kümeleri yayınlamak için aşağıdaki API'ler vardır:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishFoodShoppingCart
  • publishFoodShoppingList
  • publishReorderCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteFoodShoppingCartCluster
  • deleteFoodShoppingListCluster
  • deleteReorderCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

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

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.

RecommendationCluster nesneleri aşağıdaki özelliklere sahip olabilir:

Özellik Şartlar Açıklama
ProductEntity, StoreEntity veya RecipeEntity listesi Zorunlu Bu öneri kümesi için önerileri oluşturan öğelerin listesi. Tek bir kümedeki varlıklar aynı türde olmalıdır.
Başlık Zorunlu

Öneri kümesinin başlığı (ör. Şükran Günü menüsünde büyük tasarruflar).

Önerilen metin boyutu: 25 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Alt başlık İsteğe bağlı Öneri kümesinin alt başlığı.
İşlem Uri İ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'yi inceleyin

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build());

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

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

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

publishFeaturedCluster

Bu API, 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 işlemler gerçekleşir:

  • Geliştirici iş ortağının mevcut FeaturedCluster verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenmiş Öne Çıkan Kümede depolanır.

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

publishFoodShoppingCart

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

Kotlin

client.publishFoodShoppingCart(
            PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    FoodShoppingCart.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingCart(
            new PublishFoodShoppingCartClusterRequest.Builder()
                .setShoppingCart(
                    new FoodShoppingCart.Builder()
                        ...
                        .build())
                .build());

Hizmet isteği aldığında, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:

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

Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.

publishFoodShoppingList

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

Kotlin

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

Java

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

  • Geliştirici iş ortağının mevcut FoodShoppingList verileri kaldırılır.
  • İstekten elde edilen veriler ayrıştırılır ve güncellenmiş Alışveriş Listesi Kümesinde depolanır.

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

publishReorderCluster

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

Kotlin

client.publishReorderCluster(
            PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    FoodReorderCluster.Builder()
                        ...
                        .build())
                .build())

Java

client.publishReorderCluster(
            new PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    new FoodReorderCluster.Builder()
                        ...
                        .build())
                .build());

Hizmet isteği aldığında, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:

  • Geliştirici iş ortağının mevcut FoodReorderCluster verileri kaldırılır.
  • İstekten gelen veriler ayrıştırılır ve güncellenen yeniden sıralama kümesinde depolanır.

Hata olması 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, uygulamanın içerik yayınlayabilmesi (veya daha kişiselleştirilmiş içerik sunabilmesi) için kullanıcıları uygulamanın oturum açma sayfasına yönlendirir.

Aşağıdaki meta veriler, oturum açma kartının bir parçasıdır:

Özellik Şartlar Açıklama
İşlem Uri Zorunlu İşlem için derin bağlantı (ör. uygulamada oturum açma sayfasına gider)
Resim İsteğe bağlı: Sağlanmamışsa başlık belirtilmelidir.

Kartta gösterilen resim

1264x712 çözünürlüğe sahip 16x9 en boy oranına sahip resimler
Başlık İsteğe bağlı: Sağlanmamışsa resim sağlanmalıdır Karttaki başlık
İşlem metni İsteğe bağlı CTA'da (ör. Oturum Aç) gösterilen metin
Alt başlık İsteğe bağlı Kartta isteğ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 işlemler gerçekleşir:

  • Geliştirici iş ortağının mevcut UserAccountManagementCluster verileri kaldırılır.
  • İstekten gelen veriler ayrıştırılır ve güncellenen UserAccountManagementCluster kümesinde depolanır.

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

updatePublishStatus

Dahili bir işletme nedeniyle kümelerin hiçbiri yayınlanmıyorsa updatePublishStatus API'sini kullanarak yayınlama durumunu güncellemenizi önemle tavsiye ederiz. Bu önemlidir, çünkü:

  • İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumu sağlamak, 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, uygulamanın sağlık kontrol panellerinde uyarı tetiklemekten kaçınabilir. Bu bildirim, sağlayıcı açısından beklenen bir durum nedeniyle içeriğin yayınlanmadığını onaylar.
  • Geliştiricilerin, verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığıyla ilgili bilgi sağlamasına yardımcı olur.
  • Google, kullanıcının uygulama içeriğini görmesini veya bu engeli aşmasını sağlamak için uygulamada belirli işlemleri yapmasına teşvik etmek amacıyla durum kodlarını kullanabilir.

Uygun yayınlama durum 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ı yayınlamanızı önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamıyorsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini çağırmanızı ö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());

deleteRecommendationClusters

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

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Hizmet, isteği aldığında mevcut verileri öneri kümelerinden kaldırır. Hata olması 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 Öne Çıkan Küme'deki mevcut verileri kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteFoodShoppingCartCluster

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

Kotlin

client.deleteFoodShoppingCartCluster()

Java

client.deleteFoodShoppingCartCluster();

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

deleteFoodShoppingListCluster

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

Kotlin

client.deleteFoodShoppingListCluster()

Java

client.deleteFoodShoppingListCluster();

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

deleteReorderCluster

Bu API, FoodReorderCluster içeriğini silmek için kullanılır.

Kotlin

client.deleteReorderCluster()

Java

client.deleteReorderCluster();

Hizmet isteği aldığında, mevcut verileri Kümeyi Yeniden Sıralama'dan kaldırır. Hata olması 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ğinin 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 belirtilen küme türleriyle eşleşen tüm kümelerdeki mevcut verileri kaldırır. İstemciler bir veya daha fazla küme türünü iletmeyi seçebilir. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

Hata işleme

Yayınlama API'lerinden görev sonucunu dinlemeniz önemle tavsiye edilir. Böylece, başarılı bir görevi kurtarıp yeniden göndermek için takip işlemi yapabilirsiniz.

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, hata kodu olarak nedeni dahil edilerek 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, belirli bir cihazda kullanılabilir ancak arama sırasında kullanılamaz (örneğin, açıkça devre dışı bırakılmıştır).
3 SERVICE_CALL_EXECUTION_FAILURE Görev yürütülemedi, ileti dizisi sorunları nedeniyle başarısız oldu. Bu durumda, işlem yeniden denenebilir.
4 SERVICE_CALL_PERMISSION_DENIED Arayan kullanıcının servis araması yapmasına izin verilmiyor.
5 SERVICE_CALL_INVALID_ARGUMENT İstek geçersiz veriler içeriyor (örneğin, izin verilenden daha fazla sayıda küme).
6 SERVICE_CALL_INTERNAL Hizmet tarafında bir hata var.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Servis çağrısı çok sık yapılıyor.

3. Adım: Yayın amaçlarını ele alın

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

Amaca dayalı yayınların amacı, temel olarak uygulamanın yeniden etkinleştirilmesini sağlamak ve veri senkronizasyonunu zorunlu kılmaktır. Yayın niyeti, çok sık gönderilecek şekilde tasarlanmamıştır. Yalnızca Engage Hizmeti içeriğin güncel olmayabileceğini (ör. bir haftalık) belirlediğinde tetiklenir. Bu şekilde, uygulama uzun bir süredir çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimine sahip olabileceğine dair güven artar.

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 kurulabilir.
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_FOOD_SHOPPING_CART
// broadcast is received

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

// Trigger reorder cluster publish when PUBLISH_REORDER_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));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART));

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_FOOD_SHOPPING_LIST));

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.food.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER));

}
  • AndroidManifest.xml dosyanızda <receiver> etiketiyle uygulamayı statik olarak beyan edin. Bu, uygulamanın çalışmadığında yayın intent'leri almasına ve içeriği yayınlamasına olanak tanır.
<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      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.food.PUBLISH_FOOD_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

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

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu amacı aldığınızda publishRecommendationClusters çağrısı başlatmanız önerilir.
  • com.google.android.engage.action.PUBLISH_FEATURED Bu intent'i aldığınızda publishFeaturedCluster çağrısı başlatmanız önerilir.
  • com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART Bu amacı aldığınızda publishFoodShoppingCart çağrısı başlatmanız önerilir.
  • com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST Bu niyeti aldığınızda publishFoodShoppingList çağrısı başlatmanız önerilir.
  • com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER Bu intent'i aldığınızda publishReorderCluster çağrısı başlatmanız önerilir.

Entegrasyon iş akışı

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

SSS

SSS'ler için Etkileşim SDK'sıyla İlgili Sık Sorulan Sorular bölümüne bakın.

İletişim

Entegrasyon sürecinde herhangi bir sorunuz olursa engagement-developers@google.com adresiyle iletişime geçin. Ekibimiz mümkün olan en kısa sürede yanıt verecektir.

Sonraki adımlar

Bu entegrasyonu tamamladıktan sonra şu adımları uygulayabilirsiniz:

  • 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 bir doğrulama ve inceleme gerçekleştirir. Değişiklik gerekirse Google gerekli bilgilerle sizinle iletişime geçer.
  • Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre 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 Çıkan, Alışveriş Sepeti, Alışveriş Listesi ve Yeniden Sipariş kümeleriniz yayınlanır ve kullanıcılara gösterilir.