Kullanıcılarınıza bulundukları yerde ulaşarak uygulama etkileşimini artırın. Engage SDK'yı entegre ederek Koleksiyonlar, Entertainment Space ve Play Store gibi cihaz üzerindeki birden fazla yüzeyde kullanıcılara doğrudan kişiselleştirilmiş öneriler ve devam içerikleri sunun. Entegrasyon, ortalama APK boyutuna 50 KB'tan daha az (sıkıştırılmış) ekler ve çoğu uygulamanın geliştirici süresi yaklaşık bir hafta sürer. Daha fazla bilgi için işletme sitemizi ziyaret edin.
Bu kılavuzda, geliştirici iş ortaklarının Engage içerik yüzeylerine okuma içerikleri (e-kitaplar, sesli kitaplar, çizgi romanlar/mangalar) sunmasıyla ilgili talimatlar yer almaktadır.
Entegrasyon ayrıntıları
Terminoloji
Bu entegrasyon aşağıdaki üç küme türünü içerir: Öneri, Devam ve Öne Çıkanlar.
Öneri kümeleri, tek bir geliştirici iş ortağının okunacak içerikleriyle ilgili kişiselleştirilmiş öneriler gösterir.
Önerileriniz aşağıdaki yapıya sahiptir:
Öneri Kümesi: Tek bir geliştirici iş ortağının öneri grubunu içeren bir kullanıcı arayüzü görünümü.
1. şekil. Tek bir iş ortağının öneri grubunu gösteren Entertainment Space kullanıcı arayüzü. Varlık: Bir kümedeki tek bir öğeyi temsil eden nesne. Öğe; e-kitap, sesli kitap, kitap serisi ve daha fazlası olabilir. Desteklenen öğe türlerinin listesi için Provide entity data (Varlık verileri sağlama) bölümüne bakın.
Şekil 2. Tek bir iş ortağının öneri kümesinde tek bir öğeyi gösteren Entertainment Space kullanıcı arayüzü. <0x0x0A>
Devam kümesinde, birden fazla geliştirici iş ortağının tamamlanmamış kitapları tek bir kullanıcı arayüzü gruplandırmasında gösterilir. Her geliştirici iş ortağı, Devam kümesinde en fazla 10 öğe yayınlayabilir.
3.Şekil Birden fazla iş ortağının tamamlanmamış önerilerini içeren bir Devam Ettirme grubu gösteren Entertainment Space kullanıcı arayüzü (şu anda yalnızca bir öneri görünür). Öne Çıkanlar kümesi, tek bir kullanıcı arayüzü gruplandırmasında birden fazla geliştirici iş ortağının öğelerinden bir seçkiyi 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 Öneri kümelerinin üzerinde öncelikli bir yerleşimle gösterilir. Her geliştirici iş ortağı, Öne Çıkan kümede en fazla 10 öğe yayınlayabilir.
Şekil 4. Birden fazla iş ortağının önerilerini içeren Öne Çıkanlar kümesini gösteren Entertainment Space kullanıcı arayüzü (şu anda yalnızca bir öneri görünür).
Ön çalışma
Minimum API düzeyi: 19
Uygulamanıza com.google.android.engage:engage-core
kitaplığını 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ı 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 öğe sınırları |
---|---|---|
Öneri kümeleri | En fazla 7 | En fazla 50 |
Devamlılık Kümesi | En fazla 1 | En fazla 20 |
Öne Çıkan Küme | En fazla 1 | En fazla 20 |
1. adım: Tüzel kişi verilerini sağlayın
SDK, her öğe türünü temsil etmek için farklı öğeler tanımlamıştır. Okuma kategorisi için aşağıdaki varlıkları destekliyoruz:
EbookEntity
AudiobookEntity
BookSeriesEntity
Aşağıdaki grafiklerde, her tür için kullanılabilir özellikler ve şartlar özetlenmiştir.
EbookEntity
EbookEntity
nesnesi, e-kitapları (örneğin, Michelle Obama'nın Becoming adlı e-kitabı) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri başlıklı makaleyi inceleyin. |
Yazar | Zorunlu | En az bir yazar adı sağlanmalıdır. |
İşlem bağlantısı URI'si | Zorunlu |
E-kitap için sağlayıcı uygulamasının derin bağlantısı. Not: Derin bağlantıları ilişkilendirme için kullanabilirsiniz. Bu SSS'ye bakın |
Yayınlanma tarihi | İsteğe bağlı | Sağlanmışsa epoch milisaniye cinsinden. |
Açıklama | İsteğe bağlı | Sağlanıyorsa 200 karakteri aşmamalıdır. |
Fiyat | İsteğe bağlı | Serbest metin |
Sayfa sayısı | İsteğe bağlı | Sağlanması durumunda pozitif bir tam sayı olmalıdır. |
Tür | İsteğe bağlı | Kitapla ilişkili türlerin listesi. |
Dizi adı | İsteğe bağlı | E-kitabın ait olduğu dizinin adı (ör. Harry Potter). |
Seri birimi dizini | İsteğe bağlı | Serideki e-kitabın dizini. Burada 1, serideki ilk e-kitaptır. Örneğin, Harry Potter ve Azkaban Tutsağı serinin 3. kitabıysa bu değer 3 olarak ayarlanmalıdır. |
Devam eden kitap türü | İsteğe bağlı |
TYPE_CONTINUE: Bitmemiş bir kitaba devam etme TYPE_NEXT: Bir serinin yeni bir bölümüyle devam etme. TYPE_NEW: Yeni yayınlandı. |
Son Etkileşim Zamanı | Koşula bağlı olarak gerekli |
Öğe, devamlılık kümesindeyken sağlanmalıdır. *Yeni* edinilen e-kitaplar, okumaya devam etme kümesinin bir parçası olabilir. Milisaniye cinsinden süre. |
Tamamlanan İlerleme Yüzdesi | Koşula bağlı olarak gerekli |
Öğe, devamlılık kümesindeyken sağlanmalıdır. Değer 0'dan büyük ve 100'den küçük olmalıdır. |
DisplayTimeWindow: İçeriğin yüzeyde gösterileceği zaman aralığını 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 uygun olur. Milisaniye cinsinden süre. |
Bitiş zaman damgası | İsteğe bağlı |
İçeriğin yüzeyde gösterilmeyeceği dönemin zaman damgası. Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur. Milisaniye cinsinden süre. |
AudiobookEntity
AudiobookEntity
nesnesi, sesli kitabı (örneğin, Michelle Obama'nın Becoming adlı kitabının sesli versiyonu) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri başlıklı makaleyi inceleyin. |
Yazar | Zorunlu | En az bir yazar adı sağlanmalıdır. |
İşlem bağlantısı URI'si | Zorunlu |
Sesli kitap için sağlayıcı uygulamasının derin bağlantısı. Not: Derin bağlantıları ilişkilendirme için kullanabilirsiniz. Bu SSS'ye bakın |
Anlatıcı | İsteğe bağlı | En az bir anlatıcının adı sağlanmalıdır. |
Yayınlanma tarihi | İsteğe bağlı | Sağlanmışsa epoch milisaniye cinsinden. |
Açıklama | İsteğe bağlı | Sağlanıyorsa 200 karakteri aşmamalıdır. |
Fiyat | İsteğe bağlı | Serbest metin |
Süre | İsteğe bağlı | Sağlanması durumunda pozitif bir değer olmalıdır. |
Tür | İsteğe bağlı | Kitapla ilişkili türlerin listesi. |
Dizi adı | İsteğe bağlı | Sesli kitabın ait olduğu dizinin adı (örneğin, Harry Potter). |
Seri birimi dizini | İsteğe bağlı | Serideki sesli kitabın dizini. Serideki ilk sesli kitap 1. dizindedir. Örneğin, Harry Potter ve Azkaban Tutsağı serinin 3. kitabıysa bu değer 3 olarak ayarlanmalıdır. |
Devam eden kitap türü | İsteğe bağlı |
TYPE_CONTINUE: Bitmemiş bir kitaba devam etme TYPE_NEXT: Bir serinin yeni bir bölümüyle devam etme. TYPE_NEW: Yeni yayınlandı. |
Son Etkileşim Zamanı | Koşula bağlı olarak gerekli | Öğe, devamlılık kümesindeyken sağlanmalıdır. Milisaniye cinsinden süre. |
Tamamlanan İlerleme Yüzdesi | Koşula bağlı olarak gerekli |
Öğe, devamlılık kümesindeyken sağlanmalıdır. *Yeni* edinilen sesli kitaplar, okumaya devam etme kümesinin bir parçası olabilir. Değer 0'dan büyük ve 100'den küçük olmalıdır. |
DisplayTimeWindow: İçeriğin yüzeyde gösterileceği zaman aralığını 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 uygun olur. Milisaniye cinsinden süre. |
Bitiş zaman damgası | İsteğe bağlı |
İçeriğin yüzeyde gösterilmeyeceği dönemin zaman damgası. Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur. Milisaniye cinsinden süre. |
BookSeriesEntity
BookSeriesEntity
nesnesi bir kitap serisini (örneğin, 7 kitabı olan Harry Potter kitap serisi) temsil eder.
Özellik | Şartlar | Notlar |
---|---|---|
Ad | Zorunlu | |
Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri başlıklı makaleyi inceleyin. |
Yazar | Zorunlu | En az bir yazar adı bulunmalıdır. |
İşlem bağlantısı URI'si | Zorunlu |
Sesli kitap veya e-kitap için sağlayıcı uygulamasının derin bağlantısı. Not: Derin bağlantıları ilişkilendirme için kullanabilirsiniz. Bu SSS'ye bakın |
Kitap sayısı | Zorunlu | Serideki kitap sayısı. |
Açıklama | İsteğe bağlı | Sağlanıyorsa 200 karakteri aşmamalıdır. |
Tür | İsteğe bağlı | Kitapla ilişkili türlerin listesi. |
Devam eden kitap türü | İsteğe bağlı |
TYPE_CONTINUE: Bitmemiş bir kitaba devam etme TYPE_NEXT: Bir serinin yeni bir bölümüyle devam etme. TYPE_NEW: Yeni yayınlandı. |
Son Etkileşim Zamanı | Koşula bağlı olarak gerekli | Öğe, devamlılık kümesindeyken sağlanmalıdır. Milisaniye cinsinden süre. |
Tamamlanan İlerleme Yüzdesi | Koşula bağlı olarak gerekli | Öğe, devamlılık kümesindeyken sağlanmalıdır. *Yeni* edinilen kitap serileri, "Okumaya devam et" kümesinin bir parçası olabilir. Değer 0'dan büyük ve 100'den küçük olmalıdır. |
DisplayTimeWindow: İçeriğin yüzeyde gösterileceği zaman aralığını 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 uygun olur. Milisaniye cinsinden süre. |
Bitiş zaman damgası | İsteğe bağlı |
İçeriğin yüzeyde gösterilmeyeceği dönemin zaman damgası. Ayarlanmazsa içerik, yüzeyde gösterilmeye uygun olur. Milisaniye cinsinden süre. |
Resim özellikleri
Resim öğeleri için zorunlu özellikler aşağıda listelenmiştir:
En boy oranı | Şartlar | Minimum piksel sayısı | Önerilen piksel sayısı |
---|---|---|---|
Kare (1x1) | Zorunlu | 300x300 | 1200x1200 |
Yatay (1,91x1) | İsteğe bağlı | 600x314 | 1200x628 |
Dikey (4x5) | İsteğe bağlı | 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.
Örnek
AudiobookEntity audiobookEntity =
new AudiobookEntity.Builder()
.setName("Becoming")
.addPosterImage(
new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.addAuthor("Michelle Obama")
.addNarrator("Michelle Obama")
.setActionLinkUri(Uri.parse("https://play.google/audiobooks/1"))
.setDurationMillis(16335L)
.setPublishDateEpochMillis(1633032895L)
.setDescription("An intimate, powerful, and inspiring memoir")
.setPrice("$16.95")
.addGenre("biography")
.build();
2. adım: Küme verilerini sağlama
İçerik yayınlama işinin arka planda (örneğin, WorkManager kullanılarak) yürütülmesi ve düzenli olarak veya etkinlik bazında (örneğin, kullanıcı uygulamayı her açtığında ya da sepete bir öğe eklediğinde) planlanması önerilir.
AppEngagePublishClient
, kümelerin yayınlanmasından sorumludur. İstemcide aşağıdaki API'ler kullanılabilir:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
Bu API, hizmetin entegrasyona uygun olup olmadığı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.
Kotlin
client.publishRecommendationClusters(
PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Reconnect with yourself")
.build())
.build())
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Reconnect with yourself")
.build())
.build());
Hizmet isteği aldığında tek bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağından alınan mevcut
RecommendationCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen RecommendationCluster'da depolanır.
Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishFeaturedCluster
Bu API, FeaturedCluster
nesnelerinin listesini 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ğından alınan mevcut
FeaturedCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen Öne Çıkan Küme'de saklanır.
Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishContinuationCluster
Bu API, ContinuationCluster
nesnesini yayınlamak için kullanılır.
Kotlin
client.publishContinuationCluster(
PublishContinuationClusterRequest.Builder()
.setContinuationCluster(
ContinuationCluster.Builder()
.addEntity(book_entity1)
.addEntity(book_entity2)
.build())
.build())
Java
client.publishContinuationCluster(
PublishContinuationClusterRequest.Builder()
.setContinuationCluster(
ContinuationCluster.Builder()
.addEntity(book_entity1)
.addEntity(book_entity2)
.build())
.build())
Hizmet isteği aldığında tek bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağından alınan mevcut
ContinuationCluster
verileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen Continuation Cluster'da depolanır.
Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishUserAccountManagementRequest
Bu API, oturum açma kartı yayınlamak için kullanılır . Oturum açma işlemi, kullanıcıları uygulamanın oturum açma sayfasına yönlendirir. Böylece uygulama, içerik yayınlayabilir (veya daha kişiselleştirilmiş içerikler sunabilir).
Aşağıdaki meta veriler, oturum açma kartının bir parçasıdır:
Özellik | Şartlar | Açıklama |
---|---|---|
İşlem URI'si | Zorunlu | İşleme derin bağlantı (ör. uygulama oturum açma sayfasına yönlendirir) |
Resim | İsteğe bağlıdır. Sağlanmazsa başlık sağlanmalıdır. |
Kartta Gösterilen Resim 1264x712 çözünürlüğünde 16:9 en boy oranına sahip resimler |
Başlık | İsteğe bağlıdır. Sağlanmazsa resim sağlanmalıdır. | Kart üzerindeki başlık |
İşlem Metni | İsteğe bağlı | CTA'da Gösterilen Metin (ör. Oturum açın) |
Alt başlık | İsteğe bağlı | 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 bir işlemde aşağıdaki işlemler gerçekleşir:
- Geliştirici iş ortağından alınan 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
Herhangi bir dahili ticari nedenden dolayı kümelerin hiçbiri yayınlanmıyorsa updatePublishStatus API'yi kullanarak yayın durumunu güncellemenizi önemle tavsiye ederiz. Bu önemlidir, çünkü :
- İçerik yayınlanmış olsa 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 kritik öneme sahiptir.
- İçerik yayınlanmamış ancak entegrasyon durumu bozulmamışsa (STATUS == NOT_PUBLISHED), Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemeyi önleyebilir. İçeriğin, sağlayıcının bakış açısıyla beklenen bir durum nedeniyle yayınlanmadığını onaylar.
- Geliştiricilerin, verilerin ne zaman yayınlandığına dair bilgi vermesine yardımcı olur.
- Google, kullanıcıyı uygulamada belirli işlemleri yapmaya yönlendirmek için durum kodlarını kullanabilir. Böylece kullanıcılar uygulama içeriğini görebilir veya sorunları aşabilir.
Uygun yayınlama durumu kodlarının listesi :
// 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, oturum açmamış bir kullanıcı nedeniyle yayınlanmıyorsa Google, oturum açma kartının yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamıyorsa updatePublishStatus API'sinin NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla çağrılması önerilir.
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 Grupları'nın içeriğini silmek için kullanılır.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
Hizmet isteği aldığında mevcut verileri Öneri Kümeleri'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteFeaturedCluster
Bu API, Öne Çıkan Küme'nin içeriğini silmek için kullanılır.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
Hizmet isteği aldığında mevcut verileri Öne Çıkan Küme'den kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteContinuationCluster
Bu API, Devam Kümesi'nin içeriğini silmek için kullanılır.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
Hizmet, isteği aldığında mevcut verileri devamlılık kümesinden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteUserManagementCluster
Bu API, UserAccountManagement kümesinin içeriğini silmek için kullanılır.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
Hizmet isteği aldığında mevcut verileri UserAccountManagement kümesinden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
deleteClusters
Bu API, belirli bir küme türünün içeriğini silmek için kullanılır.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
...
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
...
.build());
Hizmet isteği aldığında mevcut verileri, belirtilen küme türleriyle eşleşen tüm kümelerden kaldırır. İstemciler bir veya daha fazla küme türü iletmeyi seçebilir. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
Hata işleme
Başarılı bir görevi kurtarmak ve yeniden göndermek için takip işlemi yapılabilmesi amacıyla yayınlama API'lerinden gelen görev sonucunu dinlemeniz önemle tavsiye edilir.
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(...)
.build())
.addOnCompleteListener(
task -> {
if (task.isSuccessful()) {
// do something
} else {
Exception exception = task.getException();
if (exception instanceof AppEngageException) {
@AppEngageErrorCode
int errorCode = ((AppEngageException) exception).getErrorCode();
if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
// do something
}
}
}
});
Hata, nedenini içeren bir AppEngageException
olarak döndürülür.
Hata kodu | Hata adı | Not |
---|---|---|
1 |
SERVICE_NOT_FOUND |
Hizmet, belirtilen cihazda kullanılamıyor. |
2 |
SERVICE_NOT_AVAILABLE |
Hizmet, söz konusu 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 |
İş parçacığı sorunları nedeniyle görev yürütme başarısız oldu. Bu durumda, işlem yeniden denenebilir. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Arayan kullanıcının hizmet çağrısı yapmasına izin verilmiyor. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
İstek geçersiz veriler içeriyor (örneğin, izin verilen küme sayısından daha fazla küme). |
6 |
SERVICE_CALL_INTERNAL |
Hizmet tarafında bir hata var. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Hizmet çağrısı çok sık yapılıyor. |
3. adım: Yayın amaçlarını işleme
İçerik yayınlama API çağrılarını bir iş aracılığıyla yapmanın yanı sıra, içerik yayınlama isteğini almak için BroadcastReceiver
ayarlamanız da gerekir.
Yayın niyetlerinin temel amacı, uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorlamaktır. Yayın amaçları çok sık gönderilmek üzere tasarlanmamıştır. Bu özellik yalnızca Engage Hizmeti, içeriğin eski olabileceğini (örneğin, bir hafta önce yayınlanmış) belirlediğinde tetiklenir. Bu sayede, uygulama uzun süredir çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğine dair daha fazla güven duyulur.
BroadcastReceiver
aşağıdaki iki şekilde ayarlanmalıdır:
BroadcastReceiver
sınıfının bir örneğiniContext.registerReceiver()
kullanarak dinamik olarak kaydedin. Bu, bellekte hâlâ etkin olan uygulamalardan iletişime izin verir.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continuation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}
public static void registerBroadcastReceivers(Context context) {
context = context.getApplicationContext();
// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
<receiver>
etiketiyle bir uygulamayıAndroidManifest.xml
dosyanızda statik olarak bildirin. Bu, uygulamanın çalışmadığı zamanlarda yayın amaçlarını almasına ve içeriği yayınlamasına olanak tanır.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Hizmet tarafından aşağıdaki amaçlar gönderilir:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
Bu amaç alındığındapublishRecommendationClusters
araması başlatmanız önerilir.com.google.android.engage.action.PUBLISH_FEATURED
Bu amaç alındığındapublishFeaturedCluster
araması başlatılması önerilir.- Bu amaç alındığında com.google.android.engage.action.PUBLISH_CONTINUATION
It is recommended to start a
publishContinuationCluster` çağrısı yapın.
Entegrasyon iş akışı
Entegrasyonunuz tamamlandıktan sonra doğrulama ile ilgili adım adım kılavuz için Geliştirici entegrasyonu iş akışını kullanma başlıklı makaleyi inceleyin.
SSS
SSS için Engage SDK ile ilgili sık sorulan sorular bölümüne bakın.
İletişim
Entegrasyon işlemi sırasında sorularınız olursa engage-developers@google.com
ile iletişime geçin. Ekibimiz en kısa sürede yanıt verecektir.
Sonraki adımlar
Bu entegrasyonu tamamladıktan sonraki adımlarınız şunlardır:
engage-developers@google.com
adresine e-posta gönderin ve Google tarafından test edilmeye hazır olan entegre APK'nızı ekleyin.- Google, entegrasyonun beklendiği gibi çalıştığından emin olmak için dahili olarak doğrulama ve inceleme yapar. Değişiklik yapılması gerekiyorsa Google, gerekli ayrıntıları paylaşmak için sizinle iletişime geçer.
- Test tamamlandığında ve herhangi bir değişiklik yapılması gerekmediğinde Google, güncellenmiş ve entegre edilmiş APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
- Google, güncellenen APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri, Öne Çıkanlar ve Devam kümeleriniz yayınlanır ve kullanıcılara gösterilir.