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

Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

Google, kullanıcıların uygulamalarını sektörlere göre düzenleyen ve kişiselleştirilmiş uygulama içeriği tüketimi ve keşfi için yeni bir sürükleyici 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ı yer alır.

Terminoloji

Öneri kümeleri, geliştirici iş ortakları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, 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 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ğlantılı bir hizmet uygulamasına dayanır.

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

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

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

PortraitMediaEntity

SocialPostEntity

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 şekilde gösterilmesi için şeffaf 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ılamayacağı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, bir RecommendationCluster nesnesi listesi yayınlamak için kullanılır.

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

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

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ğının mevcut UserAccountManagementCluster verileri kaldırılır.
• İstekten gelen veriler ayrıştırılır ve güncellenen UserAccountManagementCluster kümesinde depolanır.

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

updatePublishStatus

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

• İçerik yayınlandığında bile (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ınlanmamışsa ancak entegrasyon durumu bozulmamışsa (STATUS == NOT_PUBLISHED) Google, uygulama sağlığı kontrol panellerinde uyarı tetiklemekten kaçınabilir. Sağlayıcı açısından beklenen bir durum nedeniyle içeriğin yayınlanmadığını onaylar.
• Geliştiricilerin verilerin ne zaman yayınlandığı ve ne zaman yayınlanmadığı hakkında analizler sunmasına yardımcı olur.
• Google, 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.

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

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

deleteRecommendationClusters

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

Hizmet, isteği aldığında mevcut verileri öneri kümelerinden kaldırır. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

deleteUserManagementCluster

Bu API, UserAccountManagement kümesinin içeriğini silmek için kullanılır.

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

Hizmet, isteği aldığında mevcut verileri UserAccountManagement kümesinden kaldırır. Hata durumunda istek tamamen 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 belirtilen küme türleriyle eşleşen tüm kümelerdeki mevcut verileri kaldırır. İstemciler bir veya daha fazla küme türünü iletmeyi seçebilir. Hata olması durumunda isteğin tamamı reddedilir ve mevcut durum korunur.

Hata işleme

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

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

Hata, hata kodu olarak nedeni dahil edilerek AppEngageException olarak döndürülür.

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

Bir iş aracılığıyla içerik yayınlama API çağrıları yapmanın yanı sıra, içerik yayınlama isteğini almak için bir BroadcastReceiver oluşturmanız da gerekir.

Yayın niyetinin amacı, temel olarak uygulamayı yeniden etkinleştirmek ve veri senkronizasyonunu zorlamaktır. Yayın niyetleri ç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() sınıfının bir örneğini Context.registerReceiver() kullanarak dinamik olarak kaydedin.BroadcastReceiver Bu sayede, bellekte hâlâ etkin olan uygulamalardan iletişim kurulabilir.

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ızda <receiver> etiketiyle uygulamayı statik olarak beyan edin. Bu, uygulamanın çalışmadığında yayın intent'leri almasına ve içeriği yayınlamasına olanak tanır.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
   </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ışı

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

SSS

SSS için Engage SDK Sık Sorulan Sorular başlıklı makaleyi inceleyin.

İletişim

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

Sonraki adımlar

Bu entegrasyonu tamamladıktan sonra uygulayacağınız adımlar şunlardır:

• engage-developers@google.com adresine e-posta gönderin ve Google tarafından test edilmeye hazır 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ı gerekirse Google gerekli tüm bilgileri sizinle paylaşır.
• Test tamamlandığında ve herhangi bir değişiklik gerekmediğinde Google, güncellenmiş ve entegre APK'yı Play Store'da yayınlamaya başlayabileceğinizi bildirmek için sizinle iletişime geçer.
• Google, güncellenmiş APK'nızın Play Store'da yayınlandığını onayladıktan sonra Öneri kümeniz yayınlanır ve kullanıcılara gösterilir.