Engage SDK Health and Fitness: Üçü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 rehberde, geliştirici iş ortaklarının sağlık ve fitness içeriklerini Engage içerik yüzeylerinde yayınlamasıyla 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:

android skills add engage-sdk-integration

Entegrasyon ayrıntıları

Terminoloji

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

• Öneri kümelerinde, tek bir geliştirici iş ortağından kişiselleştirilmiş sağlık ve fitness önerileri gösterilir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (ör. trend olan fitness ve sağlık). Sağlık ve fitness ile ilgili makaleleri veya kişileri göstermek için bunları kullanın.

  • Öneri kümesi ArticleEntity, PersonEntity veya EventEntity öğelerinden oluşabilir ancak farklı öğe türlerinin karışımından oluşamaz.

  Önerileriniz aşağıdaki yapıya sahiptir:

  • Öneri Kümesi: Aynı geliştirici iş ortağının önerilerinden oluşan bir grubu içeren kullanıcı arayüzü görünümü.

  • Varlık: Bir kümedeki tek bir öğeyi temsil eden nesne. Bu entegrasyon, Öneri Kümesi kullanılarak gösterilecek bazı öğeler sunar:

    • ArticleEntity: ArticleEntity, sağlık ve fitness ile ilgili metin tabanlı içerik önerisini temsil eder. Makaleler, blog yayınları, pazarlama içerikleri, haber snippet'leri vb. için kullanılabilir.

      

    • PersonEntity: PersonEntity, bir kişiyi temsil eder. Öneriler, bir antrenörü veya sağlık ve fitness ile ilgili herhangi bir kişiyi öne çıkarmak için olabilir.

      

    • EventEntity: EventEntity, gelecekte gerçekleşecek bir etkinliği temsil eder. Etkinliğin başlangıç saati, kullanıcılara iletilmesi gereken önemli bir bilgidir. Bu öğe, sağlık ve fitness ile ilgili kan bağışı kampı, eğitim oturumları, spor salonu veya yoga dersleri gibi etkinlikleri göstermek için kullanılabilir.

      

• Devam kümesinde, tek bir kullanıcı arayüzü gruplandırmasında birden fazla geliştirici iş ortağının kullanıcılarının son zamanlarda etkileşimde bulunduğu içerikler gösterilir. Her geliştirici iş ortağı, Devamlılık kümesinde en fazla 10 öğe yayınlayabilir.

  Devam niteliğindeki içeriğiniz aşağıdaki yapıda olabilir:

  • ArticleEntity: ArticleEntity, sağlık ve fitness ile ilgili metin tabanlı içerik önerisini temsil eder. Bu öğe, kullanıcının kaldığı yerden devam etmek istediği bitmemiş haber makalelerini veya diğer içerikleri temsil etmek için kullanılabilir. Ör.: Haber snippet'i, sağlık veya fitness ile ilgili konular hakkında blog yayını snippet'i.

    

  • EventReservationEntity: EventReservationEntity, bir etkinliğin rezervasyonunu temsil eder ve kullanıcıların yaklaşan veya devam eden fitness ve sağlık etkinlikleri rezervasyonlarını takip etmesine yardımcı olur. Ör. Eğitim oturumları

    

• Ö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.

  • GenericFeaturedEntity: GenericFeaturedEntity, Recommendation item'dan farklıdır. Featured item, geliştiricilerin tek bir en çok görüntülenen içeriği için kullanılmalı ve kullanıcıların ilgisini çekecek ve alakalı olacak en önemli tek içeriği temsil etmelidir.

    

Ö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:

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. Sağlık ve Fitness kategorisi için aşağıdaki öğeler desteklenir:

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

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

GenericFeaturedEntity

ArticleEntity

PersonEntity

EventEntity

EventReservationEntity

Resim özellikleri

Resim öğeleri için gerekli özellikler bu tabloda listelenmiştir:

Google'ın erişebilmesi için resimlerin herkese açık CDN'lerde barındırılması gerekir.

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.
• Resmin koyu ve açık tema ayarlarında düzgün şekilde gösterilebilmesi için şeffaf bir arka plan kullanın.

İçerik Kategorisi

İçerik kategorisi, uygulamaların birden fazla kategoriye ait içerik yayınlamasına olanak tanır. Bu işlem, içeriği önceden tanımlanmış bazı kategorilerle eşler. Bu kategoriler şunlardır:

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

Google'ın erişebilmesi için resimlerin herkese açık CDN'lerde barındırılması gerekir.

İçerik kategorilerini kullanma yönergeleri

1. ArticleEntity ve GenericFeaturedEntity gibi bazı öğeler, içerik kategorilerinin herhangi birini kullanabilir. EventEntity, EventReservationEntity, PersonEntity gibi diğer öğeler için bu kategorilerin yalnızca bir alt kümesi uygundur. Listeyi doldurmadan önce bir öğe türü için uygun olan kategorilerin listesini kontrol edin.

2. Bazı içerik kategorileri için genel öğeler ve ContentCategory kombinasyonu yerine belirli öğe türünü kullanın:

   • TYPE_MOVIES_AND_TV_SHOWS: Genel öğeleri kullanmadan önce İzleme entegrasyonu kılavuzundaki öğeleri inceleyin.
   • TYPE_BOOKS: Genel öğeleri kullanmadan önce EbookEntity'yi inceleyin.
   • TYPE_AUDIOBOOKS - Genel öğeleri kullanmadan önce AudiobookEntity öğesini inceleyin.
   • TYPE_SHOPPING - Check out ShoppingEntity before using the generic entities.
   • TYPE_FOOD_AND_DRINK: Genel öğeleri kullanmadan önce Yemek entegrasyonu kılavuzundaki öğeleri inceleyin.

3. ContentCategory alanı isteğe bağlıdır ve içerik, daha önce bahsedilen kategorilerden herhangi birine ait değilse boş bırakılmalıdır.

4. Birden fazla içerik kategorisi sağlanması durumunda, bunları içerikle alaka düzeyine göre sıralayın. En alakalı içerik kategorisi listenin başında yer almalıdır.

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

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

AppEngagePublishClient, kümelerin yayınlanmasından sorumludur.

İstemcide kümeleri yayınlamak için aşağıdaki API'ler kullanılır:

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

Engage SDK v1.6.0 ve sonraki sürümler için (önerilir)

android skills add engage-sdk-integration

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

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.

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

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 ve Etkinlik Rezervasyonları) 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ı)

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

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.

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .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.

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(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 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.

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(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:

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

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ümelerden hiçbiri yayınlanmazsa updatePublishStatus API'sini kullanarak yayın durumunu güncellemenizi önemle tavsiye ederiz. Bu önemlidir, çünkü :

• İçerik yayınlanmış olsa bile (STATUS == PUBLISHED) tüm senaryolarda durumu sağlamak, entegrasyonunuzun 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ı, uygulama içeriğini görebilir veya sorunu çözebilir.

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 durum kodu NOT_PUBLISHED_REQUIRES_SIGN_IN ile updatePublishStatus API'sinin çağrılması önerilir.

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

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.

client.deleteRecommendationClusters()

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.

client.deleteFeaturedCluster()

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.

client.deleteContinuationCluster()

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.

client.deleteUserManagementCluster()

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.

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_CONTINUATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .build())

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .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(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

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.

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.

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

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 araması başlatılması önerilir.
• com.google.android.engage.action.PUBLISH_FEATURED Bu amaç alındığında publishFeaturedCluster görüşmesi başlatmanız önerilir.
• com.google.android.engage.action.PUBLISH_CONTINUATION Bu amaç alındığında publishContinuationCluster görüşmesi başlatmanız önerilir.

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.

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 doğrulama yapar ve dahili olarak inceler. 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ınlanabilir ve kullanıcılara gösterilebilir.