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 Koleksiyonlar, Entertainment Space ve Play Store gibi cihaz üzerindeki birden fazla yüzeyde kullanıcılara doğrudan kişiselleştirilmiş öneriler ve devam içerikleri sunun. Entegrasyon, ortalama APK boyutuna 50 KB'tan daha az (sıkıştırılmış) ekler ve çoğu uygulamanın geliştirici süresini yaklaşık bir hafta uzatı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 sosyal medya içeriği sunmasıyla ilgili talimatlar yer almaktadır.

Entegrasyon ayrıntıları

Entegrasyonla ilgili ayrıntılar aşağıdaki bölümde verilmiştir.

Terminoloji

Öneri kümeleri, tek 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ğının bir grup önerisini içeren kullanıcı arayüzü görünümü.

Her Öneri Kümesi aşağıdaki iki türden birini içerir :

• PortraitMediaEntity
• SocialPostEntity

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

• Gönderi

  • Dikey modda görüntü 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, gönderi 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 rich URL) ve zaman damgası ya da
  • Metin ve rich media (resim veya rich 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

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

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

Özet

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

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

1. adım: Tüzel kişi verilerini sağlayın

SDK, her öğe türünü temsil etmek için farklı öğeler tanımlamıştır. 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 özetlenmektedir.

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 (ör. WorkManager kullanılarak) ve düzenli olarak veya etkinlik bazında (ör. kullanıcı uygulamayı her açtığında ya da yeni bir hesabı takip ettiğinde) planlanması önerilir.

AppEngageSocialClient, sosyal kümelerin yayınlanmasından 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 entegrasyona uygun olup olmadığını ve içeriğin cihazda sunulup sunulamayacağını kontrol etmek için kullanılır.

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content
          // publish calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content
          // publish calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

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

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

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("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 işlemler gerçekleşir:

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

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

publishUserAccountManagementRequest

Bu API, oturum açma kartı yayınlamak için kullanılır . Oturum açma işlemi, kullanıcıları uygulamanın oturum açma sayfasına yönlendirir. Böylece uygulama, içerik yayınlayabilir (veya daha kişiselleştirilmiş içerikler sunabilir).

Aşağıdaki meta veriler, oturum açma kartının bir parçasıdır:

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

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

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

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

updatePublishStatus

Herhangi bir dahili işletme nedeniyle kümelerden hiçbiri yayınlanmıyorsa updatePublishStatus API'sini kullanarak yayın durumunu güncellemenizi şiddetle tavsiye ederiz. Bu önemlidir, çünkü :

• İçerik yayınlanmış olsa bile (STATUS == PUBLISHED) tüm senaryolarda durumu sağlamak, bu açık durumu kullanarak entegrasyonunuzun durumunu ve diğer metriklerini ileten kontrol panellerini doldurmak için kritik öneme sahiptir.
• İçerik yayınlanmamış ancak entegrasyon durumu bozulmamışsa (STATUS == NOT_PUBLISHED), Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemeyi önleyebilir. İçeriğin, sağlayıcının bakış açısıyla beklenen bir durum nedeniyle yayınlanmadığını onaylar.
• Geliştiricilerin, verilerin ne zaman yayınlandığına dair bilgi vermesine yardımcı olur.
• Google, kullanıcıyı uygulamada belirli işlemleri yapmaya yönlendirmek için durum kodlarını kullanabilir. Böylece kullanıcılar uygulama içeriğini görebilir veya sorunları aşabilir.

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

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

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

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

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

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

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

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

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

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

İçerik, oturum açmamış bir kullanıcı nedeniyle yayınlanmıyorsa Google, oturum açma kartının yayınlanmasını önerir. Sağlayıcılar herhangi bir nedenle oturum açma kartını yayınlayamıyorsa updatePublishStatus API'sinin NOT_PUBLISHED_REQUIRES_SIGN_IN durum koduyla çağrılması önerilir.

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

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

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Hizmet isteği aldığında mevcut verileri Öneri Kümeleri'nden kaldırır. Hata durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

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 içeren bir AppEngageException olarak döndürülür.

3. adım: Yayın amaçlarını işleme

İçerik yayınlama API çağrılarını bir iş üzerinden yapmanın yanı sıra, içerik yayınlama isteğini almak için bir BroadcastReceiver de ayarlamanız gerekir.

Yayın amaçlarının temel hedefi, uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorlamaktır. Yayın amaçları çok sık gönderilmek üzere tasarlanmamıştır. Bu özellik yalnızca Engage Hizmeti, içeriğin eski olabileceğini (örneğin, bir hafta önce yayınlanmış) belirlediğinde tetiklenir. Bu sayede, uygulama uzun süredir çalıştırılmamış olsa bile kullanıcının yeni bir içerik deneyimi yaşayabileceğine dair daha fazla güven duyulur.

BroadcastReceiver aşağıdaki iki şekilde ayarlanmalıdır:

• BroadcastReceiver sınıfının bir örneğini Context.registerReceiver() kullanarak dinamik olarak kaydedin. Bu, bellekte hâlâ etkin olan uygulamalardan gelen iletişime olanak tanır.

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

• <receiver> etiketiyle bir uygulamayı AndroidManifest.xml dosyanızda statik olarak bildirin. Bu izin, uygulamanın çalışmadığı zamanlarda yayın amaçlarını almasına ve içeriği yayınlamasına olanak tanır.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
   </receiver>
</application>

Hizmet tarafından aşağıdaki amaçlar gönderilir:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Bu amaç alındığında publishRecommendationClusters araması başlatmanız önerilir.

Entegrasyon iş akışı

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

SSS

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

İletişim

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

Sonraki adımlar

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

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