Bu sayfa, Cloud Translation API ile çevrilmiştir.

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ğinin tüketilmesi ve keşfedilmesi için yeni ve etkileyici bir deneyim sağlayan bir cihaz yüzeyi geliştirmektedir. Bu tam ekran deneyimi, geliştirici iş ortaklarına en iyi zengin içeriklerini uygulamalarının dışında özel bir kanalda gösterme fırsatı sunar.

Bu kılavuzda, geliştirici iş ortaklarının hem bu yeni yüzey alanını hem de mevcut Google yüzeylerini doldurmak için Engage SDK'sını kullanarak gıda içeriklerini entegre etmeleri için talimatlar bulunmaktadır.

Entegrasyon ayrıntısı

Terminoloji

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

Öneri kümeleri, tek bir geliştirici iş ortağından gelen kişiselleştirilmiş gıda önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (ör. indirimde olan yeni içerikler). Yemek tariflerini, mağazaları, yemekleri, marketleri ve benzeri yerleri uygun gördüğünüz şekilde ortaya çıkarmak için bunları kullanın.
- Öneri kümesi ProductEntity, StoreEntity veya RecipeEntity girişlerinden oluşturulabilir ancak farklı öğe türlerinin bir karışımından oluşamaz.
Öne Çıkan kümesi, tek bir kullanıcı arayüzü gruplamasında birçok geliştirici iş ortağından seçilen ProductEntity, StoreEntity veya RecipeEntity kahramanını gösterir. Kullanıcı arayüzünün üst kısmına yakın bir yerde gösterilen tek bir Özellik kümesi vardır. Bu küme, tüm Öneri kümelerinin üzerinde bir öncelik yerleşimine sahiptir. Her geliştirici iş ortağının Öne Çıkanlar kümesinde desteklenen bir türde tek bir varlık yayınlamasına izin verilir. Bu varlık, Öne Çıkanlar kümesindeki birden fazla uygulama geliştiriciden gelen birçok varlıkla (muhtemelen farklı türlerde) olabilir.
Yiyecek Alışveriş Sepeti kümesi, tek bir kullanıcı arayüzü grubunda birden fazla geliştirici iş ortağından gelen market alışveriş sepetlerine hızlıca göz atarak kullanıcıların bekleyen alışveriş sepetlerini tamamlamalarını ister. Tek bir Yiyecek Alışveriş Sepeti kümesi vardır.
- Yiyecek Alışveriş Sepeti Kümesi, alışveriş sepetindeki toplam öğe sayısını göstermeli ve kullanıcının sepetindeki X öğenin resimlerini de içerebilir.
Gıda Alışveriş Listesi kümesi, tek bir kullanıcı arayüzü grubunda birden fazla geliştirici iş ortağından market alışveriş listelerinin kısa bir örneğini gösterir. Böylece, kullanıcılar listelerini güncellemek ve tamamlamak için ilgili uygulamaya geri dönmelerini isterler. Tek bir Gıda Alışveriş Listesi kümesi vardır.
Yeniden sıralama kümesi, tek bir kullanıcı arayüzü grubunda birden fazla geliştirici iş ortağından verilen önceki siparişlere bir önizleme gösterir ve kullanıcıların yeniden sıralama yapmasını ister. Tek bir Yeniden sıralama kümesi vardır.
- Yeniden sıralama kümesi, kullanıcının önceki siparişindeki toplam öğe sayısını göstermeli ve aşağıdakilerden birini 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ışma öncesi

Minimum API düzeyi: 19

com.google.android.play:engage 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.4.0'
}

Özet

Tasarım, bağlı bir hizmetin uygulanması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 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 1 (`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 Sıralama Kümesi	En fazla 1	En fazla 1 `ReorderEntity`

1. adım: Varlık verileri sağlayın

SDK, her bir öğe türünü temsil edecek farklı varlıklar tanımlamıştır. Gıda 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ılabilir özellikler ve gereksinimler özetlenmiştir.

`ProductEntity`

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

Ö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'sı	Zorunlu	Uygulamada ü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 bölümünü inceleyin	URI
Başlık	İsteğe bağlı	Ürünün adı.	Serbest metin Önerilen metin boyutu: 90 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Fiyat - geçerli	Koşula bağlı olarak gerekli	Ürünün geçerli fiyatı. Üstü çizili fiyat varsa sağlanmalıdır.	Serbest metin
Fiyat - üstü çizili	İsteğe bağlı	Varlığın kullanıcı arayüzünde üstü çizili olan orijinal fiyatı.	Serbest metin
Açıklama metni	İsteğe bağlı	Ürünle ilgili bir tanıtımı, etkinliği veya güncellemeyi (varsa) öne çıkarmak için açıklama metni.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Açıklama metni açıklama metni	İsteğe bağlı	Açıklama metni için hassas metin.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Puan (İsteğe bağlı) - Not: Tüm puanlar, standart yıldız puanı sistemimiz kullanılarak görüntülenir.
Puan - maksimum değer	Zorunlu	Kullanıcı oyu ölçeğinin maksimum değeri. Puanın mevcut değeri de sağlanırsa sağlanmalıdır.	Sayı >= 0,0
Puan - geçerli değer	Zorunlu	Varlığın puanının mevcut değeri. Maksimum puan değeri de sağlanırsa sağlanmalıdır.	Sayı >= 0,0
Puan - sayı	İsteğe bağlı	Varlığa ilişkin puan sayısı.	Dize
DisplayTimeWindow (İsteğe Bağlı): İçeriğin yüzeyde gösterileceği zaman aralığını belirleyin
Başlangıç Zaman Damgası	İsteğe bağlı	İçeriğin yüzeyde gösterilmesi gereken dönemin zaman damgası. Politika ayarlanmazsa içerikler yüzeyde gösterilebilir.	Milisaniye cinsinden dönem zaman damgası
Bitiş Zaman Damgası	İsteğe bağlı	İçeriğin artık yüzeyde gösterilmediği dönemin zaman damgası. Politika ayarlanmazsa içerikler yüzeyde gösterilebilir.	Milisaniye cinsinden dönem zaman damgası

`StoreEntity`

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

Ö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'sı	Zorunlu	Uygulamada mağazayla ilgili ayrıntıları gösteren sayfanın derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümünü inceleyin	URI
Başlık	İsteğe bağlı	Mağazanın adı.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Konum	İsteğe bağlı	Mağazanın konumu.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Açıklama metni	İsteğe bağlı	Varsa mağazayla ilgili bir tanıtımı, etkinliği veya güncellemeyi öne çıkaran açıklama metni.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Açıklama metni açıklama metni	İsteğe bağlı	Açıklama metni için hassas metin.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Açıklama	İsteğe bağlı	Mağazayla ilgili açıklama.	Serbest metin Önerilen metin boyutu: 90 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Not: Tüm puanlar, standart yıldızlı puanlama sistemimiz kullanılarak gösterilir.
Puan - maksimum değer	Koşula bağlı olarak gerekli	Kullanıcı oyu ölçeğinin maksimum değeri. Puanın mevcut değeri de sağlanırsa sağlanmalıdır.	Sayı >= 0,0
Puan - geçerli değer	Koşula bağlı olarak gerekli	Varlığın puanının mevcut değeri. Maksimum puan değeri de sağlanırsa sağlanmalıdır.	Sayı >= 0,0
Puan - sayı	İsteğe bağlı	Varlığa ilişkin puan sayısı.	Dize

`RecipeEntity`

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

Ö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'sı	Zorunlu	Uygulamada yemek tarifiyle ilgili ayrıntıları gösteren sayfanın derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümünü inceleyin	URI
Başlık	İsteğe bağlı	Yemek tarifinin adı.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Yazar	İsteğe bağlı	Yemek tarifinin yazarı.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan 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 az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Açıklama metni	İsteğe bağlı	Varsa yemek tarifiyle ilgili bir tanıtımı, etkinliği veya güncellemeyi öne çıkaran açıklama metni.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Kategori	İsteğe bağlı	Yemek tarifinin kategorisi.	Serbest metin Önerilen metin boyutu: 45 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Açıklama	İsteğe bağlı	Yemek tarifinin açıklaması.	Serbest metin Önerilen metin boyutu: 90 karakterden az (Çok uzun olan metinlerde üç nokta gösterilebilir)
Not: Tüm puanlar, standart yıldızlı değerlendirme sistemimiz kullanılarak gösterilir.
Puan - maksimum değer	Koşula bağlı olarak gerekli	Kullanıcı oyu ölçeğinin maksimum değeri. Puanın mevcut değeri de sağlanırsa sağlanmalıdır.	Sayı >= 0,0
Puan - geçerli değer	Koşula bağlı olarak gerekli	Varlığın puanının mevcut değeri. Maksimum puan değeri de sağlanırsa sağlanmalıdır.	Sayı >= 0,0
Puan - sayı	İsteğe bağlı	Varlığa ilişkin puan sayısı.	Dize

`FoodShoppingCart`

Özellik	Şartlar	Açıklama	Biçim
İşlem URI'sı	Zorunlu	İş ortağının uygulamasındaki alışveriş sepeti için derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümünü inceleyin	URI
Ürün sayısı	Zorunlu	Alışveriş sepetindeki öğe sayısı (yalnızca ürün sayısı değil). Ö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 herhangi bir başlık sağlamazsa varsayılan olarak Alışveriş sepetiniz* kullanılır.**	Serbest metin Önerilen metin boyutu: 25 karakterden kısa (Çok uzun olan metinlerde üç nokta gösterilebilir)
İşlem Metni	İsteğe bağlı	Alışveriş Sepetindeki düğmenin harekete geçirici mesaj metni (örneğin, Alışveriş Çantanız). *Geliştirici tarafından herhangi bir işlem metni sağlanmazsa Sepeti Görüntüle* seçeneği varsayılan olarak ayarlanır.** Bu özellik 1.1.0 ve sonraki sürümlerde desteklenir.	Dize
Alışveriş sepeti resimleri	İsteğe bağlı	Alışveriş sepetindeki 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.	Yardım için Resim Özellikleri bölümüne bakın.
Öğe etiketleri	İsteğe bağlı	Alışveriş listesindeki öğelerin etiket 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 olan metinlerde üç nokta gösterilebilir)
DisplayTimeWindow (İsteğe Bağlı): İçeriğin yüzeyde gösterileceği zaman aralığını belirleyin
Başlangıç Zaman Damgası	İsteğe bağlı	İçeriğin yüzeyde gösterilmesi gereken dönemin zaman damgası. Politika ayarlanmazsa içerikler yüzeyde gösterilebilir.	Milisaniye cinsinden dönem zaman damgası
Bitiş Zaman Damgası	İsteğe bağlı	İçeriğin artık yüzeyde gösterilmediği dönemin zaman damgası. Politika ayarlanmazsa içerikler yüzeyde gösterilebilir.	Milisaniye cinsinden dönem zaman damgası

`FoodShoppingList`

Özellik	Şartlar	Açıklama	Biçim
İşlem URI'sı	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 bölümünü inceleyin	URI
Ürün sayısı	Zorunlu	Alışveriş listesindeki öğelerin sayısı.	Tam sayı >= 1
Başlık	İsteğe bağlı	Listenin başlığı (örneğin, Alışveriş Listeniz). *Geliştirici tarafından başlık sağlanmazsa Alışveriş listesi* varsayılan olur.**	Serbest metin Önerilen metin boyutu: 25 karakterden kısa (Çok uzun olan metinlerde üç nokta gösterilebilir)
Öğe etiketleri	Zorunlu	Alışveriş listesindeki öğelerin etiket listesi. Öncelik sırasına göre en az 1 etiket ve en fazla 10 etiket sağlanabilir. Görüntülenen gerçek etiket sayısı cihaz form faktörüne bağlıdır.	Serbest metin etiketlerinin listesi Önerilen metin boyutu: 20 karakterden kısa (Çok uzun olan metinlerde üç nokta gösterilebilir)

`FoodReorderCluster`

Özellik	Şartlar	Açıklama	Biçim
İşlem URI'sı	Zorunlu	İş ortağının uygulamasında yeniden sıralanacak derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümünü inceleyin	URI
İşlem Metni	İsteğe bağlı	Yeniden sırala düğmesinin harekete geçirici mesaj metni (örneğin, Tekrar sipariş ver). *Geliştirici tarafından herhangi bir işlem metni sağlamazsanız varsayılan olarak Yeniden sırala* seçeneği kullanılır.** Bu özellik 1.1.0 ve sonraki sürümlerde desteklenir.	Dize
Ürün 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 olan 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 etiketlerin gerçek 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 olan metinlerde üç nokta gösterilebilir)
Poster resimleri	İsteğe bağlı (Sağlanmazsa öğ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ın 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	960 x 1.200

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

960 x 1.200

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 bir şekilde görüntülenebilmesi için şeffaf bir arka plan kullanın.

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

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

AppEngageFoodClient, besin kümelerini yayınlamaktan sorumludur.

Kümeleri istemcide yayınlamak için aşağıdaki API'ler mevcuttur:

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

`isServiceAvailable`

Bu API, hizmetin entegrasyon için uygun olup olmadığını ve içeriğin cihazda sunulup sunulmadığı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 nesnelerini bir liste yayınlamak için kullanılır.

RecommendationCluster nesnesi 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ümesi başlığı (örneğin, Şükran Günü menüsünde büyük indirimler). Önerilen metin boyutu: 25 karakterden kısa (Çok uzun olan metinlerde üç nokta gösterilebilir)
İşlem URI'sı	İ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 bölümünü inceleyin

Ö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ümesi başlığı (örneğin, Şükran Günü menüsünde büyük indirimler).

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

İşlem URI'sı

İ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 bölümünü 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 işlem içinde aşağıdaki işlemler gerçekleştirilir:

Mevcut tüm Öneri Kümesi verileri kaldırılır.
İstekten elde edilen 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 bir FeaturedCluster nesnesini 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 işlem içinde aşağıdaki işlemler gerçekleştirilir:

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

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

`publishFoodShoppingCart`

Bu API bir FoodShoppingCart nesnesini 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 işlem içinde aşağıdaki işlemler gerçekleştirilir:

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

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

`publishFoodShoppingList`

Bu API bir FoodShoppingList nesnesini 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 işlem içinde aşağıdaki işlemler gerçekleştirilir:

Geliştirici iş ortağından alınan mevcut FoodShoppingList verileri kaldırılır.
İstekten gelen 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 bir FoodReorderCluster nesnesini 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 işlem içinde aşağıdaki işlemler gerçekleştirilir:

Geliştirici iş ortağından alınan mevcut FoodReorderCluster verileri kaldırılır.
İstekten gelen veriler ayrıştırılır ve güncellenmiş Yeniden Sıralama Kümesi'nde 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 sağlayabilmesi) 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'sı	Zorunlu	İşlem için derin bağlantı (ör. uygulamada oturum açma sayfasına yönlendirir)
Resim	İsteğe bağlı - Sağlanmamışsa başlık sağlanmalıdır	Kartta Gösterilen Resim 1264x712 çözünürlüklü 16x9 en boy oranına sahip resimler
Başlık	İsteğe bağlı - Sağlanmazsa Resim sağlanmalıdır	Kartın Başlığı
İşlem Metni	İsteğe bağlı	CTA'da gösterilen metin (ör. oturum açma)
Alt başlık	İsteğe bağlı	Kartta İ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 işlem içinde aşağıdaki işlemler gerçekleştirilir:

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

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

`updatePublishStatus`

İşle ilgili herhangi bir nedenle kümelerin hiçbiri yayınlanmazsa updatePublishStatus API'sini kullanarak yayınlama durumunu güncellemenizi önemle öneririz. Bu önemlidir, çünkü :

İçerik yayınlandığında bile tüm senaryolarda durumun sağlanması (DURUM == YAYINLANDI), entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu uygunsuz durumu kullanan kontrol panellerinin doldurulması için kritik önem taşır.
Hiçbir içerik yayınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulama durumu kontrol panellerinde uyarı tetiklemekten kaçınabilir. Bu işlem, sağlayıcının açısından beklenen bir durum nedeniyle içeriğin yayınlanmadığını onaylar.
Geliştiricilerin, verilerin ne zaman yayınlanıp yayınlanmadığına dair analizler sağlamasına yardımcı olur.
Google, durum kodlarını kullanıcının uygulama içeriğini görebilmesi veya aşması için uygulamada belirli işlemleri yapmasını yönlendirmek amacıyla kullanabilir.

Uygun yayınlama durum kodlarının listesi şu şekildedir :

// 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

Kullanıcı giriş yapmadığı için içerik yayınlanmazsa Google, Oturum Açma Kartının yayınlanmasını önerir. Sağlayıcılar Oturum Açma Kartını herhangi bir nedenle yayınlayamazsa updatePublishStatus API'sinin NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla çağrılması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());

`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ümenin 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 olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

`deleteFoodShoppingCartCluster`

Bu API, Yiyecek Alışveriş Sepeti Kümesi 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 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şi 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 Sıralama Kümesi'nden kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

`deleteUserManagementCluster`

Bu API, UserAccountManagement Cluster'ın içeriğini silmek için kullanılır.

Kotlin


client.deleteUserManagementCluster()

Java


client.deleteUserManagementCluster();

Hizmet, isteği aldığında mevcut verileri UserAccountManagement Cluster'dan kaldırır. Hata olması 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ümelerden mevcut verileri kaldırır. Müşteriler bir veya daha fazla küme türünü geçirebilir. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

Hata işleme

Yayınlama API'lerinden gelen 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 gerçekleştirilebilir.

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, neden hata kodu olarak eklenmiş şekilde AppEngageException biçiminde döndürülür.

Hata kodu	Not
`SERVICE_NOT_FOUND`	Hizmet belirtilen cihazda kullanılamıyor.
`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).
`SERVICE_CALL_EXECUTION_FAILURE`	İleti dizisi sorunları nedeniyle görev yürütülemedi. Bu durumda, işlem yeniden denenebilir.
`SERVICE_CALL_PERMISSION_DENIED`	Arayanın servis araması yapma izni yok.
`SERVICE_CALL_INVALID_ARGUMENT`	İstek geçersiz veriler içeriyor (örneğin, izin verilen küme sayısından fazla).
`SERVICE_CALL_INTERNAL`	Hizmet tarafında bir hata var.
`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 publish Content API çağrıları yapmaya ek olarak, bir içerik yayınlama isteğini almak için BroadcastReceiver kurulumu da gerekir.

Yayın amaçlarının amacı, temel olarak uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorlamaktır. Yayın amaçları çok sık gönderilecek şekilde tasarlanmamıştır. Yalnızca İnternet Reklamcılığı Programı içeriğin eski olabileceğini (örneğin, 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 deneyimine sahip olabileceğine dair daha fazla güven duyulur.

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, hâlâ bellekte bulunan uygulamalardan iletişim kurulmasını sağlar.

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));

}

Statik olarak AndroidManifest.xml dosyanızda <receiver> etiketiyle bir uygulama tanımlayın. Bu, uygulamanın çalışmadığında yayın amaçlarını almasına ve aynı zamanda uygulamanın 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 amaçlar gönderilir:

com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu amacı alırken bir publishRecommendationClusters çağrısı başlatmanız önerilir.
com.google.android.engage.action.PUBLISH_FEATURED Bu niyeti alırken bir publishFeaturedCluster araması başlatmanız önerilir.
com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART Bu niyeti alırken bir publishFoodShoppingCart araması başlatmanız önerilir.
com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST Bu niyeti alırken bir publishFoodShoppingList araması başlatmanız önerilir.
com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER Bu amacı alırken bir publishReorderCluster araması başlatmanız önerilir.

Entegrasyon iş akışı

Entegrasyonun tamamlandıktan sonra doğrulanmasıyla ilgili adım adım açıklamalı bir kılavuz için Geliştirici entegrasyonu iş akışını etkileşim kurma başlıklı makaleyi inceleyin.

SSS

SSS için Engage SDK'sı ile İlgili Sık Sorulan Sorular bölümüne bakın.

İletişim

Entegrasyon işlemi sırasında herhangi bir sorunuz olursa lütfen engagement-developers@google.com ile iletişime geçin. Ekibimiz mümkün olan en kısa sürede size yanıt verecektir.

Sonraki adımlar

Bu entegrasyonu tamamladıktan sonra uygulamanız gereken adımlar şunlardır:

engagement-developers@google.com adresine 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 bir doğrulama ve dahili inceleme gerçekleştirir. Değişiklik yapılması gerekirse Google gerekli ayrıntıları vermek için 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çecektir.
Google, güncellenen APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri, Öne Çıkan, Alışveriş Sepeti, Alışveriş Listesi ve Yeniden Sırala kümeleriniz yayınlanır ve kullanıcılar tarafından görülebilir.