Engage SDK'sı Okuma: Üçüncü taraf teknik entegrasyon talimatları

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'ya 50 KB'tan daha az (sıkıştırılmış) boyut ekler ve çoğu uygulamanın geliştirici süresini yaklaşık bir hafta uzatır. 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, bloglar, haberler ve dergiler) sunmayla ilgili talimatlar yer almaktadır.

Kategori desteği ve yüzeyler

Engage SDK yüzey uygunluğu, uygulamanızın içerik kategorisine bağlıdır. Belirli yüzeylerde uygunluğunuzu belirlemek için aşağıdaki tabloyu kullanın:

Durum İçerik kategorisi veya kullanım alanı Desteklenen yüzeyler
Desteklenir
(Tüm platformlarda kullanılabilir)
  • e-Kitaplar
  • Çizgi Roman ve Manga
  • Sesli Kitaplar
  • Kullanıcı Tarafından Üretilen İçerik uzun biçimli okuma hizmetleri
  • Bloglar
  • Koleksiyonlar
  • Entertainment Space
  • Play Store Uygulamaları sekmesi
  • Play Store'daki Siz sekmesi (yalnızca kişiselleştirilmiş öneriler ve devam ettirme)
  • Play Store mağaza girişi sayfası
Kısmen destekleniyor
(Bazı platformlarda uygundur)
  • Haberler ve Dergiler*
  • Koleksiyonlar
  • Entertainment Space
Desteklenmiyor
  • E-kitap veya PDF okuyucu
  • Kitap yorumları
  • Ansiklopedi / Sözlük
  • Çevirmen
  • Dini metin

Haber uygulamaları

Haber uygulamaları, her biri kendine özgü uygunluk kurallarına tabi olan çeşitli içerikler sunar. Play Store'daki Engage SDK içeriği, Play Premium Growth Tools ile uyumlu olduğundan haber uygulamalarındaki araçlar, haber makaleleri ve video klipler, Koleksiyonlar ve Entertainment Space'te kullanılabilse de Play Store'da kullanılamaz. Bununla birlikte, podcast'ler ve tarifler gibi geleneksel olmayan haber içerikleri Play Store'da yer almaya uygun olabilir:

Tüzel kişi türü Koleksiyonlara uygun Entertainment Space için uygun Play Store'da kullanılabilir
Haber makalesi Evet (Okuma sekmesi) Evet (Okuma sekmesi) Hayır
Video klip Evet (İzleme sekmesi) Evet (İzleme sekmesi) Hayır
Podcast Evet (Dinle sekmesi) Evet (Dinle sekmesi) Evet
Yemek Tarifi Evet (Yemek sekmesi) Hayır Evet

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, bireysel 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 önerilerinden oluşan bir grubu içeren kullanıcı arayüzü görünümü.

      Şekil 1. 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. Bir öğe; e-kitap, sesli kitap, kitap serisi vb. olabilir. Desteklenen öğe türlerinin listesi için Öğe 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ü.
  • Devam kümesi, birden fazla geliştirici iş ortağının tamamlanmamış kitaplarını tek bir kullanıcı arayüzü grubunda gösterir. Her geliştirici iş ortağı, Devamlılık kümesinde en fazla 10 öğe yayınlayabilir.

    Şekil 3. 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 oluşan bir seçkiyi gösterir. Tek bir Öne Çıkan kümesi olacak. Bu küme, tüm Öneri kümelerinin üzerinde öncelikli bir yerleşimle kullanıcı arayüzünün üst kısmına yakın bir yerde gösterilecek. Her geliştirici iş ortağı, Öne Çıkan kümesinde 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

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.6.0'
}

Özet

Tasarım, bağlı bir hizmetin uygulanmasına dayanır.

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

Küme türü Küme sınırları Bir kümedeki maksimum öğe sınırı
Öneri kümeleri En fazla 7 En fazla 50
Devam 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 öğeleri destekliyoruz:

  1. EbookEntity
  2. AudiobookEntity
  3. BookSeriesEntity

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

EbookEntity

EbookEntity nesnesi bir e-kitabı (örneğin, Michelle Obama'nın Becoming adlı kitabının e-kitabı) temsil eder.

Özellik Şartlar Notlar
Ad Zorunlu
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yönergeler 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: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümüne bakın

Yayınlanma tarihi İsteğe bağlı Sağlanırsa sıfır zaman milisaniyesi 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ğlanıyorsa 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 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: Tamamlanmamış 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 et" kümesinin bir parçası olabilir.

Epoch milisaniye cinsinden.

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 uygundur.

Epoch milisaniye cinsinden.

Bitiş zaman damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmeyeceği dönüm noktası zaman damgası.

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

Epoch milisaniye cinsinden.

AudiobookEntity

AudiobookEntity nesnesi, sesli kitapları (ör. Michelle Obama'nın Becoming adlı kitabının sesli kitabı) temsil eder.

Özellik Şartlar Notlar
Ad Zorunlu
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yönergeler 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: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümüne 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ğlanırsa sıfır zaman milisaniyesi 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ğlanırsa 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 birim 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: Tamamlanmamış 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.

Epoch milisaniye cinsinden.

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 uygundur.

Epoch milisaniye cinsinden.

Bitiş zaman damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmeyeceği dönüm noktası zaman damgası.

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

Epoch milisaniye cinsinden.

BookSeriesEntity

BookSeriesEntity nesnesi bir kitap serisini (örneğin, 7 kitaptan oluşan Harry Potter kitap serisi) temsil eder.

Özellik Şartlar Notlar
Ad Zorunlu
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yönergeler 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: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS bölümüne 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.
Kitap türüne devam et İsteğe bağlı

TYPE_CONTINUE: Tamamlanmamış 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.

Epoch milisaniye cinsinden.

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 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 uygundur.

Epoch milisaniye cinsinden.

Bitiş zaman damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmeyeceği dönüm noktası zaman damgası.

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

Epoch milisaniye cinsinden.

Resim özellikleri

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

En boy oranı Desteklenen küme(ler) Minimum piksel sayısı Önerilen piksel sayısı
Kare (1x1) Tüm kümeler 300x300 1200x1200
Yatay (1,91x1) Öne çıkarılan ve devam 600x314 1.200x628
Dikey (4x5) Öneri 480x600 960x1200

Dosya biçimleri

PNG, JPG, statik GIF, WebP

Maksimum dosya boyutu

5120 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 yürütülmesi (ör. WorkManager kullanılarak) ve düzenli olarak veya etkinlik bazında (ör. 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.

Yayınlamayı planladığınız her küme türü için hizmetin kullanılabilirliğini kontrol edebilirsiniz. isServiceAvailable API, hizmet kullanılabilirliğinin kontrol edilmesi gereken küme türlerini içeren bir istek nesnesi, ServiceAvailabilityRequest kabul eder. ClusterType enum değerlerini ServiceAvailabilityRequest için aşağıdaki tablodan bulabilirsiniz.

Küme Türü Küme Türü Sabiti Tam Sayı Değeri
Bilinmiyor TYPE_UNKNOWN 0
Öneri Kümesi TYPE_RECOMMENDATION 1
Öne Çıkan Küme TYPE_FEATURED 2
Devam Kümesi TYPE_CONTINUATION 3
Kullanıcı Yönetimi Kümesi TYPE_ENGAGEMENT 8
Abonelik Kümesi TYPE_SUBSCRIPTION 12

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here such as retry.
    }
});
Koşullu Hizmet Kullanılabilirliği Özelliği

Bazı entegre uygulamalar, yayın maliyetlerini düşürmek için Engage hizmetini aralıklı olarak etkinleştiren ve devre dışı bırakan özel bir yapılandırma ister. Bu aralıklı içerik alımı stratejisi mümkün olsa da kullanıcıyı ve ürünü olumsuz etkiler. Eski içerikler gösterilmez ve bazı yüzeyler hiç sunulmaz.

Engage SDK, v1.6.0 sürümünden itibaren belirli küme türlerinin kullanılabilirliğini kontrol etmeye olanak tanır. Bu sayede, belirli bir uygulama aralıklı içerik stratejisini benimsediyse bazı küme türleri bu aralıklı stratejiyi takip edebilirken diğer küme türleri her zaman etkin olabilir (ör. devamlılık kümeleri).

Etkileşim hizmetinin herhangi bir nedenle desteklenen tüm cihazlarda "sürekli" olarak etkinleştirilmemesi ve herhangi bir cihaz grubu için aralıklı olarak veri alacak şekilde yapılandırılması durumunda, tüm devamlılık grubu yayınları (ör.Okumaya Devam Et) varsayılan yapılandırmayla etkinleştirilmeye devam eder. Diğer grup türleri ise aralıklı olarak etkinleştirilir ve devre dışı bırakılır. Aralıklı alım sizin için geçerliyse ancak bu varsayılan yapılandırma ihtiyaçlarınıza uygun değilse lütfen engage-developers@google.com adresiyle iletişime geçin.

v1.6.0'dan önceki SDK sürümleri için (desteği sonlandırıldı)

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 alınan 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 depolanı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. Bu özellik sağlanmazsa Başlık özelliği 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ı. Sağlanmazsa resim sağlanmalıdır. Kartın üzerindeki ad
İşlem Metni İsteğe bağlı CTA'da Gösterilen Metin (ör. Oturum aç)
Alt başlık İsteğe bağlı Kartta isteğe bağlı altyazı

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

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

  • Geliştirici iş ortağı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 yayın durumunu updatePublishStatus API'sini kullanarak güncellemenizi şiddetle tavsiye ederiz. Bu önemlidir, çünkü :

  • İçerik yayınlanmış olsa bile (STATUS == PUBLISHED) tüm senaryolarda durumu sağlamak, entegrasyonunuzun durumu 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.
  • Bu, geliştiricilerin verilerin ne zaman yayınlandığına dair analizler sunmasına 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 sorunu 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'sini NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla çağırmaları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 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 Grupları'ndan kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteFeaturedCluster

Bu API, öne çıkarılan 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 durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteContinuationCluster

Bu API, Devam Ettirme 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. Müşteriler bir veya daha fazla küme türü iletebilir. 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ılabiliyor ancak arama sırasında kullanılamıyor (örneğin, açıkça devre dışı bırakılmış).
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ın hizmet araması yapmasına izin verilmiyor.
5 SERVICE_CALL_INVALID_ARGUMENT İstek geçersiz veriler içeriyor (ör. izin verilen küme sayısından fazla).
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şleyin

İç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 bir BroadcastReceiver ayarlamanız da gerekir.

Yayın amaçlarının temel hedefi, 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 (ör. 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şayacağından daha fazla emin olunabilir.

BroadcastReceiver aşağıdaki iki şekilde ayarlanmalıdır:

  • BroadcastReceiver sınıfının bir örneğini Context.registerReceiver() kullanarak dinamik olarak kaydedin. Bu, bellekte hâlâ etkin olan uygulamalardan gelen iletişime olanak tanır.

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> dosyanızda AndroidManifest.xml etiketiyle statik olarak bir uygulama beyan edin. 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ığında publishRecommendationClusters görüşmesi başlatılması önerilir.
  • com.google.android.engage.action.PUBLISH_FEATURED Bu amaç isteği alındığında publishFeaturedCluster araması başlatılması önerilir.
  • com.google.android.engage.action.PUBLISH_CONTINUATIONIt is recommended to start apublishContinuationCluster` çağrısı yapın.

Entegrasyon iş akışı

Entegrasyonunuz tamamlandıktan sonra doğrulama ile ilgili adım adım kılavuz için Engage geliştirici entegrasyonu iş akışı başlıklı makaleyi inceleyin.

SSS

Sık sorulan sorular için Engage SDK ile ilgili sık sorulan sorular bölümüne bakın.

İletişim

Entegrasyon süreciyle ilgili 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 bir doğrulama ve inceleme gerçekleştirir. 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ılar tarafından görülebilir.