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 alan alanını hem de mevcut Google alanlarını doldurmak için Engage SDK'sını kullanarak okunabilir içeriklerini entegre etme talimatları yer almaktadır.
Entegrasyon ayrıntısı
Terminoloji
Bu entegrasyon aşağıdaki üç küme türünü içerir: Öneri, Devam ve Öne Çıkan.
Öneri kümeleri, bağımsız bir geliştirici iş ortağından okunacak içerik için kişiselleştirilmiş öneriler gösterir.
Önerileriniz aşağıdaki yapıya göre yapılır:
Öneri Kümesi: Tek bir geliştirici iş ortağının öneri grubunu içeren bir kullanıcı arayüzü görünümü.
Şekil 1. Tek bir iş ortağının Öneri Kümesini gösteren Entertainment Space kullanıcı arayüzü. Varlık: Bir kümedeki tek bir öğeyi temsil eden nesne. Varlık, e-kitap, sesli kitap, kitap serisi vb. olabilir. Desteklenen varlık türlerinin listesi için Varlık verileri sağlama bölümüne bakın.
Şekil 2. Tek bir iş ortağının Öneri Kümesi'ndeki tek bir öğeyi gösteren Entertainment Space kullanıcı arayüzü.
Devam kümesi, birden fazla geliştirici iş ortağının tamamlanmamış kitaplarını tek bir kullanıcı arayüzü gruplandırmasında gösterir. Her geliştirici iş ortağının, Devam kümesinde en fazla 10 öğe yayınlamasına izin verilir.
Şekil 3. Birden fazla iş ortağının tamamlanmamış önerilerini içeren bir devam kümesini gösteren Eğlence Alanı kullanıcı arayüzü (şu anda yalnızca bir öneri görünür). Öne Çıkan kümesi, birden fazla geliştirici iş ortağının öğelerinden oluşan bir seçkiyi tek bir kullanıcı arayüzü gruplandırmasında gösterir. Tek bir Öne Çıkan küme bulunur. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneriler kümelerinin üzerinde öncelikli olarak yerleştirilir. Her geliştirici iş ortağının Öne Çıkanlar kümesinde en fazla 10 varlık yayınlamasına izin verilir.
Şekil 4. Birden fazla iş ortağının önerilerini içeren Öne Çıkan kümeyi 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
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 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 çok 5 | En fazla 50 |
| Devam Kümesi | En fazla 1 | En fazla 10 |
| Öne Çıkan Küme | En fazla 1 | En fazla 10 |
1. adım: Öğe verilerini sağlayın
SDK'da her öğe türünü temsil eden farklı varlıklar tanımlanmıştır. Okuma kategorisi için aşağıdaki varlıkları destekliyoruz:
EbookEntityAudiobookEntityBookSeriesEntity
Aşağıdaki grafiklerde, her tür için kullanılabilen özellikler ve şartlar özetlenmiştir.
EbookEntity
EbookEntity nesnesi bir e-kitabı temsil eder (örneğin, Michelle Obama'nın Becoming adlı e-kitabı).
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri'ne bakın. |
| Yazar | Zorunlu | En az bir yazar adı sağlanmalıdır. |
| İşlem bağlantısı uri'si | Zorunlu |
E-kitabın sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
| Yayınlanma tarihi | İsteğe bağlı | Sağlanmışsa dönem milisaniyesi cinsinden. |
| Açıklama | İsteğe bağlı | Varsa en fazla 200 karakter uzunluğunda olmalıdır. |
| Fiyat | İsteğe bağlı | Serbest metin |
| Sayfa sayısı | İsteğe bağlı | Sağlanmışsa 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 serinin adı (ör. Harry Potter). |
| Seri birim dizini | İsteğe bağlı | Serideki e-kitabın dizini. 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. |
| Kitap türüne devam et | İsteğe bağlı |
TYPE_CONTINUE: Bitirilmemiş bir kitabı devam ettirin. TYPE_NEXT: Bir serinin yeni birinde devam edin. TYPE_NEW: Yeni yayınlandı. |
| Son Etkileşim Zamanı | Koşullu olarak zorunlu |
Öğe, Devam kümesinde olduğunda sağlanmalıdır. *Yeni* edinilen e-kitaplar, okumaya devam etme kümesinin bir parçası olabilir. Milisaniye cinsinden. |
| Tamamlanan yüzde | Koşullu olarak zorunlu |
Öğe, Devam kümesinde olduğunda sağlanmalıdır. Değer 0'dan büyük ve 100'den küçük olmalıdır. |
| DisplayTimeWindow: Bir içeriğin yüzeyde gösterileceği zaman aralığını ayarlama | ||
| 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. |
| Bitiş zaman damgası | İsteğe bağlı |
İçeriğin artık ilk sayfada gösterilmediği dönem zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur. Milisaniye cinsinden. |
AudiobookEntity
AudiobookEntity nesnesi, bir sesli kitabı temsil eder (ör. Michelle Obama'nın Becoming adlı kitabının sesli kitabı).
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri'ne bakın. |
| Yazar | Zorunlu | En az bir yazar adı sağlanmalıdır. |
| Anlatıcı | Zorunlu | En az bir anlatıcı adı sağlanmalıdır. |
| İşlem bağlantısı URI'si | Zorunlu |
Sesli kitabın sağlayıcı uygulamasının derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
| Yayınlanma tarihi | İsteğe bağlı | Sağlanmışsa dönem milisaniyesi cinsinden. |
| Açıklama | İsteğe bağlı | Varsa en fazla 200 karakter uzunluğunda olmalı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 serinin adı (örneğin, Harry Potter). |
| Seri birimi dizini | İsteğe bağlı | Serideki sesli kitabın dizini. 1, serideki ilk sesli kitaptır. Örneğin, Harry Potter ve Azkaban Tutsağı serinin 3. kitabıysa bu değer 3 olarak ayarlanmalıdır. |
| Kitap türüne devam et | İsteğe bağlı |
TYPE_CONTINUE: Bitirilmemiş bir kitabı devam ettirin. TYPE_NEXT: Bir serinin yeni birinde devam edin. TYPE_NEW: Yeni yayınlandı. |
| Son Etkileşim Zamanı | Koşullu olarak zorunlu | Öğe Devam kümesindeyken sağlanmalıdır. Milisaniye cinsinden. |
| Tamamlanan yüzde | Koşullu olarak zorunlu |
Öğe Devam kümesindeyken sağlanmalıdır. *Yeni* edinilen sesli kitaplar, okuma devam edenler kümesinin bir parçası olabilir. Değer 0'dan büyük ve 100'den küçük olmalıdır. |
| DisplayTimeWindow: Bir içeriğin yüzeyde gösterileceği zaman aralığını ayarlama | ||
| 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. |
| Bitiş zaman damgası | İsteğe bağlı |
İçeriğin artık ilk sayfada gösterilmediği dönem zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur. Milisaniye cinsinden. |
BookSeriesEntity
BookSeriesEntity nesnesi bir kitap serisini temsil eder (örneğin, 7 kitaptan oluşan Harry Potter kitap serisi).
| Özellik | Şartlar | Notlar |
|---|---|---|
| Ad | Zorunlu | |
| Poster resimleri | Zorunlu | En az bir resim sağlanmalıdır. Yardım için Resim Özellikleri'ne bakın. |
| Yazar | Zorunlu | En az bir yazar adı olmalıdır. |
| İşlem bağlantısı uri'si | Zorunlu |
Sesli kitap veya e-kitap için sağlayıcı uygulamasına ait derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın |
| Kitap sayısı | Zorunlu | Serideki kitap sayısı. |
| Açıklama | İsteğe bağlı | Varsa en fazla 200 karakter uzunluğunda olmalıdır. |
| Tür | İsteğe bağlı | Kitapla ilişkili türlerin listesi. |
| Kitap türüne devam et | İsteğe bağlı |
TYPE_CONTINUE: Bitirilmemiş bir kitabı devam ettirin. TYPE_NEXT: Bir serinin yeni birinde devam edin. TYPE_NEW: Yeni yayınlandı. |
| Son Etkileşim Zamanı | Koşullu olarak zorunlu | Öğe Devam kümesindeyken sağlanmalıdır. Milisaniye cinsinden. |
| Tamamlanan yüzde | Koşullu olarak zorunlu | Öğe Devam kümesindeyken sağlanmalıdır. *Yeni* edinilen kitap serileri, 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: Bir içeriğin yüzeyde gösterileceği zaman aralığını ayarlama | ||
| 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. |
| Bitiş zaman damgası | İsteğe bağlı |
İçeriğin artık ilk sayfada gösterilmediği dönem zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur. Milisaniye cinsinden. |
Resim özellikleri
Resim öğeleri için gerekli özellikler aşağıda listelenmiştir:
| En boy oranı | Şartlar | Minimum piksel sayısı | Önerilen piksel sayısı |
|---|---|---|---|
| Kare (1x1) | Zorunlu | 300x300 | 1.200x1.200 |
| Yatay (1,91x1) | İsteğe bağlı | 600x314 | 1.200x628 |
| 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ğ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.
AppEngagePublishClient, kümeleri yayınlamaktan sorumludur. İstemcide aşağıdaki API'ler kullanılabilir:
isServiceAvailablepublishRecommendationClusterspublishFeaturedClusterpublishContinuationClusterpublishUserAccountManagementRequestupdatePublishStatusdeleteRecommendationsClustersdeleteFeaturedClusterdeleteContinuationClusterdeleteUserManagementClusterdeleteClusters
isServiceAvailable
Bu API, hizmetin entegrasyon için kullanılıp kullanılamadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.
Kotlin
client.isServiceAvailable.addOnCompleteListener { task -> if (task.isSuccessful) { // Handle IPC call success if(task.result) { // Service is available on the device, proceed with content // publish calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } }
Java
client.isServiceAvailable().addOnCompleteListener(task - > { if (task.isSuccessful()) { // Handle success if(task.getResult()) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } });
publishRecommendationClusters
Bu API, RecommendationCluster nesnelerinin listesini yayınlamak için kullanılır.
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, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:
- Geliştirici iş ortağının mevcut
RecommendationClusterverileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenmiş öneri kümesinde depolanır.
Hata olması 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ğının mevcut
FeaturedClusterverileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen Öne Çıkan Küme'de depolanır.
Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.
publishContinuationCluster
Bu API, ContinuationCluster nesnesi 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ğındaki mevcut
ContinuationClusterverileri kaldırılır. - İstekten elde edilen veriler ayrıştırılır ve güncellenmiş Devam Kümesinde depolanır.
Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
publishUserAccountManagementRequest
Bu API, bir 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. uygulamanın 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üklü, 16x9 en boy oranında resimler |
| Başlık | İsteğe bağlı: Sağlanmamışsa resim sağlanmalıdır | Karttaki başlık |
| İşlem Metni | İsteğe bağlı | CTA'da (ör. Oturum Aç) gösterilen metin |
| Alt başlık | İsteğe bağlı | Kartta isteğe bağlı altyazı |
Kotlin
var SIGN_IN_CARD_ENTITY = SignInCardEntity.Builder() .addPosterImage( Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build() client.publishUserAccountManagementRequest( PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY = new SignInCardEntity.Builder() .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build(); client.publishUserAccountManagementRequest( new PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Hizmet isteği aldığında, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:
- Geliştirici iş ortağının mevcut
UserAccountManagementClusterverileri kaldırılır. - İstekten gelen veriler ayrıştırılır ve güncellenen UserAccountManagementCluster kümesinde depolanır.
Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.
updatePublishStatus
İşletmeyle ilgili herhangi bir nedenle kümelerden hiçbiri yayınlanmaz. Yayınlama durumunu updatePublishStatus API'sini kullanarak güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü:
- İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumu sağlamak, entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu açık durumu kullanan kontrol panellerini doldurmak açısından çok önemlidir.
- Hiçbir içerik yayınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulamanın sağlık kontrol panellerinde uyarı tetiklemekten kaçınabilir. Bu bildirim, sağlayıcı açısından beklenen bir durum nedeniyle içeriğin yayınlanmadığını onaylar.
- Geliştiricilerin, verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığıyla ilgili bilgi sağlamasına yardımcı olur.
- Google, kullanıcının uygulama içeriğini görmesini veya bu engeli aşmasını sağlamak için uygulamada belirli işlemleri yapmasına teşvik etmek amacıyla durum kodlarını kullanabilir.
Uygun yayınlama durumu kodlarının listesi şunlardır:
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
İçerik, kullanıcının giriş yapmaması nedeniyle yayınlanmıyorsa Google, oturum açma kartını 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 mevcut verileri Öne Çıkan Küme'den kaldırır. Hata olması 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 Devam Kümesi'nden kaldırır. Bir 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. Bir 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ümelerdeki mevcut verileri kaldırır. İstemciler bir veya daha fazla küme türünü geçirmeyi seçebilir. Bir 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, nedeni hata kodu olarak eklenmiş 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, belirli bir cihazda kullanılabilir ancak arama sırasında kullanılamaz (örneğin, açıkça devre dışı bırakılmıştır). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
Görev yürütülemedi, ileti dizisi sorunları nedeniyle başarısız oldu. Bu durumda, işlem yeniden denenebilir. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
Arayan kullanıcının servis araması yapmasına izin verilmiyor. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
İstek geçersiz veriler içeriyor (örneğin, izin verilenden daha fazla sayıda küme). |
6 |
SERVICE_CALL_INTERNAL |
Hizmet tarafında bir hata oluştu. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
Servis çağrısı çok sık yapılıyor. |
3. Adım: Yayın amaçlarını ele alın
İçerik yayınlama isteğini almak için bir iş üzerinden Content API çağrıları yapmanın yanı sıra bir BroadcastReceiver oluşturmak da gerekir.
Yayın niyetinin 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 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()kullanarakBroadcastReceiversı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 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));
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));
// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));
}
AndroidManifest.xmldosyanızda<receiver>etiketiyle uygulamayı statik olarak beyan edin. Bu, uygulamanın çalışmadığı zamanlarda yayın istekleri almasına ve 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.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
Aşağıdaki hedefler hizmet tarafından gönderilir:
com.google.android.engage.action.PUBLISH_RECOMMENDATIONBu amacı aldığınızdapublishRecommendationClustersçağrısı başlatmanız önerilir.com.google.android.engage.action.PUBLISH_FEATUREDBu intent'i aldığınızdapublishFeaturedClusterçağrısı başlatmanız önerilir.- Bu amacı aldığında com.google.android.engage.action.PUBLISH_CONTINUATION
It is recommended to start apublishContinuationCluster` çağrısını kullanın.
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ı hakkında 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 adresinden bizimle iletişime geçebilirsiniz. Ekibimiz mümkün olan 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 bilgileri sizinle paylaşmak için sizinle iletişime geçer.
- Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre 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 ve Devam kümeleriniz yayınlanır ve kullanıcılara gösterilir.