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 kişiselleştirilmiş önerileri ve devam içeriklerini doğrudan Koleksiyonlar, Entertainment Space ve Google Play Store gibi cihaz üzerindeki birden fazla yüzeyde kullanıcılara sunun. Entegrasyon, ortalama APK'ya 50 KB'tan daha az (sıkıştırılmış) boyut ekler ve çoğu uygulama için yaklaşık bir haftalık geliştirici süresi alır. Daha fazla bilgi için işletme sitemizi ziyaret edin.

Bu kılavuzda, geliştirici iş ortaklarının okuma içeriklerini (e-kitaplar, sesli kitaplar, çizgi romanlar/manga, bloglar, haberler ve dergiler) Engage içerik yüzeylerine sunmasıyla ilgili talimatlar yer alır.

Kategori desteği ve yüzeyler

Engage SDK yüzey uygunluğu, uygulamanızın içerik kategorisine bağlıdır. Belirli platformlara uygunluk durumunuzu 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 oluşturulan içeriklerin yer aldığı uzun metin okuma hizmetleri
  • Bloglar
  • Koleksiyonlar
  • Entertainment Space
  • Google Play Store Uygulamalar sekmesi
  • Play Store Siz sekmesi (Yalnızca kişiselleştirilmiş öneriler ve devam etme)
  • Google Play Store mağaza girişi sayfası
Kısmen destekleniyor
(Bazı platformlarda kullanılabilir)
  • 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 benzersiz uygunluk kurallarına tabi olan çeşitli içerikler sunar. Google Play Store'daki Engage SDK içerikleri, Google Play Premium Büyüme Araçları ile uyumlu olduğundan haber uygulamalarındaki haber makaleleri ve video klipler Google Play Store için uygun değildir ancak Koleksiyonlar ve Entertainment Space için uygundur. Öte yandan, podcast'ler ve yemek tarifleri gibi geleneksel olmayan haber içerikleri Google Play Store'da yer almaya uygun olabilir:

Tüzel kişi türü Koleksiyonlar için uygun Entertainment Space için uygun Google Play Store için uygun
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ı

Bu bölümde, okuma içerikleri için Engage SDK ile entegrasyon yapmak üzere gereken adımlar, veri modelleri ve terminoloji ayrıntılı olarak açıklanmaktadır.

Terminoloji

Bu entegrasyon şu üç küme türünü içerir: Öneri, Devam ve Öne Çıkanlar.

  • Öneri kümeleri, belirli 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ğından gelen bir grup öneriyi içeren kullanıcı arayüzü görünümü.

      Şekil 1. Tek bir iş ortağından öneri kümesi 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 ve daha fazlası olabilir. Desteklenen varlık türlerinin listesi için Varlık verilerini 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ğının, devam kümesinde en fazla 10 öğe yayınlamasına izin verilir.

    Şekil 3. Birden fazla iş ortağından tamamlanmamış öneriler içeren bir Devam kümesini gösteren Entertainment Space kullanıcı arayüzü (şu anda yalnızca bir öneri görünür).

  • Öne Çıkanlar kümesi, birden fazla geliştirici iş ortağının seçili öğelerini tek bir kullanıcı arayüzü grubunda gösterir. Tek bir Öne Çıkan kümesi olacak. 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österilecek. Her geliştirici iş ortağının, Öne Çıkanlar kümesinde en fazla 10 öğe yayınlamasına izin verilir.

    Şekil 4. Birden fazla iş ortağından öneriler 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ğlama hizmetinin uygulanmasına dayanır.

Bir istemcinin yayınlayabileceği veriler, farklı küme türleri için aşağıdaki sınırlamalara 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
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ı varlıklar tanımlamıştır. Okuma kategorisi için aşağıdaki varlıkları destekliyoruz:

  1. EbookEntity
  2. AudiobookEntity
  3. BookSeriesEntity

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

EbookEntity

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

Özellik Şartlar Notlar
Ad Zorunlu
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yönergeler için Resim Özellikleri'ni inceleyin.
Yazar Zorunlu En az bir yazar adı belirtilmelidir.
İşlem bağlantısı URI'si Zorunlu

E-kitap için sağlayıcı uygulamasına yönlendiren derin bağlantı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

Yayınlanma tarihi İsteğe bağlı Belirtilmişse milisaniye cinsinden sıfır zaman.
Açıklama İsteğe bağlı Sağlanıyorsa 200 karakterden az 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ı E-kitabın serideki 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ünü seçmeye devam et İsteğe bağlı

TYPE_CONTINUE - Tamamlanmamış bir kitaba devam etme.

TYPE_NEXT - Bir serinin yeni bir öğesinde devam etme.

TYPE_NEW - Yeni yayınlandı.
Son Etkileşim Zamanı Koşula bağlı olarak gerekli

Öğe, devam kümesindeyse sağlanmalıdır.

*Yeni* edinilen e-kitaplar, okumaya devam etme kümesinin bir parçası olabilir.

Epoch milisaniye cinsinden.
Tamamlanan İlerleme Yüzdesi Koşula bağlı olarak gerekli

Öğe, devam kümesindeyse 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ı ayarlama
Başlangıç Zaman Damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmesi gereken zaman damgası.

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

Epoch milisaniye cinsinden.
Bitiş Zaman Damgası İsteğe bağlı

İçeriğin artık yüzeyde gösterilmeyeceği zaman damgası.

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

Epoch milisaniye cinsinden.

AudiobookEntity

AudiobookEntity nesnesi bir sesli kitabı (örneğin, Michelle Obama'nın Benim Hikayem adlı sesli kitabını) temsil eder.

Özellik Şartlar Notlar
Ad Zorunlu
Poster resimleri Zorunlu En az bir resim sağlanmalıdır. Yönergeler için Resim Özellikleri'ni inceleyin.
Yazar Zorunlu En az bir yazar adı belirtilmelidir.
İşlem bağlantısı URI'si Zorunlu

Sesli kitap için sağlayıcı uygulamasına yönlendiren derin bağlantı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

Anlatıcı İsteğe bağlı En az bir anlatıcının adı belirtilmelidir.
Yayınlanma tarihi İsteğe bağlı Belirtilmişse milisaniye cinsinden sıfır zaman.
Açıklama İsteğe bağlı Sağlanıyorsa 200 karakterden az olmalıdır.
Fiyat İsteğe bağlı Serbest metin
Süre İsteğe bağlı Belirtilmişse 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ı (ör. Harry Potter).
Seri birim dizini İsteğe bağlı Sesli kitabın serideki 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ünü seçmeye devam et İsteğe bağlı

TYPE_CONTINUE - Tamamlanmamış bir kitaba devam etme.

TYPE_NEXT - Bir serinin yeni bir öğesinde devam etme.

TYPE_NEW - Yeni yayınlandı.
Son Etkileşim Zamanı Koşula bağlı olarak gerekli

Öğe, devam kümesindeyse sağlanmalıdır.

Epoch milisaniye cinsinden.
Tamamlanan İlerleme Yüzdesi Koşula bağlı olarak gerekli

Öğe, devam kümesindeyse 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ı ayarlama
Başlangıç Zaman Damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmesi gereken zaman damgası.

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

Epoch milisaniye cinsinden.
Bitiş Zaman Damgası İsteğe bağlı

İçeriğin artık yüzeyde gösterilmeyeceği zaman damgası.

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

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'ni 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ına yönlendiren derin bağlantı.

Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS sayfasına bakın

Kitap sayısı Zorunlu Serideki kitap sayısı.
Açıklama İsteğe bağlı Sağlanıyorsa 200 karakterden az olmalıdır.
Tür İsteğe bağlı Kitapla ilişkili türlerin listesi.
Kitap türünü seçmeye devam et İsteğe bağlı

TYPE_CONTINUE - Tamamlanmamış bir kitaba devam etme.

TYPE_NEXT - Bir serinin yeni bir öğesinde devam etme.

TYPE_NEW - Yeni yayınlandı.
Son Etkileşim Zamanı Koşula bağlı olarak gerekli

Öğe, devam kümesindeyse sağlanmalıdır.

Epoch milisaniye cinsinden.
Tamamlanan İlerleme Yüzdesi Koşula bağlı olarak gerekli

Öğe, devam kümesindeyse 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ı ayarlama
Başlangıç Zaman Damgası İsteğe bağlı

İçeriğin yüzeyde gösterilmesi gereken zaman damgası.

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

Epoch milisaniye cinsinden.
Bitiş Zaman Damgası İsteğe bağlı

İçeriğin artık yüzeyde gösterilmeyeceği zaman damgası.

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

Epoch milisaniye cinsinden.

Resim özellikleri

Aşağıdaki tabloda, resim öğeleri için gerekli özellikler listelenmiştir:

En boy oranı Desteklenen kümeler Minimum piksel sayısı Önerilen piksel sayısı
Kare (1x1) Tüm kümeler 300x300 1200x1200
Yatay (1,91x1) Öne çıkan ve devam eden 600x314 1200x628
Dikey (4x5) Öneri 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 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 sepetine bir şey eklediğinde) planlanması önerilir.

AppEngagePublishClient, kümeleri yayınlamaktan sorumludur. İstemcide aşağıdaki API'ler kullanılabilir:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishContinuationCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteContinuationCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

Bu API, hizmetin entegrasyon için kullanılabilir 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 hizmet kullanılabilirliğini kontrol edebilirsiniz. isServiceAvailable API'si, hizmet kullanılabilirliğinin kontrol edilmesi gereken küme türlerini içeren bir istek nesnesi (ServiceAvailabilityRequest) kabul eder. ServiceAvailabilityRequest için gereken ClusterType enum değerlerini aşağıdaki tabloda bulabilirsiniz.

Cluster Type (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ınlama maliyetlerini azaltmak için Engage hizmetini aralıklı olarak etkinleştiren ve devre dışı bırakan özel bir yapılandırma ister. Ancak bu aralıklı içerik besleme stratejisi, kullanıcı deneyimini olumsuz etkiler: Eski içerikler sunulmaz ve bazı platformlarda yayınlanmaz.

Engage SDK'sı, 1.6.0 sürümünden itibaren belirli küme türlerinin kullanılabilirliğini kontrol etmenize olanak tanır. Uygulamanız aralıklı besleme kullanıyorsa:

  • Devam kümeleri (ör. Okumaya Devam Et), desteklenen tüm cihazlarda varsayılan olarak etkin kalır.
  • Diğer küme türleri (ör. Öneriler) aralıklı olarak etkinleştirilir ve devre dışı bırakılır.

Bu varsayılan yapılandırma ihtiyaçlarınıza uygun değilse engage-developers@google.com ile iletişime geçin.

1.6.0 sürümünden ö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 eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut RecommendationCluster verileri kaldırılır.
  • İstekteki veriler ayrıştırılır ve güncellenen öneri kümesinde 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 eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut FeaturedCluster verileri kaldırılır.
  • İstekteki 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, bir 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 eylemler gerçekleşir:

  • Geliştirici iş ortağından alınan mevcut ContinuationCluster verileri kaldırılır.
  • İstekten alınan veriler ayrıştırılır ve güncellenen devam kümesinde 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çerik 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ı: Sağlanmazsa başlık sağlanmalıdır.

Kartta gösterilen resim

1264x712 çözünürlüğe sahip 16x9 en boy oranlı resimler
Başlık İsteğe bağlı: Sağlanmazsa resim sağlanmalıdır. Karttaki başlık
İşlem Metni İsteğe bağlı CTA'da gösterilen metin (ör. Oturum açın)
Alt başlık İsteğe bağlı Karttaki İ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 eylemler gerçekleşir:

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

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

updatePublishStatus

Dahili bir işletme nedeni nedeniyle kümelerden hiçbiri yayınlanmazsa updatePublishStatus API'yi kullanarak yayınlama durumunu güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü :

  • İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumun sağlanması, 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, uygulama sağlığı kontrol panellerinde uyarı tetiklemeyebilir. İçeriğin, sağlayıcı açısından beklenen bir durum nedeniyle yayınlanmadığını onaylar.
  • Geliştiricilerin, verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında bilgi vermesine yardımcı olur.
  • Google, kullanıcıyı uygulamada belirli işlemleri yapmaya teşvik etmek için durum kodlarını kullanabilir. Böylece kullanıcı, uygulama içeriğini görebilir veya sorunu çözebilir.

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ın yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamazsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini ç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());

deleteRecommendationsClusters

Bu API, öneri kümelerinin içeriğini silmek için kullanılır.

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

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ümesinin 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 hata kodu olarak 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, belirtilen cihazda kullanılabilir ancak çağrı 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ütülemedi. Bu durumda işlem yeniden denenebilir.
4 SERVICE_CALL_PERMISSION_DENIED Arayanı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 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 Content 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 intent'lerinin amacı, genellikle uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorunlu kılmaktır. Yayın intent'leri çok sık gönderilecek şekilde tasarlanmamıştır. Yalnızca Engage hizmeti, içeriğin eski (ör. bir haftalık) olabileceğini belirlediğinde tetiklenir. Bu sayede, uygulama uzun bir süre çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğinden daha emin olunur.

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 sayede, bellekte hâlâ etkin olan uygulamalardan iletişim sağlanabilir.

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

}

  • AndroidManifest.xml dosyanızda <receiver> etiketiyle bir uygulama statik olarak beyan edilmelidir. Bu, uygulamanın çalışmadığı zamanlarda yayın intent'lerini 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 intent'ler gönderilir:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu intent alındığında publishRecommendationClusters çağrısı başlatılması önerilir.
  • com.google.android.engage.action.PUBLISH_FEATURED Bu intent'i aldığınızda publishFeaturedCluster araması başlatmanız önerilir.
  • com.google.android.engage.action.PUBLISH_CONTINUATIONIt is recommended to start aBu intent'i aldığınızda publishContinuationCluster çağrısı yapın.

Entegrasyon iş akışı

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

SSS

Sık sorulan sorular için Engage SDK Sık Sorulan Sorular bölümüne bakın.

İletişim

Entegrasyon sürecinde herhangi bir sorunuz 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 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 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 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ü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.