Engage SDK Food: Üçüncü taraf teknik entegrasyon talimatları

Kullanıcılarınıza bulundukları yerde ulaşarak uygulama etkileşimini artırın. Engage SDK'yı entegre ederek kişiselleştirilmiş önerileri ve devam içeriklerini doğrudan Koleksiyonlar, Entertainment Space ve Google Play Store gibi cihaz üzerindeki birden fazla yüzeyde kullanıcılara sunun. Entegrasyon, ortalama APK'ya 50 KB'tan daha az (sıkıştırılmış) boyut ekler ve çoğu uygulama için yaklaşık bir haftalık geliştirici süresi alır. Daha fazla bilgi için işletme sitemizi ziyaret edin.

Bu kılavuzda, geliştirici iş ortaklarının Engage içerik yüzeylerine yemek içeriği (yemek siparişi, yemek veya restoran yorumları ve keşfi, yemek abonelikleri, tarifler) sunmasıyla ilgili talimatlar yer alır.

Kategori desteği ve yüzeyler

Engage SDK yüzey uygunluğu, uygulamanızın içerik kategorisine bağlıdır. Belirli platformlara uygunluk durumunuzu belirlemek için aşağıdaki tabloyu kullanın:

android skills add engage-sdk-integration

Entegrasyon ayrıntıları

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

Terminoloji

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

• Öneri kümeleri, tek bir geliştirici iş ortağının yemekle ilgili kişiselleştirilmiş önerilerini gösterir. Bu öneriler kullanıcıya göre kişiselleştirilebilir veya genelleştirilebilir (ör. yeni indirimli ürünler). Yemek tarifleri, mağazalar, yemekler veya market ürünleri gibi öğeleri öne çıkarmak için bunları kullanın.

  • Öneri kümesi ProductEntity, StoreEntity veya RecipeEntity girişlerinden oluşabilir ancak farklı öğe türlerinin karışımından oluşamaz.

  

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

  

• Yiyecek Alışveriş Sepeti kümesi, birden fazla geliştirici iş ortağının market alışverişi sepetlerinin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıları bekleyen sepetlerini tamamlamaya teşvik eder. Tek bir Gıda Alışveriş Sepeti kümesi var.

  • Yiyecek Alışveriş Sepeti Kümesi, sepetteki toplam öğe sayısını göstermelidir ve kullanıcının sepetindeki X öğenin resimlerini de içerebilir.

    

• Yiyecek Alışveriş Listesi kümesi, birden fazla geliştirici iş ortağının market alışverişi listelerinin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek kullanıcıları listelerini güncellemek ve tamamlamak için ilgili uygulamaya dönmeye yönlendirir. Tek bir Gıda Alışveriş Listesi kümesi vardır.

  

• Yeniden sipariş ver kümesi, birden fazla geliştirici iş ortağından verilen önceki siparişlerin önizlemesini tek bir kullanıcı arayüzü grubunda göstererek 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östermeli 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.

  

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

1. ProductEntity
2. StoreEntity
3. RecipeEntity
4. FoodShoppingCart
5. FoodShoppingList
6. FoodReorderCluster

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

ProductEntity

ProductEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bağımsız bir öğeyi (ör. market ürünü, restorandaki bir yemek veya promosyon) temsil eder.

StoreEntity

StoreEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği restoran veya market gibi bağımsız bir mağazayı temsil eder.

RecipeEntity

RecipeEntity nesnesi, geliştirici iş ortaklarının yayınlamak istediği bir tarif öğesini temsil eder.

FoodShoppingCart

FoodShoppingList

FoodReorderCluster

Resim özellikleri

Aşağıdaki tabloda, resim öğeleri için gerekli özellikler 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 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.

AppEngageFoodClient, gıda kümelerini yayınlamaktan sorumludur.

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

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishFoodShoppingCarts
• publishFoodShoppingLists
• publishReorderCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteFoodShoppingCartCluster
• deleteFoodShoppingListCluster
• deleteReorderCluster
• 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. Gıda Alışveriş Sepeti, Gıda Alışveriş Listesi ve Yeniden Sipariş Verme) 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.

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

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Big savings on Thanksgiving menu")
                        .build())
                .build());

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

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

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

publishFeaturedCluster

Bu API, bir 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 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.

publishFoodShoppingCarts

Bu API, FoodShoppingCart nesnelerinin listesini yayınlamak için kullanılır.

client.publishFoodShoppingCarts(
            PublishFoodShoppingCartsRequest.Builder()
                .addFoodShoppingCart(
                    FoodShoppingCart.Builder()
                        ...
                        .build())
                .build())

client.publishFoodShoppingCarts(
            new PublishFoodShoppingCartsRequest.Builder()
                .addFoodShoppingCart(
                    new FoodShoppingCart.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut FoodShoppingCart verileri kaldırılır.
• İstekten alınan veriler ayrıştırılır ve güncellenen Alışveriş Sepeti Kümesi'nde depolanır.

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

publishFoodShoppingLists

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

client.publishFoodShoppingLists(
            PublishFoodShoppingListsRequest.Builder()
                .addFoodShoppingList(
                    FoodShoppingList.Builder()
                        ...
                        .build())
                .build())

client.publishFoodShoppingLists(
            new PublishFoodShoppingListsRequest.Builder()
                .addFoodShoppingList(
                    new FoodShoppingList.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut FoodShoppingList verileri kaldırılır.
• İstekteki veriler ayrıştırılır ve güncellenen Alışveriş Listesi Kümesi'nde depolanır.

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

publishReorderCluster

Bu API, bir FoodReorderCluster nesnesi yayınlamak için kullanılır.

client.publishReorderCluster(
            PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    FoodReorderCluster.Builder()
                        ...
                        .build())
                .build())

client.publishReorderCluster(
            new PublishReorderClusterRequest.Builder()
                .setReorderCluster(
                    new FoodReorderCluster.Builder()
                        ...
                        .build())
                .build());

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

• Geliştirici iş ortağından alınan mevcut FoodReorderCluster verileri kaldırılır.
• İstekteki veriler ayrıştırılır ve güncellenen yeniden sıralama 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ümelerden hiçbiri yayınlanmazsa updatePublishStatus API'yi kullanarak yayınlama durumunu güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü :

• İçerik yayınlandığında bile (STATUS == PUBLISHED) tüm senaryolarda durumun sağlanması, entegrasyonunuzun durumunu ve diğer metriklerini iletmek için bu açık durumu kullanan kontrol panellerini doldurmak açısından çok önemlidir.
• Hiçbir içerik yayınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemeyebilir. İçeriğin, sağlayıcı açısından beklenen bir durum nedeniyle yayınlanmadığını onaylar.
• Geliştiricilerin, verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında bilgi vermesine yardımcı olur.
• Google, kullanıcıyı uygulamada belirli işlemleri yapmaya teşvik etmek için durum kodlarını kullanabilir. Böylece kullanıcı, uygulama içeriğini görebilir veya sorunu çözebilir.

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

İçerik, kullanıcının giriş yapmaması nedeniyle yayınlanmıyorsa Google, oturum açma kartının yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamazsa NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla updatePublishStatus API'sini çağırmalarını öneririz.

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.

deleteFoodShoppingCartCluster

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

client.deleteFoodShoppingCartCluster()

client.deleteFoodShoppingCartCluster();

Hizmet, isteği aldığında mevcut verileri Food Shopping Cart Cluster'dan kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteFoodShoppingListCluster

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

client.deleteFoodShoppingListCluster()

client.deleteFoodShoppingListCluster();

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

deleteReorderCluster

Bu API, FoodReorderCluster'ın içeriğini silmek için kullanılır.

client.deleteReorderCluster()

client.deleteReorderCluster();

Hizmet, isteği aldığında mevcut verileri Yeniden Sıralama 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(
              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 food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast
  // is received
  // Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast
  // is received
  // Trigger reorder cluster publish when PUBLISH_REORDER_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 food Shopping Cart Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_SHOPPING_CART),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register food Shopping List Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FOOD_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)
}

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 food shopping cart cluster publish when PUBLISH_FOOD_SHOPPING_CART broadcast is
// received

// Trigger food shopping list cluster publish when PUBLISH_FOOD_SHOPPING_LIST broadcast is
// received

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

// Register food Shopping List Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.shopping.service.Intents.ACTION_PUBLISH_FOOD_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);

}

• 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.food.PUBLISH_FOOD_SHOPPING_CART" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER" />
      </intent-filter>
   </receiver>
</application>

Hizmet tarafından aşağıdaki intent'ler gönderilir:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu intent alındığında publishRecommendationClusters çağrısı başlatılması önerilir.
• com.google.android.engage.action.PUBLISH_FEATURED Bu intent'i aldığınızda publishFeaturedCluster araması başlatmanız önerilir.
• com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_CART Bu intent alındığında publishFoodShoppingCarts araması başlatılması önerilir.
• com.google.android.engage.action.food.PUBLISH_FOOD_SHOPPING_LIST Bu intent alındığında publishFoodShoppingLists araması başlatılması önerilir.
• com.google.android.engage.action.food.PUBLISH_REORDER_CLUSTER Bu intent'i aldığınızda publishReorderCluster 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. Ekibimiz en kısa sürede yanıt verecektir.

Sonraki adımlar

Bu entegrasyonu tamamladıktan sonraki adımlarınız şunlardır:

• engage-developers@google.com adresine bir e-posta gönderin ve Google tarafından test edilmeye hazır olan entegre APK'nızı ekleyin.
• Google, entegrasyonun beklendiği gibi çalıştığından emin olmak için dahili olarak doğrulama ve inceleme yapar. Değişiklik yapılması gerekiyorsa Google, gerekli ayrıntıları paylaşmak için sizinle iletişime geçer.
• Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre edilmiş APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
• Google, güncellenmiş APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri, Öne Çıkanlar, Alışveriş Sepeti, Alışveriş Listesi ve Yeniden Sipariş kümeleriniz yayınlanır ve kullanıcılara gösterilir.