Engage SDK Shopping: Üçü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ğinin tüketilmesi ve keşfedilmesi için yeni bir etkileyici deneyim sunan cihaz üzerinde bir yüzey oluşturuyor. 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 hem bu yeni yüzey alanını hem de Eğlence Alanı gibi mevcut Google yüzeylerini doldurmak için Engage SDK'sını kullanarak alışveriş içeriklerini entegre etme talimatları yer almaktadır.

Entegrasyon ayrıntıları

Terminoloji

Bu entegrasyon şu beş küme türünü içerir: Öneri, Öne Çıkan, Alışveriş Sepeti, Alışveriş Listesi, Yeniden Sıralama ve Alışveriş Siparişi İzleme.

• Öneri kümeleri, tek bir geliştirici iş ortağının kişiselleştirilmiş alışveriş önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (ör. trend olan öğeler). Ürünleri, etkinlikleri, indirimleri, promosyonları ve abonelikleri uygun gördüğünüz şekilde göstermek için bunları kullanın.

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

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

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

• Öne Çıkan kümesi, birden fazla geliştirici iş ortağından alınmış çeşitli varlıkları tek bir kullanıcı arayüzü gruplandırmasında 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 Öneriler kümelerinin üzerinde öncelikli olarak yerleştirilir. Her geliştirici iş ortağının, Öne Çıkanlar kümesinde en fazla 10 öğe yayınlamasına izin verilir.

• Alışveriş Sepeti kümesi, tek bir kullanıcı arayüzü grubunda birçok geliştirici iş ortağından gelen alışveriş sepetlerine kısa bir bakış sunarak kullanıcıları bekleyen sepetlerini tamamlamaya yönlendirir. Tek bir Alışveriş Sepeti kümesi vardır. Bu küme, kullanıcı arayüzünün üst kısmına yakın bir yerde gösterilir ve tüm öneri kümelerinin üzerinde öncelikli bir yerleşime sahiptir. 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: Tek bir geliştirici iş ortağı için alışveriş sepeti önizlemesini temsil eden ve Alışveriş sepeti kümesinde gösterilecek bir nesne. ShoppingCart, alışveriş sepetindeki toplam öğe sayısını göstermelidir. Ayrıca kullanıcının alışveriş sepetindeki bazı ürünlerin resimlerini de içerebilir.

• Alışveriş Listesi kümesi, birden fazla geliştirici iş ortağının alışveriş listelerinin bir kullanıcı arayüzü gruplandırmasında önizlemesini gösterir. Bu sayede kullanıcılar listelerini güncellemek ve tamamlamak için ilgili uygulamaya geri dönebilir. Tek bir Alışveriş Listesi kümesi vardır.

• Yeniden sipariş ver kümesi, birden fazla geliştirici iş ortağının önceki siparişlerini tek bir kullanıcı arayüzü gruplandırmasında gösterir ve kullanıcıları yeniden sipariş vermeye teşvik eder. Tek bir yeniden sıralama kümesi vardır.

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

    • Kullanıcının önceki siparişindeki X öğenin resimleri.
    • Kullanıcının önceki siparişindeki X öğe 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şlerini tek bir kullanıcı arayüzü gruplandırmasında gösterir. Bu sayede kullanıcılar siparişlerini takip edebilir.

  Kullanıcı arayüzünün üst kısmına yakın bir yerde, tüm öneri kümelerinin üzerinde öncelikli yerleşim alan tek bir ShoppingOrderTracking kümesi vardır. Her geliştirici iş ortağının Alışveriş Sipariş İzleme kümesinde birden fazla Shopping OrderTrackingEntity öğesi yayınlamasına izin verilir.

  • ShoppingOrderTrackingCluster aşağıdaki yapıya sahiptir:

    • Shopping OrderTracking Cluster: Birçok geliştirici iş ortağının sipariş takibi önizlemelerini içeren bir kullanıcı arayüzü görünümü
    • ShoppingOrderTrackingEntity: Alışveriş siparişi izleme kümesinde gösterilecek, tek bir geliştirici iş ortağı için alışveriş siparişi izleme önizlemesini temsil eden bir nesne. ShoppingOrderTrackingEntity, siparişin durumunu ve sipariş zamanını göstermelidir. Shopping OrderTrackingEntity için beklenen teslimat süresi, sağlandığında kullanıcılara gösterildiği için bu süreyi doldurmanızı önemle tavsiye ederiz.

Ö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.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ı hizmet uygulaması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: Öğe 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ılabilen özellikler ve şartlar özetlenmiştir.

ShoppingEntity

ShoppingEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bir ürünü, promosyonu, anlaşmayı, aboneliği veya etkinliği temsil eder.

ShoppingEntity

ShoppingCart

ShoppingList

ShoppingReorderCluster

ShoppingOrderTrackingCluster

Resim özellikleri

Resim öğeleri için gerekli ö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 ortaya, resmin% 80'lik kısmına yerleştirin.
• Resmin koyu ve açık tema ayarlarında düzgün şekilde gösterilmesi için şeffaf bir arka plan kullanın.

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

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

AppEngageShoppingClient, alışveriş kümelerini yayınlamaktan sorumludur.

Aşağıdaki API'ler, istemcideki kümeleri yayınlamada kullanılabilir:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishShoppingCart
• publishShoppingCarts
• publishShoppingList
• publishShoppingReorderCluster
• publishShoppingOrderTrackingCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteShoppingCartCluster
• deleteShoppingListCluster
• deleteShoppingReorderCluster
• deleteShoppingOrderTrackingCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

Bu API, hizmetin entegrasyon için uygun olup olmadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek amacıyla 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 nesneleri 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, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:

• Mevcut tüm öneri kümesi verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve yeni öneri kümelerinde depolanır.

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

publishFeaturedCluster

Bu API, FeaturedCluster nesnesi 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ğının 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.

Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingCart

Bu API, ShoppingCartCluster nesnesi 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ğının mevcut ShoppingCart verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Alışveriş Sepeti Kümesi'nde depolanır.

Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingCarts

Bu API, birden fazla ShoppingCart nesnesi yayınlamak için kullanılır. Bu, satıcı başına ayrı alışveriş sepetleri yayınlayan geliştirici iş ortakları için 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ğının mevcut ShoppingCart verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Alışveriş Sepeti Kümesi'nde depolanır.

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

publishShoppingList

Bu API, FoodShoppingList nesnesi 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ğının mevcut FoodShoppingList verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen Alışveriş Listesi Kümesi'nde depolanır.

Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.

publishShoppingReorderCluster

Bu API, ShoppingReorderCluster nesnesi 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ğının mevcut ShoppingReorderCluster verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen yeniden sıralama kümesinde depolanır.

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

publishShoppingOrderTrackingCluster

Bu API, ShoppingOrderTrackingCluster nesnesi 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ğının mevcut ShoppingOrderTrackingCluster verileri kaldırılır.
• İstekten elde edilen veriler ayrıştırılır ve güncellenmiş Alışveriş Sipariş İzleme Kümesinde depolanır.

Hata olması 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, uygulamanın içerik yayınlayabilmesi (veya daha kişiselleştirilmiş içerik sunabilmesi) için kullanıcıları uygulamanın oturum açma sayfasına yönlendirir.

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, bir işlem içinde aşağıdaki işlemler gerçekleştirilir:

• Geliştirici iş ortağının mevcut UserAccountManagementCluster verileri kaldırılır.
• İstekten elde edilen veriler ayrıştırılır ve güncellenmiş UserAccountManagementCluster Kümesinde depolanır.

Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.

updatePublishStatus

Dahili bir işletme nedeniyle kümelerin hiçbiri yayınlanmıyorsa updatePublishStatus API'sini kullanarak yayınlama durumunu güncellemenizi önemle tavsiye ederiz. Bu önemlidir, çünkü :

• İçerik yayınlandığında bile tüm senaryolarda durumu belirtmek (STATUS == YAYINLANDI) entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu uygunsuz durumu kullanan kontrol panellerini doldurmak açısından çok önemlidir.
• Hiçbir içerik yayınlanmamışsa ancak entegrasyon durumu bozulmamışsa (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemekten kaçınabilir. Sağlayıcı açısından beklenen bir durum nedeniyle içeriğin yayınlanmadığını onaylar.
• Geliştiricilerin verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında analizler sunmasına yardımcı olur.
• Google, uygulama içeriğini görebilmeleri veya üstesinden gelebilmesi amacıyla, durum kodlarını kullanıcıyı uygulamada belirli işlemleri yapmaya yönlendirmek için 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, bir kullanıcı giriş yapmadığı için yayınlanmazsa Google, Oturum Açma kartını yayınlamanızı önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamıyorsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini çağırmanızı ö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());

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Hizmet, isteği aldığında mevcut verileri öneri kümelerinden kaldırır. Bir hata olması 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 Öne Çıkan Küme'deki mevcut verileri kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingCartCluster

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

client.deleteShoppingCartCluster()

client.deleteShoppingCartCluster();

Hizmet, isteği aldığında mevcut verileri Alışveriş Sepeti Kümesi'nden kaldırır. Hata olması 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 olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingReorderCluster

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

client.deleteShoppingReorderCluster()

client.deleteShoppingReorderCluster();

Hizmet, isteği aldığında mevcut verileri Alışveriş Tekrar Sipariş Kümesi'nden kaldırır. Bir hata olması durumunda, isteğin tamamı reddedilir ve mevcut durum korunur.

deleteShoppingOrderTrackingCluster

Bu API, Alışveriş 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şi İzleme Kümesi'nden kaldırır. Bir hata olması 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ğinin 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 belirtilen küme türleriyle eşleşen tüm kümelerdeki mevcut verileri kaldırır. İstemciler bir veya daha fazla küme türünü iletmeyi seçebilir. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

Hata işleme

Yayınlama API'lerinden görev sonucunu dinlemeniz önemle tavsiye edilir. Böylece, başarılı bir görevi kurtarıp yeniden göndermek için takip işlemi yapabilirsiniz.

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, hata kodu olarak nedeni dahil edilerek AppEngageException olarak döndürülür.

3. Adım: Yayın intent'lerini işleme

İçerik yayınlama isteğini almak için bir iş üzerinden Content API çağrıları yapmanın yanı sıra bir BroadcastReceiver oluşturmak da gerekir.

Amaca dayalı yayınların amacı, temel olarak uygulamanın yeniden etkinleştirilmesini sağlamak ve veri senkronizasyonunu zorunlu kılmaktır. Yayın niyeti, çok sık gönderilecek şekilde tasarlanmamıştır. Bu işlem yalnızca Etkileşim Hizmeti tarafından içeriğin eski olabileceğini (örneğin, bir hafta önce) belirlediğinde tetiklenir. Bu sayede, uygulama uzun süre çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğinden emin olabilirsiniz.

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

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

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_CART))

// Register Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_LIST))

// Register Reorder Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_REORDER_CLUSTER))

// Register Shopping Order Tracking Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER))
}

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

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Shopping Cart Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_SHOPPING_CART));

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

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

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

}

• AndroidManifest.xml dosyanızda <receiver> etiketiyle uygulamayı statik olarak beyan edin. Bu, uygulamanın çalışmadığında yayın intent'leri almasına ve içeriği yayınlamasına olanak tanır.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      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 intent'ler gönderilir:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu niyet karşılandığında bir publishRecommendationClusters araması başlatmanız önerilir.
• com.google.android.engage.action.PUBLISH_FEATURED Bu intent alındığında bir publishFeaturedCluster çağrısı başlatmanız önerilir.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_CART Bu intent alındığında bir publishShoppingCart çağrısı başlatmanız önerilir.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_LIST Bu intent alındığında bir publishShoppingList çağrısı başlatmanız önerilir.
• com.google.android.engage.action.shopping.PUBLISH_REORDER_CLUSTER Bu intent alındığında bir publishReorderCluster çağrısı başlatmanız önerilir.
• com.google.android.engage.action.shopping.PUBLISH_SHOPPING_ORDER_TRACKING_CLUSTER Bu niyet alındığında publishShoppingOrderTrackingCluster çağrısı başlatmanız önerilir.

Entegrasyon iş akışı

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

SSS

SSS'ler için Etkileşim SDK'sıyla İlgili Sık Sorulan Sorular bölümüne bakın.

İletişim

Entegrasyon işlemi sırasında sorularınız olursa engage-developers@google.com adresinden bizimle iletişime geçebilirsiniz. Ekibimiz en kısa sürede yanıt verir.

Sonraki adımlar

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