Engage SDK Shopping: Üçü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 boyutuna 50 KB'tan daha az (sıkıştırılmış) ekler ve çoğu uygulamanın geliştirici süresi yaklaşık bir hafta sürer. Daha fazla bilgi için işletme sitemizi ziyaret edin.

Bu kılavuzda, geliştirici iş ortaklarının Engage içerik yüzeylerine alışveriş içeriği sunmayla ilgili talimatlar yer almaktadır.

Entegrasyon ayrıntıları

Terminoloji

Bu entegrasyon aşağıdaki beş küme türünü içerir: Öneri, Öne Çıkan, Alışveriş Sepeti, Alışveriş Listesi, Yeniden Sipariş ve Alışveriş Siparişi Takibi.

• Öneri kümeleri, tek bir geliştirici iş ortağından kişiselleştirilmiş alışveriş önerileri gösterir. Bu öneriler, kullanıcıya göre kişiselleştirilebilir veya genel (ör. trend olan öğeler) olabilir. Bunları kullanarak ürünleri, etkinlikleri, indirimleri, promosyonları ve abonelikleri dilediğiniz gibi öne çıkarabilirsiniz.

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

  • ShoppingEntity: Bir kümedeki tek bir öğeyi temsil eden nesne.

• Öne çıkanlar kümesi, birden fazla geliştirici iş ortağının seçilmiş öğelerini tek bir kullanıcı arayüzü grubunda gösterir. Tek bir Öne Çıkan küme bulunur. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneri kümelerinin üzerinde öncelikli bir yerleşimle gösterilir. Her geliştirici iş ortağı, Öne Çıkan kümede en fazla 10 öğe yayınlayabilir.

• Alışveriş sepeti kümesi, birçok geliştirici iş ortağının alışveriş sepetlerinden bir önizleme göstererek kullanıcıları bekleyen alışveriş sepetlerini tamamlamaya teşvik eder. 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österilen tek bir Alışveriş Sepeti kümesi vardır. Her geliştirici iş ortağının, alışveriş sepeti kümesinde en fazla 3 ShoppingCart örneği yayınlamasına izin verilir.

  Alışveriş sepetiniz aşağıdaki yapıya sahiptir:

  • Alışveriş Sepeti Kümesi: Birçok geliştirici iş ortağının alışveriş sepeti önizlemelerini içeren bir kullanıcı arayüzü görünümü.

  • ShoppingCart: Alışveriş sepeti kümesinde gösterilecek, tek bir geliştirici iş ortağının alışveriş sepeti önizlemesini temsil eden bir nesne. ShoppingCart, alışveriş sepetindeki toplam öğe sayısını göstermeli ve kullanıcının alışveriş sepetindeki bazı öğelerin resimlerini de içerebilir.

• Alışveriş Listesi kümesi, birden fazla geliştirici iş ortağının alışveriş listelerine dair bir önizleme gösterir. Bu sayede kullanıcılar, listelerini güncellemek ve tamamlamak için ilgili uygulamaya geri dönmeye teşvik edilir. Tek bir Alışveriş Listesi kümesi vardır.

• Yeniden sipariş kümesi, tek bir kullanıcı arayüzü gruplandırmasında birden fazla geliştirici iş ortağının önceki siparişlerine dair bir önizleme göstererek kullanıcıları yeniden sipariş vermeye teşvik eder. Tek bir Yeniden Sipariş Ver kümesi vardır.

  • Yeniden sipariş kümesi, kullanıcının önceki siparişindeki toplam öğe sayısını göstermeli ve aşağıdakilerden birini içermelidir:

    • Kullanıcının önceki siparişindeki X öğelerinin resimleri.
    • Kullanıcının önceki siparişindeki X öğesi için etiketler.

• Alışveriş Siparişi Takibi kümesi, birçok geliştirici iş ortağının bekleyen veya yakın zamanda tamamlanan alışveriş siparişlerinin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıların siparişlerini takip etmesine olanak tanır.

  Kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm Öneri kümelerinin üzerinde öncelikli bir yerleşimle tek bir AlışverişSiparişTakibi kümesi gösterilir. Her geliştirici iş ortağının, Alışveriş Siparişi Takibi kümesinde birden fazla ShoppingOrderTrackingEntity öğesi yayınlamasına izin verilir.

  • ShoppingOrderTrackingCluster'ınız aşağıdaki yapıya sahiptir:

    • ShoppingOrderTracking Kümesi: Birçok geliştirici iş ortağının sipariş takibi önizlemelerini içeren bir kullanıcı arayüzü görünümü
    • ShoppingOrderTrackingEntity: Tek bir geliştirici iş ortağı için alışveriş siparişi takibi önizlemesini temsil eden ve Alışveriş Siparişi Takibi kümesinde gösterilecek bir nesne. ShoppingOrderTrackingEntity, siparişin durumunu ve sipariş zamanını göstermelidir. ShoppingOrderTrackingEntity için beklenen teslimat süresini girmenizi önemle tavsiye ederiz. Bu süre, sağlandığında kullanıcılara gösterilir.

Ön çalışma

Minimum API düzeyi: 19

Uygulamanıza com.google.android.engage:engage-core kitaplığını ekleyin:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.5.2'
}

Daha fazla bilgi için Android 11'de paket görünürlüğü başlıklı makaleyi inceleyin.

Özet

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

Bir istemcinin 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. Alışveriş kategorisi için aşağıdaki varlıklar desteklenir:

1. ShoppingEntity
2. ShoppingCart
3. ShoppingList
4. Reorder
5. ShoppingOrderTracking

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

ShoppingEntity

ShoppingEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bir ürünü, tanıtımı, fırsatı, aboneliği veya etkinliği temsil eder.

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

Resim özellikleri

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

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.

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

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

Alışveriş kümelerini yayınlamaktan AppEngageShoppingClient sorumludur.

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

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCart
• publishShoppingCarts
• publishShoppingList
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteShoppingReorderCluster
• deleteShoppingOrderTrackingCluster
• 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.

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.

RecommendationCluster nesnesi aşağıdaki özelliklere sahip olabilir:

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Black Friday Deals")
                        .build())
                .build());

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

• Mevcut tüm Öneri Kümesi verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve yeni Öneri Kümeleri'nde depolanır.

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

publishFeaturedCluster

Bu API, FeaturedCluster nesnesini yayınlamak için kullanılır.

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut FeaturedCluster verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Öne Çıkan Küme'de saklanır.

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

publishShoppingCart

Bu API, ShoppingCartCluster nesnesini yayınlamak için kullanılır.

client.publishShoppingCart(
            PublishShoppingCartRequest.Builder()
                .setShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingCart(
            new PublishShoppingCartRequest.Builder()
                .setShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

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

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

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

publishShoppingCarts

Bu API, birden fazla ShoppingCart nesnesini yayınlamak için kullanılır. Bu, geliştirici iş ortağının her satıcı için ayrı alışveriş sepetleri yayınlaması durumunda geçerlidir. Bu API'yi kullanırken başlığa satıcı adını ekleyin.

client.publishShoppingCarts(
            PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    ShoppingCart.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingCarts(
            new PublishShoppingCartClustersRequest.Builder()
                .addShoppingCart(
                    new ShoppingCart.Builder()
                        ...
                        .build())
                .build())

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

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

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

publishShoppingList

Bu API, FoodShoppingList nesnesini yayınlamak için kullanılır.

client.publishFoodShoppingList(
            PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build())

client.publishFoodShoppingList(
            new PublishFoodShoppingListRequest.Builder()
                .setFoodShoppingList(
                    new FoodShoppingListEntity.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut FoodShoppingList verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Alışveriş Listesi kümesinde depolanır.

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

publishShoppingReorderCluster

Bu API, ShoppingReorderCluster nesnesini yayınlamak için kullanılır.

client.publishShoppingReorderCluster(
            PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingReorderCluster(
            new PublishShoppingReorderClusterRequest.Builder()
                .setReorderCluster(
                    new ShoppingReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut ShoppingReorderCluster verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Yeniden Sıralama Kümesi'nde depolanır.

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

publishShoppingOrderTrackingCluster

Bu API, ShoppingOrderTrackingCluster nesnesini yayınlamak için kullanılır.

client.publishShoppingOrderTrackingCluster(
            PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build())

client.publishShoppingOrderTrackingCluster(
            new PublishShoppingOrderTrackingClusterRequest.Builder()
                .setShoppingOrderTrackingCluster(
                    new ShoppingOrderTrackingCluster.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut ShoppingOrderTrackingCluster verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Alışveriş Siparişi İzleme Kümesi'nde 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ümelerin hiçbiri yayınlanmıyorsa updatePublishStatus API'yi 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 durumunu 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.
• Geliştiricilerin, verilerin ne zaman yayınlandığına dair bilgi vermesine yardımcı olur.
• Google, kullanıcıyı uygulamada belirli işlemleri yapmaya yönlendirmek için durum kodlarını kullanabilir. Böylece kullanıcılar uygulama içeriğini görebilir veya sorunları aşabilir.

Uygun yayınlama durumu kodlarının listesi :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

İçerik, oturum açmamış bir kullanıcı nedeniyle yayınlanmıyorsa Google, oturum açma kartının yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamıyorsa updatePublishStatus API'sinin NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla ç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 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.

deleteShoppingCartCluster

Bu API, alışveriş sepeti kümesinin içeriğini silmek için kullanılır.

client.deleteShoppingCartCluster()

client.deleteShoppingCartCluster();

Hizmet isteği aldığında mevcut verileri alışveriş sepeti kümesinden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingListCluster

Bu API, Alışveriş Listesi Kümesi'nin içeriğini silmek için kullanılır.

client.deleteShoppingListCluster()

client.deleteShoppingListCluster();

Hizmet isteği aldığında mevcut verileri Alışveriş Listesi Kümesi'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingReorderCluster

Bu API, Alışveriş'te yeniden sipariş kümesinin içeriğini silmek için kullanılır.

client.deleteShoppingReorderCluster()

client.deleteShoppingReorderCluster();

Hizmet isteği aldığında mevcut verileri Alışveriş'te yeniden sipariş verme kümesinden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingOrderTrackingCluster

Bu API, Shopping Sipariş İzleme Kümesi'nin içeriğini silmek için kullanılır.

client.deleteShoppingOrderTrackingCluster()

client.deleteShoppingOrderTrackingCluster();

Hizmet isteği aldığında mevcut verileri Alışveriş Sipariş Takibi Kümesi'nden 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_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      ...
      .build())

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(
        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şleme

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

Yayın niyetlerinin temel amacı, 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 (örneğin, 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şayabileceğine dair daha fazla güven duyulur.

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 iletişime izin verir.

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION
  // broadcast is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is
  // received
  // Trigger shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast
  // is received
  // Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
  // received
  // Trigger shopping order tracking cluster publish when
  // PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER 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 Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                           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 shopping cart cluster publish when PUBLISH_SHOPPING_CART broadcast is
// received

// Trigger shopping list cluster publish when PUBLISH_SHOPPING_LIST broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_REORDER_CLUSTER broadcast is
// received

// Trigger reorder cluster publish when PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER
// 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 Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_LIST),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Reorder Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_REORDER_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Shopping Order Tracking Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

}

• <receiver> etiketiyle bir uygulamayı AndroidManifest.xml dosyanızda statik olarak bildirin. 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.shopping.PUBLISH_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER" />
      </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 araması başlatılması önerilir.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Bu amaç alındığında publishShoppingCart araması başlatılması önerilir.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Bu amaç alındığında publishShoppingList araması başlatılması önerilir.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Bu amaç alındığında publishReorderCluster araması başlatılması önerilir.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Bu amaç alındığında publishShoppingOrderTrackingCluster araması başlatmanız önerilir.

Entegrasyon iş akışı

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

SSS

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

İletişim

Entegrasyon işlemi sırasında herhangi bir sorunuz olursa engage-developers@google.com ile iletişime geçin. Ekibimiz en kısa sürede yanıt verir.

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 şirket içinde inceleme gerçekleştirir. Değişiklik yapılması gerekiyorsa Google, gerekli ayrıntıları paylaşmak için sizinle iletişime geçer.
• Test tamamlandığında ve herhangi bir değişiklik yapılması gerekmediğinde Google, güncellenmiş ve entegre edilmiş APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
• Google, güncellenen APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri, Öne Çıkanlar, Alışveriş Sepeti, Alışveriş Listesi, Yeniden Sipariş Kümesi ve Alışveriş Siparişi Takibi Kümesi kümeleriniz yayınlanabilir ve kullanıcılar tarafından görülebilir.