Engage SDK Social: Üçü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 sosyal medya içeriklerini Engage içerik yüzeylerine yayınlaması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ı

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

Terminoloji

Öneri kümeleri, bireysel geliştirici iş ortaklarından gelen kişiselleştirilmiş önerileri gösterir.

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

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

Her Öneri Kümesi, aşağıdaki iki varlık türünden birini içerir :

• 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
  • Portre modunda 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ı ya da
  • Metin ve rich media (resim veya zengin URL) ve zaman damgası ya da
  • 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.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. SDK, Sosyal kategorisi için aşağıdaki öğeleri destekler:

1. PortraitMediaEntity
2. SocialPostEntity

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

PortraitMediaEntity

SocialPostEntity

Resim özellikleri

Google'ın erişebilmesi için resimlerin herkese açık CDN'lerde barındırılması gerekir.

Dosya biçimleri

PNG, JPG, statik GIF, WebP

Maksimum dosya boyutu

5.120 KB

Ek öneriler

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

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

İçerik yayınlama işinin arka planda yürütülmesi (örneğin, WorkManager kullanılarak) ve düzenli olarak veya bir etkinliğe göre (ö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 kullanılır:

• isServiceAvailable
• publishRecommendationClusters
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• 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. Herhangi bir küme türü için bu özelliği etkinleştirmek istiyorsanız engage-developers@google.com adresiyle 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("Latest from your friends")
                        .build())
                .build())

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

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.

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_RECOMMENDATION)
      ...
      .build())

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .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
}

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

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),
                         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>
   </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.

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 size 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 gerekmesi durumunda Google, gerekli ayrıntıları paylaşmak için sizinle iletişime geçer.
• Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre edilmiş APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
• Google, güncellenmiş APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri kümeleriniz yayınlanır ve kullanıcılara gösterilir.