Engage SDK Social: Üçü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 doküman, geliştirici iş ortaklarının bu yeni yüzey alanını doldurmak için Engage SDK'sını kullanarak sosyal içeriklerini entegre etmelerine yönelik talimatlar içerir.

Entegrasyon ayrıntısı

Aşağıdaki bölümde entegrasyon ayrıntıları açıklanmaktadır.

Terminoloji

Öneri kümeleri, bağımsız bir geliştirici iş ortağından kişiselleştirilmiş öneriler gösterir.

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

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

Her öneri kümesi aşağıdaki iki öğe türünden birinden oluşur:

• PortraitMediaEntity
• SocialPostEntity

PortraitMediaEntity, yayın için 1 dikey resim içermelidir. Profil ve etkileşimle ilgili meta veriler isteğe bağlıdır.

• Gönderi

  • Dikey modda resim ve zaman damgası veya
  • Dikey modda resim + metin içeriği ve zaman damgası

• Profil

  • Avatar, ad veya herkese açık kullanıcı adı, ek resim

• Etkileşimler

  • Yalnızca sayma ve etiketleme veya
  • Sayı ve görsel (simge)

SocialPostEntity, profil, yayın ve etkileşimle ilgili meta verileri içerir.

• Profil

  • Avatar, ad veya herkese açık kullanıcı adı, ek metin, ek resim

• Gönderi

  • Metin ve zaman damgası veya
  • Rich media (resim veya zengin URL) ve zaman damgası veya
  • Metin ve zengin medya (resim veya zengin URL) ve zaman damgası veya
  • Video önizlemesi (küçük resim ve süre) ve zaman damgası

• Etkileşimler

  • Yalnızca sayma ve etiketleme veya
  • Sayı ve görsel (simge)

Ö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'
}

Özet

Tasarım, bağlı hizmet uygulamasına dayanır.

İstemcilerin yayınlayabileceği veriler, farklı küme türleri için aşağıdaki sınırlara tabidir:

Küme türü	Küme sınırları	Bir kümedeki minimum varlık sınırları	Bir kümedeki maksimum öğe sınırları
Öneri Kümeleri	En fazla 5	En az 5 (PortraitMediaEntity veya SocialPostEntity)	En fazla 25 (PortraitMediaEntity veya SocialPostEntity)

1. adım: Öğe verilerini sağlayın

SDK, her öğe türünü temsil etmek için farklı öğeler tanımlamıştır. SDK, Sosyal kategorisi için aşağıdaki öğeleri destekler:

1. PortraitMediaEntity
2. SocialPostEntity

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

PortraitMediaEntity

Özellik	Şartlar	Açıklama	Biçim
İşlem URI'si	Zorunlu	Sağlayıcı uygulamasındaki öğeye derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın	URI
Gönderiyle ilgili meta veriler (Zorunlu)
Resimler	Zorunlu	Resimler dikey en boy oranında olmalıdır. Birden fazla resim sağlandığında kullanıcı arayüzünde yalnızca 1 resim gösterilebilir. Bununla birlikte, kullanıcı arayüzü, uygulamada daha fazla görüntü olduğuna dair görsel bir işaret sağlayabilir. Yayın bir videoysa sağlayıcı, video olarak gösterilecek bir küçük resim sağlamalıdır.	Yardım için Resim Özellikleri bölümüne bakın.
Metin içeriği	İsteğe bağlı	Bir yayının, güncellemenin vb. ana metni.	Dize (önerilen maksimum 140 karakter)
Zaman damgası	İsteğe bağlı	Yayının yayınlandığı zaman.	Milisaniye cinsinden Epoch zaman damgası
Video içeriğidir.	İsteğe bağlı	Gönderi video mu?	boole
Video süresi	İsteğe bağlı	Videonun milisaniye cinsinden süresi.	Uzun
Profille ilgili meta veriler (isteğe bağlı)
Ad	Zorunlu	Profil adı veya kimliği ya da herkese açık kullanıcı adı (ör. "Can Demir", "@TeamPixel")	Dize(en fazla 25 karakter önerilir)
Avatar	Zorunlu	Kullanıcının profil resmi veya avatar resmi. Kare 1:1 resim	Yardım için Resim Özellikleri bölümüne bakın.
Ek resim	İsteğe bağlı	Profil rozeti. Örneğin, doğrulanmış rozet Kare 1:1 resim	Yardım için Resim Özellikleri bölümüne bakın.
Etkileşimler ile ilgili meta veriler (İsteğe bağlı)
Sayı	İsteğe bağlı	Etkileşim sayısını belirtin (ör. "3, 7 milyon"). Not: Hem Sayı hem de Sayı Değeri sağlanırsa Adet kullanılır.	Dize Önerilen metin boyutu: Sayı + etiket için toplam maksimum 20 karakter
Sayı Değeri	İsteğe bağlı	Etkileşim sayısı (değer). Not: Uygulamanız, büyük bir sayının farklı ekran boyutları için nasıl optimize edilmesi gerektiğine dair mantığı desteklemiyorsa Sayım yerine Sayı Değeri sağlayın. Hem Sayı hem de Sayı Değeri sağlanırsa Sayı kullanılır.	Uzun
Etiket	İsteğe bağlı	Etkileşim etiketinin ne için olduğunu belirtin. Örneğin: "Beğeniler".	Dize Önerilen metin boyutu: Sayı + etiket için en fazla 20 karakter
Görsel	İsteğe bağlı	Etkileşimin neyle ilgili olduğunu belirtin. Örneğin: Beğenme simgesini, emojiyi gösteren resim. 1'den fazla resim eklenebilir ancak tüm form faktörlerinde bunların hepsi gösterilmeyebilir. Not: 1:1 kare resim olmalıdır.	Yardım için Resim Özellikleri bölümüne bakın.
DisplayTimeWindow (İsteğe bağlı) - Bir içeriğin yüzeyde gösterileceği bir zaman aralığı belirleme
Başlangıç zaman damgası	İsteğe bağlı	İçeriğin yüzeyde gösterilmesi gereken epoch zaman damgası. Politika ayarlanmazsa içerik, platformda gösterilmeye uygundur.	Milisaniye cinsinden Unix sıfır zaman damgası
Bitiş zaman damgası	İsteğe bağlı	İçeriğin artık platformda gösterilmeyeceği zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur.	Milisaniye cinsinden Unix sıfır zaman damgası

SocialPostEntity

Özellik	Şartlar	Açıklama	Biçim
İşlem URI'si	Zorunlu	Sağlayıcı uygulamasındaki öğeye derin bağlantı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın	URI
Gönderiyle ilgili meta veriler (Zorunlu) TextContent, Image veya WebContent öğelerinden en az biri gereklidir.
Resimler	İsteğe bağlı	Resimler dikey en boy oranında olmalıdır. Birden fazla resim sağlandığında kullanıcı arayüzünde yalnızca 1 resim gösterilebilir. Bununla birlikte, kullanıcı arayüzü, uygulamada daha fazla görüntü olduğuna dair görsel bir işaret sağlayabilir. Yayın videoysa sağlayıcı, videonun resim olarak gösterilecek küçük resmini sağlamalıdır.	Yardım için Resim Özellikleri bölümüne bakın.
Metin içeriği	İsteğe bağlı	Bir yayının, güncellemenin vb. ana metni.	Dize (önerilen maksimum 140 karakter)
Video İçeriği (İsteğe bağlı)
Süre	Zorunlu	Videonun milisaniye cinsinden süresi.	Uzun
Resim	Zorunlu	Video içeriğinin önizleme resmi.	Yardım için Resim Özellikleri bölümüne bakın.
Bağlantı Önizleme (İsteğe Bağlı)
Bağlantı Önizlemesi - Başlık	Zorunlu	Web sayfası içeriğinin başlığını belirten metin	Dize
Bağlantı Önizleme - Ana Makine Adı	Zorunlu	Web sayfasının sahibini belirten metin (ör. "INSIDER")	Dize
Bağlantı Önizlemesi - Resim	İsteğe bağlı	Web içeriği için hero resim	Yardım için Resim Özellikleri bölümüne bakın.
Zaman damgası	İsteğe bağlı	Yayının yayınlandığı zaman.	Milisaniye cinsinden Unix sıfır zaman damgası
Profille ilgili meta veriler (İsteğe bağlı)
Ad	Zorunlu	Profil adı veya kimliği ya da herkese açık kullanıcı adı (ör. "Can Demir", "@TeamPixel").	Dize (önerilen maksimum 25 karakter)
Ek Metin	İsteğe bağlı	Profil kimliği, herkese açık kullanıcı adı veya ek meta veri olarak kullanılabilir. Örneğin, "@Ali-Demir", "5 milyon takipçi", "Beğenebileceğiniz içerikler", "Trendler", "5 yeni yayın"	Dize(en fazla 40 karakter önerilir)
Avatar	Zorunlu	Kullanıcının profil resmi veya avatar resmi. Kare 1:1 resim	Yardım için Resim Özellikleri'ne bakın.
Ek resim	İsteğe bağlı	Profil rozeti (ör. doğrulanmış rozet) Kare 1:1 resim	Yardım için Resim Özellikleri bölümüne bakın.
Etkileşimler ile ilgili meta veriler (İsteğe bağlı)
Sayı	Zorunlu	Etkileşim sayısını belirtin (ör. "3,7 milyon").	Dize (sayı + etiket için önerilen maksimum 20 karakter)
Etiket	İsteğe bağlı Bu ayar sağlanmazsa Görsel sağlanmalıdır.	Etkileşimin ne için olduğunu belirtin. Örneğin - "Beğenilenler".	Dize (sayı + etiket için önerilen maksimum 20 karakter)
Görsel	İsteğe bağlı Bu değer sağlanmazsa Label sağlanmalıdır.	Etkileşimin neyle ilgili olduğunu belirtin. Örneğin, Beğenme simgesini ve emojiyi gösteren resim. 1'den fazla resim eklenebilir ancak tüm form faktörlerinde bunların hepsi gösterilmeyebilir. Kare 1:1 resim	Yardım için Resim Özellikleri bölümüne bakın.
DisplayTimeWindow (İsteğe bağlı) - Bir içeriğin yüzeyde gösterileceği bir zaman aralığı belirleme
Başlangıç zaman damgası	İsteğe bağlı	İçeriğin yüzeyde gösterilmesi gereken epoch zaman damgası. Politika ayarlanmazsa içerik, platformda gösterilmeye uygundur.	Milisaniye cinsinden Unix sıfır zaman damgası
Bitiş zaman damgası	İsteğe bağlı	İçeriğin artık platformda gösterilmeyeceği zaman damgası. Ayarlanmazsa içerik yüzeyde gösterilmeye uygundur.	Milisaniye cinsinden Unix sıfır zaman damgası

Resim özellikleri

Google'ın görüntülere erişebilmesi için görüntülerin herkese açık CDN'lerde barındırılması gerekir.

Dosya biçimleri

PNG, JPG, statik GIF, WebP

Maksimum dosya boyutu

5.120 KB

Ek öneriler

• Resim güvenli alanı: Önemli içeriklerinizi yatay ve dikey yönde ortalanmış olarak resmin %80'ini kaplayacak şekilde yerleştirin.
• Resmin Koyu ve Açık tema ayarlarında düzgün bir şekilde gösterilebilmesi için şeffaf bir arka plan kullanın.

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

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

AppEngageSocialClient, sosyal kümeleri yayınlamaktan sorumludur.

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

• isServiceAvailable
• publishRecommendationClusters
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

Bu API, hizmetin entegrasyon için kullanılıp kullanılamadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.

Kotlin

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

Java

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

Not: Hizmetin daha sonra kullanıma sunulup sunulmadığını kontrol etmek için düzenli aralıklarla bir işin çalıştırılmasını önemle tavsiye ederiz. Hizmetin kullanılabilirliği, Android sürüm yükseltmeleri, uygulama yükseltmeleri, yüklemeler ve kaldırma işlemleriyle değişebilir. Belirli bir zaman aralığında düzenli iş kontrolleri yapılarak hizmet kullanıma sunulduğunda veriler yayınlanabilir.

publishRecommendationClusters

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

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

Özellik	Şartlar	Açıklama
SocialPostEntity veya PortraitMediaEntity listesi	Zorunlu	Bu öneri kümesi için önerileri oluşturan öğelerin listesi. Tek bir kümedeki varlıklar aynı türde olmalıdır.
Başlık	Zorunlu	Öneri kümesinin başlığı (ör. Arkadaşlarınızın son paylaşımları). Önerilen metin boyutu: 25 karakterden kısa (Çok uzun metinlerde üç nokta gösterilebilir)
Alt başlık	İsteğe bağlı	Öneri kümesinin alt başlığı.
İşlem Uri	İsteğe bağlı	Kullanıcıların önerilerin tam listesini görebileceği iş ortağı uygulamasındaki sayfanın derin bağlantısı. Not: İlişkilendirme için derin bağlantıları kullanabilirsiniz. Bu SSS'ye bakın

Önemli: Yayınlama API'leri, mevcut içeriğin yerini alan güncelleme API'leridir. Yayınlama API'leri bunu doğal olarak yaptığından, içeriği değiştirmek için sırasıyla sil ve yayınla API'lerini çağırmayın.

Önemli: Sosyal uygulamalarda, her uygulama kullanımından sonra önerileri güncellemek çok önemlidir. Sosyal uygulama kullanıcıları en son önerilerle daha çok ilgilenir ve ideal olarak bir yayını en fazla bir kez görmek ister.

Kotlin

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .build())
                .build())

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Latest from your friends")
                        .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ümelerinde 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:

Özellik	Şartlar	Açıklama
İşlem URI'sı	Zorunlu	İşlem için derin bağlantı (ör. uygulamada oturum açma sayfasına gider)
Resim	İsteğe bağlı: Sağlanmazsa başlık sağlanmalıdır	Kartta gösterilen resim 1264x712 çözünürlüğe sahip 16x9 en boy oranına sahip resimler
Başlık	İsteğe bağlı: Sağlanmazsa resim sağlanmalıdır	Karttaki Başlık
İşlem metni	İsteğe bağlı	CTA'da (ör. Oturum Aç) gösterilen metin
Alt başlık	İsteğe bağlı	Kartta isteğe bağlı altyazı

Önemli: Yayınlama API'leri, mevcut içeriğin yerini alan güncelleme API'leridir. Yayınlama API'leri bunu doğal olarak yaptığından, içeriği değiştirmek için silmek ve yayınlamak API'lerini ardı ardına çağırmayın.

Kotlin

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

Java

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

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

updatePublishStatus

İşletmeyle ilgili herhangi bir nedenle kümelerden hiçbiri yayınlanmaz. Yayınlama durumunu updatePublishStatus API'sini kullanarak güncellemenizi kesinlikle öneririz. Bu önemlidir, çünkü :

• İçerik yayınlandığında 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 çok önemlidir.
• Hiçbir içerik yayınlanmadıysa ancak entegrasyon durumu bozuk değilse (STATUS == NOT_PUBLISHED) Google, uygulamanın sağlık 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ığıyla ilgili bilgi sağlamasına yardımcı olur.
• Google, kullanıcının uygulama içeriğini görmesini veya bu engeli aşmasını sağlamak için uygulamada belirli işlemleri yapmasına teşvik etmek amacıyla durum kodlarını kullanabilir.

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

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

Kotlin

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

Java

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.

Önemli: Delete API'leri yalnızca yayınlanacak içerik olmadığında çağrılmalıdır. Yayınlama API'leri bunu doğal olarak yaptığından, içeriği değiştirmek için sil ve yayınla API'lerini ardı ardına çağırmayın. Silme API'lerini kullanmadan önce engage-developers@ ile iletişime geçin.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Hizmet, isteği aldığında mevcut verileri öneri kümelerinden kaldırır. 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.

Önemli: Silme API'leri yalnızca yayınlanacak içerik olmadığında çağrılmalıdır. Yayınlama API'leri bunu doğal olarak yaptığından, içeriği değiştirmek için sil ve yayınla API'lerini ardı ardına çağırmayın. Silme API'lerini kullanmadan önce engage-developers@ ile iletişime geçin.

Kotlin

client.deleteUserManagementCluster()

Java

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.

Önemli: Silme API'leri yalnızca yayınlanacak içerik olmadığında çağrılmalıdır. Yayınlama API'leri bunu doğal olarak yaptığından, içeriği değiştirmek için sil ve yayınla API'lerini ardı ardına çağırmayın. Silme API'lerini kullanmadan önce engage-developers@ ile iletişime geçin.

Kotlin

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

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                ...
                .build());

Hizmet isteği aldığında, belirtilen küme türleriyle eşleşen tüm kümelerden 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

Başarılı bir görevi kurtarmak ve yeniden göndermek için takip işleminin yapılabilmesi için görev sonucunun publish API'lerinden dinlenmesi ö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, nedeni hata kodu olarak eklenmiş bir AppEngageException olarak döndürülür.

Hata kodu	Hata adı	Not
1	SERVICE_NOT_FOUND	Hizmet, belirtilen cihazda kullanılamıyor.
2	SERVICE_NOT_AVAILABLE	Hizmet, belirli bir cihazda kullanılabilir ancak arama sırasında kullanılamaz (örneğin, açıkça devre dışı bırakılmıştır).
3	SERVICE_CALL_EXECUTION_FAILURE	Görev yürütme, mesaj dizileriyle ilgili sorunlar nedeniyle başarısız oldu. Bu durumda, işlem yeniden denenebilir.
4	SERVICE_CALL_PERMISSION_DENIED	Arayanın hizmet çağrısı yapmasına izin verilmiyor.
5	SERVICE_CALL_INVALID_ARGUMENT	İstek geçersiz veriler içeriyor (örneğin, izin verilen küme sayısından daha fazla).
6	SERVICE_CALL_INTERNAL	Hizmet tarafında bir hata var.
7	SERVICE_CALL_RESOURCE_EXHAUSTED	Servis çağrısı çok sık yapılıyor.

3. Adım: Yayın amaçlarını ele alın

İç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. Yalnızca Engage Hizmeti içeriğin güncel olmayabileceğini (ör. bir haftalık) 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, hâlâ bellekte bulunan uygulamalardan iletişim kurulmasını sağlar.

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION 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));

}

• AndroidManifest.xml dosyanızdaki <receiver> etiketi ile bir uygulamayı statik olarak bildirin. 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>
   </receiver>
</application>

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

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu amacı aldığınızda publishRecommendationClusters çağrısı başlatmanız önerilir.

Entegrasyon iş akışı

İşlem tamamlandıktan sonra entegrasyonunuzu doğrulamayla ilgili adım adım açıklamalı kılavuz için Etkileşim kurma geliştirici entegrasyonu 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 sürecinde herhangi bir sorunuz olursa [e-mail] adresiyle iletişime geçin. Ekibimiz mümkün olan en kısa sürede yanıt verecektir.

Sonraki adımlar

Bu entegrasyonu tamamladıktan sonra şu adımları uygulayabilirsiniz:

• [e-mail] 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üncellenen APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneriniz yayınlanır ve kullanıcılar tarafından görülebilir.