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 aşağıdaki beş küme türünü içerir: Öneri, Öne Çıkan, Gıda Alışveriş Sepeti, Gıda Alışveriş Listesi ve Yeniden Sipariş.
Ö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 (ör. indirimde olan yeni ürünler). Tarifler, mağazalar, yemekler, marketler vb. öğeleri göstermek için bu etiketleri uygun gördüğünüz şekilde kullanabilirsiniz.
- Öneri kümesi,
ProductEntity
,StoreEntity
veyaRecipeEntity
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) - Öneri kümesi,
Öne Çıkan kümesi, birden fazla geliştirici iş ortağından seçilen öğeleri 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ında, tüm Öneriler kümelerinin üzerinde öncelikli bir yerleşimle gösterilir. Her geliştirici iş ortağının Öne Çıkan kümesinde en fazla 10 öğe yayınlamasına izin verilir.
Şekil : "RecipeEntity" ile öne çıkarılan küme. (*Kullanıcı arayüzü yalnızca örnek amaçlıdır) Gıda Alışveriş Sepeti kümesi, birden fazla geliştirici iş ortağının gıda alışverişi sepetlerine tek bir kullanıcı arayüzü gruplandırmasında yer vererek kullanıcıları eksik alışveriş sepetlerini tamamlamaya teşvik eder. 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ğının 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şi listesi kümesi vardır.
Şekil: Tek bir iş ortağından alınan gıda alışveriş listesi kümesi. (*UI 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 vardır.
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ğının Yemek Yeniden Siparişi kümesi. (*UI yalnızca örnek amaçlıdır)
Ö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ğlantılı bir hizmet uygulamasına dayanır.
Bir müşterinin 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 varlık 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 ) |
Yiyecek Alışveriş Sepeti Kümesi | En fazla 1 | En fazla 1 ShoppingCartEntity |
Gıda 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, her öğe türünü temsil etmek için farklı öğeler tanımlamıştır. Yemek kategorisi için aşağıdaki varlıkları destekliyoruz:
ProductEntity
StoreEntity
RecipeEntity
FoodShoppingCart
FoodShoppingList
FoodReorderCluster
Aşağıdaki grafiklerde, her tür için kullanılabilen özellikler ve koşullar ö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.

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 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. |
0,0'dan büyük bir sayı |
Derecelendirme - Mevcut değer | İsteğe bağlı | Puan ölçeğinin mevcut değeri. Derecelendirmenin maksimum değeri de sağlanıyorsa 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 sayının daha küçük ekran boyutlarında kısaltılmaması için 1M 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önetmiyorsanız bu alanı sağlayın. Hem Sayı hem de Sayı Değeri varsa Sayı, kullanıcılara gösterilir. |
Uzun |
DisplayTimeWindow (İsteğe bağlı) - Bir içeriğin yüzeyde gösterileceği bir zaman aralığı ayarlayın | |||
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 yüzeyde gösterilmediği 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.

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 metinlerde üç 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ğazayla ilgili bir promosyonu, etkinliği veya güncellemeyi ö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 metinlerde üç nokta gösterilebilir) |
Açıklama | İsteğe bağlı | Mağazanın açıklaması. | Serbest metin Önerilen metin boyutu: 90 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir) |
Kategori | İsteğe bağlı | Bir mağazanın kategorisi. Yemek yerleri bağlamında bu kategori, "Fransız", "Yeni Amerikan", "Ramen", "Güzel yemekler" gibi yemek türleri olabilir. |
Serbest metin Önerilen metin boyutu: 45 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. |
0,0'dan büyük bir sayı |
Derecelendirme - Mevcut değer | İsteğe bağlı | Puan ölçeğinin mevcut değeri. Derecelendirmenin maksimum değeri de sağlanıyorsa sağlanmalıdır. |
Sayı >= 0,0 |
Derecelendirme - Sayı | İsteğe bağlı | Mağazanın puan sayısı. Not: Uygulamanız bu bilgilerin 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.

RecipeEntity
öğ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 | 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ırlama 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 metinlerde üç 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. |
0,0'dan büyük bir sayı |
Derecelendirme - Mevcut değer | İsteğe bağlı | Puan ölçeğinin mevcut değeri. Derecelendirmenin maksimum değeri de sağlanıyorsa sağlanmalıdır. |
Sayı >= 0,0 |
Derecelendirme - Sayı | İsteğe bağlı | Tarifin aldığı puan sayısı. Not: Uygulamanız bu bilgilerin kullanıcılara nasıl gösterileceğini kontrol etmek istiyorsa bu alanı sağlayın. Kullanıcıya gösterilebilecek kısa dizeyi 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

Ö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ın). 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ünden itibaren desteklenir. |
Dize |
Alışveriş sepeti resimleri | İsteğe bağlı | Sepetteki her ürünün resmi. Ö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ö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) |
DisplayTimeWindow (İsteğe bağlı) - Bir içeriğin yüzeyde gösterileceği bir zaman aralığı ayarlayın | |||
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 yüzeyde gösterilmediği zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur. |
Milisaniye cinsinden Unix sıfır zaman damgası |
FoodShoppingList

Ö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 metinlerde üç 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

Özellik | Şartlar | Açıklama | Biçim |
---|---|---|---|
İşlem Uri | Zorunlu |
İş ortağının uygulamasında yeniden sipariş vermek için kullanılacak 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ünden itibaren 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 sipariş edilen öğ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ınlanmadıysa poster resimleri sağlanmalıdır) |
Önceki siparişe ait öğ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 üç nokta (...) ile 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 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österilmesi 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.
Yiyecek kümelerinin yayınlanmasından AppEngageFoodClient
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
nesnesi listesi 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 varlıkların 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'ye bakın. |
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 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. - İstekten gelen 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.
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 tek bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağının mevcut
FoodShoppingCart
verileri kaldırılır. - İstekteki 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.
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 gelen 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.
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 tek bir işlemde aşağıdaki işlemler gerçekleşir:
- 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 saklanı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, 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 | İşleme derin bağlantı (ör. uygulama oturum açma sayfasına yönlendirme) |
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 oranına sahip 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ç) |
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 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ınlanmamışsa ancak entegrasyon durumu bozulmamışsa (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemekten kaçınabilir. 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ığı hakkında analizler sunması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 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 oturum açmaması 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. 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 Yeniden Düzenle Kümesi'nden 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ğ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 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, belirtilen 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ütme, mesaj dizileriyle ilgili sorunlar nedeniyle başarısız oldu. Bu durumda, işlem yeniden denenebilir. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Arayanı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 intent'lerini işleme
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.
Yayın niyetinin amacı, temel olarak uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorlamaktır. Yayın niyetleri ç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 sayede, uygulama uzun süre çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğinden emin olabilirsiniz.
BroadcastReceiver
aşağıdaki iki şekilde ayarlanmalıdır:
Context.registerReceiver()
kullanarakBroadcastReceiver
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 statik olarak bir uygulama bildirin. 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ızdapublishRecommendationClusters
çağrısı başlatmanız önerilir.com.google.android.engage.action.PUBLISH_FEATURED
Bu intent'i aldığınızdapublishFeaturedCluster
çağrısı başlatmanız önerilir.com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART
Bu amacı aldığınızdapublishFoodShoppingCart
çağrısı başlatmanız önerilir.com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST
Bu amacı aldığınızdapublishFoodShoppingList
çağrısı başlatmanız önerilir.com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER
Bu intent'i aldığınızdapublishReorderCluster
ç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 için Engage SDK Sık Sorulan Sorular başlıklı makaleyi inceleyin.
İletişim
Entegrasyon işlemi sırasında sorularınız olursa engage-developers@google.com adresiyle iletişime geçebilirsiniz. Ekibimiz en kısa sürede yanıt verecektir.
Sonraki adımlar
Bu entegrasyonu tamamladıktan sonra uygulayacağınız adımlar ş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 bir doğrulama ve inceleme gerçekleştirir. Değişiklik yapılması gerekirse Google gerekli tüm bilgileri sizinle paylaşacaktır.
- 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.