Engage SDK Arkadaşlık: Üçüncü taraf teknik entegrasyon talimatları

Google, kullanıcıların uygulamalarını sektörlere göre düzenleyen ve kişiselleştirilmiş uygulama içeriği tüketimi ve keşfi için yeni bir etkileyici deneyim sunan cihaz üzerinde bir yüzey geliştiriyor. Bu tam ekran deneyimi, geliştirici iş ortaklarına en iyi zengin içeriklerini uygulamalarının dışında özel bir kanalda sergileme fırsatı sunar.Bu kılavuzda, geliştirici iş ortaklarının flört içeriklerini entegre etmek için Engage SDK'yı kullanarak bu yeni yüzey alanını doldurma talimatları yer almaktadır.

Entegrasyon ayrıntıları

Bu bölümde, flört içeriği 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, Öne Çıkanlar ve Devam.

• Öneri kümeleri, bireysel geliştirici iş ortaklarından gelen kişiselleştirilmiş flört önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir.

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

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

  • Öneri kümesi: Aynı geliştirici iş ortağından gelen bir grup öneriyi 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ı varlıklar sunar:

    • ArticleEntity: ArticleEntity, flörtle ilgili metin tabanlı içerik önerilerini temsil eder. ArticleEntity öğesi, geliştiricilerin kullanıcılara bilgileri açıklamak için daha fazla meta veri içeren çeşitli metin ve resim içerikleri sunmasına olanak tanır.

      

    • PersonEntity: PersonEntity bir kişiyi temsil eder. Öneriler, flört adayları arasında bir kişiyi öne çıkarmak için olabilir.

      

    • EventEntity: EventEntity, gelecekte gerçekleşecek bir etkinliği temsil eder. Etkinliğin başlangıç zamanı, kullanıcılara iletilmesi gereken kritik bir bilgidir.

      

• Devam kümesi, kullanıcıların birden fazla geliştirici iş ortağından yakın zamanda etkileşimde bulunduğu içerikleri 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.

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

  • ArticleEntity: ArticleEntity, flörtle ilgili metin tabanlı içerik önerilerini temsil eder. Bu varlık, tamamlanmamış haber makalelerini veya kullanıcının kaldığı yerden devam etmek istediği diğer içerikleri temsil etmek için kullanılabilir.

    

  • EventReservationEntity: EventReservationEntity, bir etkinlik için yapılan rezervasyonu temsil eder ve kullanıcıların yaklaşan veya devam eden flört ve buluşma etkinliği rezervasyonlarını takip etmesine yardımcı olur.

    

• Öne Çıkanlar kümesi, birçok geliştirici iş ortağının seçilen kahramanını tek bir kullanıcı arayüzü grubunda sergileyen bir kullanıcı arayüzü görünümüdür.GenericFeaturedEntity Kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm öneri kümelerinin üzerinde öncelikli bir yerleşime sahip tek bir öne çıkan küme bulunur. Her geliştirici iş ortağının, Öne Çıkanlar bölümünde desteklenen türde tek bir öğe yayınlamasına izin verilir. Öne Çıkanlar kümesinde birden fazla uygulama geliştiricinin birçok öğesi (potansiyel olarak farklı türlerde) yer alır.

  • GenericFeaturedEntity: GenericFeaturedEntity, Öne Çıkan öğenin geliştiricilerin tek bir en iyi içeriği için kullanılması ve kullanıcıların ilgisini çekip onlarla alakalı olacak en önemli tek içeriği temsil etmesi gerektiği için Öneri öğesinden farklıdı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:

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. Flört kategorisi için aşağıdaki varlıkları destekliyoruz:

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

Aşağıdaki grafiklerde, her tür için kullanılabilir özellikler ve şartlar ö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

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.
• 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çeriği önceden tanımlanmış kategorilerden bazılarıyla eşler:

• 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ı varlıklar, içerik kategorilerinden herhangi birini kullanabilir. EventEntity, EventReservationEntity, PersonEntity gibi diğer varlıklar için bu kategorilerin yalnızca bir alt kümesi uygundur. Listeyi doldurmadan önce bir varlık türü için uygun olan kategorilerin listesini kontrol edin.

2. Bazı içerik kategorileri için Genel varlıklar ve ContentCategory kombinasyonu yerine belirli varlık türünü kullanın:

   • TYPE_MOVIES_AND_TV_SHOWS - Genel varlıkları kullanmadan önce İzleme entegrasyonu kılavuzundaki varlıklara göz atın.
   • TYPE_BOOKS: Genel varlıkları kullanmadan önce EbookEntity'ye göz atın.
   • TYPE_AUDIOBOOKS: Genel varlıkları kullanmadan önce AudiobookEntity'ye göz atın.
   • TYPE_SHOPPING: Genel varlıkları kullanmadan önce ShoppingEntity'ye göz atın.
   • TYPE_FOOD_AND_DRINK: Genel varlıkları kullanmadan önce Yemek Entegrasyonu kılavuzundaki varlıklara göz atın.

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

4. Birden fazla içerik kategorisi sağlanıyorsa bunları içerikle alaka düzeyine göre sıralayın ve en alakalı içerik kategorisini listenin başına yerleştirin.

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 ya da bir etkinliğe göre (ör. kullanıcı uygulamayı her açtığında veya sepetine bir şey eklediğinde) planlanması önerilir.

AppEngagePublishClient, kümeleri yayınlamaktan 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 entegrasyon için kullanılabilir olup olmadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.

Engage SDK 1.6.0 ve sonraki sürümler için (Önerilen)

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

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

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

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

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

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

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 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ümelerin hiçbiri yayınlanmazsa yayınlama durumunu updatePublishStatus API'yi kullanarak 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ı uygulama içeriğini görebilmesi veya sorunu çözebilmesi için uygulamada belirli işlemleri yapmaya teşvik etmek amacıyla durum kodlarını kullanabilir.

Uygun yayınlama durumu kodlarının listesi şunlardır :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

İçerik, kullanıcının giriş yapmaması nedeniyle yayınlanmıyorsa Google, oturum açma kartını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.

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

deleteRecommendationsClusters

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

client.deleteRecommendationsClusters()

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.

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 kümesinin 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. İ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(
        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 hata kodu olarak içeren bir AppEngageException olarak döndürülür.

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.

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

}

• 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 araması 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_CONTINUATION Bu intent'i aldığınızda publishContinuationCluster araması başlatmanız önerilir.

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.

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 gerekmesi durumunda 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 Çıkanlar ve Devam kümeleriniz yayınlanabilir ve kullanıcılara gösterilebilir.