Engage SDK Social：第三方技術整合操作說明

Google 正在建構的裝置端途徑會依產業別將使用者的應用程式分門別類，並提供全新沉浸式體驗，可供使用者取用及瀏覽個人化應用程式內容。開發合作夥伴可以利用這個全螢幕體驗，在應用程式以外的專屬管道展示最精彩的多媒體內容。

本文件適用對象為開發合作夥伴，提供透過 Engage SDK 填入此新途徑區域，整合社群內容的操作說明。

整合詳情

如要瞭解整合詳情，請參閱以下章節。

術語

「推薦」叢集會顯示個別開發合作夥伴提供的個人化建議。

推薦內容採用以下結構：

推薦叢集：此 UI 檢視畫面包含相同開發合作夥伴提供的一組推薦內容。

每個推薦叢集都包含下列其中一種實體：

  • PortraitMediaEntity
  • SocialPostEntity

PortraitMediaEntity 必須包含 1 張貼文的直向圖片，但不一定要有與個人資料和互動情形相關的中繼資料。

  • 貼文

    • 直向圖片和時間戳記，或
    • 直向圖片 + 文字內容和時間戳記

  • 個人資料

    • 顯示圖片、名稱或帳號代碼、其他圖片

  • 互動情形

    • 僅限次數和標籤，或
    • 次數和影像 (圖示)

SocialPostEntity：內含與個人資料、貼文、互動情形相關的中繼資料。

  • 設定檔

    • 顯示圖片、名稱或帳號代碼、其他文字、其他圖片

  • 貼文

    • 文字和時間戳記，或
    • 互動式多媒體 (圖片或互動式網址) 和時間戳記，或
    • 文字和互動式多媒體 (圖片或互動式網址) 及時間戳記

  • 互動情形

    • 僅限次數和標籤，或
    • 次數和影像 (圖示)

事前作業

最低 API 級別：19

將 com.google.android.play:engage 程式庫新增至應用程式：

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

摘要

這項設計是以繫結服務的實作為基礎。

用戶端可發布的資料受到不同叢集類型的限制，如下所示：

叢集類型 叢集限制 單一叢集中的實體數量下限 單一叢集中的實體數量上限
推薦叢集 最多 5 個 至少 5 個 (PortraitMediaEntity 或 SocialPostEntity) 最多 25 個 (PortraitMediaEntity 或 SocialPostEntity)

步驟 1：提供實體資料

SDK 定義了不同實體，用來代表各種項目類型。此 SDK 支援 Social 類別的以下實體：

  1. PortraitMediaEntity
  2. SocialPostEntity

下方圖表列出各類型的可用屬性和必要性。

PortraitMediaEntity

屬性 必要性 說明 格式
動作 URI 必要

服務供應商應用程式中實體的深層連結。

注意：您可以使用深層連結追蹤歸因。請參閱這篇常見問題文章

URI
貼文相關中繼資料 (必要)
圖片 必要

圖片應採直向顯示比例。

當您提供多張圖片時，UI 可能只會顯示 1 張圖片。然而，UI 或許會以視覺指標說明應用程式中還有其他圖片。

如果貼文為影片，提供者應附上可顯示為圖片的影片縮圖。

如需相關指南，請參閱「圖片規格」一節。
文字內容 選用 貼文、更新等項目的主要文字。 字串 (建議最多 140 個半形字元)
時間戳記 選用 發布貼文的時間。 以毫秒為單位的 Epoch 時間戳記
個人資料相關中繼資料 (選用)
名稱 必要 個人資料名稱，或 ID/帳號代碼，例如「John Doe」、「@TeamPixel」 字串 (建議最多 25 個半形字元)
顯示圖片 必要

使用者的個人資料相片或顯示圖片。

正方形 1:1 圖片

如需相關指南，請參閱「圖片規格」一節。
其他圖片 選用

個人資料徽章。例如：經驗證徽章

正方形 1:1 圖片

如需相關指南，請參閱「圖片規格」一節。
互動情形相關中繼資料 (選用)
次數 必要 表示互動次數，例如「370 萬次」。 字串 (建議最多 20 個半形字元，次數 + 標籤合計)
唱片公司

選用

與影像須擇一提供。

指出互動目的，例如「按讚」。 字串 (建議最多 20 個半形字元，次數 + 標籤合計)
影像

選用

與標籤須擇一提供。

指出互動目的，例如：顯示按讚圖示、表情符號的圖片。

可以提供多張圖片，但不一定在所有板型規格上都能顯示。

正方形 1:1 圖片

如需相關指南，請參閱「圖片規格」一節。
DisplayTimeWindow (選用) - 設定內容在途徑上顯示的時間長度
開始時間戳記 選用

Epoch 時間戳記，內容應會在此時間過後顯示在途徑上。

如未設定，表示內容一律會顯示在途徑上。

 以毫秒為單位的 Epoch 時間戳記
結束時間戳記 選用

Epoch 時間戳記，內容在此時間後將不會顯示在途徑上。

如未設定，表示內容一律會顯示在途徑上。

 以毫秒為單位的 Epoch 時間戳記

SocialPostEntity

屬性 必要性 說明 格式
動作 URI 必要

服務供應商應用程式中實體的深層連結。

注意：您可以使用深層連結追蹤歸因。請參閱這篇常見問題文章

URI

貼文相關中繼資料 (必要)

至少須在 TextContent、Image 或 WebContent 中擇一使用

圖片 選用

圖片應採直向顯示比例。

當您提供多張圖片時，UI 可能只會顯示 1 張圖片。然而，UI 或許會以視覺指標說明應用程式中還有其他圖片。

如果貼文為影片，提供者應附上可顯示為圖片的影片縮圖。

如需相關指南，請參閱「圖片規格」一節。
文字內容 選用 貼文、更新等項目的主要文字。 字串 (建議最多 140 個半形字元)
連結預覽 (選用)
連結預覽 - 標題 必要 指出網頁內容標題的文字 字串
連結預覽 - 主機名稱 必要 指示網頁擁有者的文字，例如「INSIDER」 字串
連結預覽 - 圖片 選用 網頁內容的主頁橫幅 如需相關指南，請參閱「圖片規格」一節。
時間戳記 選用 發布貼文的時間。 以毫秒為單位的 Epoch 時間戳記
個人資料相關中繼資料 (選用)
名稱 必要 個人資料名稱，或 ID/帳號代碼，例如「John Doe」、「@TeamPixel」。 字串 (建議最多 25 個半形字元)
其他文字 選用

可用來當做個人資料 ID、帳號代碼或其他中繼資料

例如「@John-Doe」、「500 萬名追蹤者」、「你可能會喜歡」、「發燒主題」、「5 則新貼文」

字串 (建議最多 40 個半形字元)
顯示圖片 必要

使用者的個人資料相片或顯示圖片。

正方形 1:1 圖片

如需相關指南，請參閱「圖片規格」一節。
其他圖片 選用

個人資料徽章。例如：經驗證徽章

正方形 1:1 圖片

如需相關指南，請參閱「圖片規格」一節。
互動情形相關中繼資料 (選用)
次數 必要 表示互動次數，例如「370 萬次」。 字串 (建議最多 20 個半形字元，次數 + 標籤合計)
唱片公司

選用

與影像須擇一提供。

指出互動目的，例如「按讚」。 字串 (建議最多 20 個半形字元，次數 + 標籤合計)
影像

選用

與標籤須擇一提供。

指出互動目的，例如：顯示按讚圖示、表情符號的圖片。

可以提供多張圖片，但不一定在所有板型規格上都能顯示。

正方形 1:1 圖片

如需相關指南，請參閱「圖片規格」一節。
DisplayTimeWindow (選用) - 設定內容在途徑上顯示的時間長度
開始時間戳記 選用

Epoch 時間戳記，內容應會在此時間過後顯示在途徑上。

如未設定，表示內容一律會顯示在途徑上。

 以毫秒為單位的 Epoch 時間戳記
結束時間戳記 選用

Epoch 時間戳記，內容在此時間後將不會顯示在途徑上。

如未設定，表示內容一律會顯示在途徑上。

 以毫秒為單位的 Epoch 時間戳記

圖片規格

圖片必須在公開 CDN 上代管，以便 Google 存取。

檔案格式

PNG、JPG、靜態 GIF、WebP

檔案大小上限

5120 KB

其他建議

  • 圖片安全區域：將重要內容放在圖片中央 80% 的範圍內。
  • 使用透明背景，讓圖片正確顯示在深色和淺色主題設定中。

步驟 2：提供叢集資料

建議您在背景執行內容發布工作 (例如使用 WorkManager)，並安排定期執行或根據事件排程 (例如使用者每次開啟應用程式，或剛追蹤某個新帳戶時)。

AppEngageSocialClient 負責發布社交叢集。

以下 API 可用於在用戶端發布叢集：

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

isServiceAvailable

這個 API 可用於檢查服務是否可供整合，以及內容是否能在裝置上顯示。

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

publishRecommendationClusters

這個 API 用於發布 RecommendationCluster 物件清單。

RecommendationCluster 物件可提供下列屬性：

屬性 必要性 說明
SocialPostEntity 清單或 PortraitMediaEntity 清單 必要 實體清單，組成這個推薦叢集的推薦項目。單一叢集中的實體必須屬於相同類型。
標題 必要

推薦叢集的標題 (例如「好友的最新動態」)。

建議文字長度：最多 25 個半形字元，過長部分會以刪節號顯示
動作 URI 選用

合作夥伴應用程式中的頁面深層連結，可供使用者查看推薦項目完整清單。

注意：您可以使用深層連結追蹤歸因。請參閱這篇常見問題文章

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

服務收到要求後，系統會在單一交易中執行以下動作：

  • 移除所有現有推薦叢集資料。
  • 剖析要求所提供的資料並儲存在新的推薦叢集中。

如果發生錯誤，整個要求都會遭到拒絕，現有狀態則維持不變。

publishUserAccountManagementRequest

這個 API 是用來發布「登入」資訊卡。登入動作會將使用者導向應用程式的登入頁面，方便應用程式發布內容 (或提供更個人化的內容)

登入資訊卡包含下列中繼資料：

屬性 必要性 說明
動作 URI 必要 導向動作的深層連結，也就是前往應用程式登入頁面
圖片 選用 - 如未提供，則必須提供標題

資訊卡上顯示的圖片

解析度 1264x712、顯示比例 16x9 的圖片
標題 選用 - 如未提供，則必須提供圖片 資訊卡上的標題
動作文字 選用 行動號召中顯示的文字，也就是「登入」
副標題 選用 資訊卡上的選用副標題

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

服務收到要求後，系統會在單一交易中執行以下動作：

  • 移除開發合作夥伴提供的現有 UserAccountManagementCluster 資料。
  • 剖析要求所提供的資料並儲存在更新後的 UserAccountManagementCluster 叢集中。

如果發生錯誤，整個要求都會遭到拒絕，現有狀態則維持不變。

updatePublishStatus

如因內部業務原因，導致無法發布任何叢集，我們強烈建議使用 updatePublishStatus API 更新發布狀態。這麼做很重要，因為：

  • 在所有情況下，提供狀態都至關重要，即使內容已發布 (STATUS == PUBLISHED) 也一樣。如此一來，才能為資訊主頁填入資料，並以明確的狀態表示整合項目的健康度和其他指標。
  • 如未發布內容，但整合狀態未遭中斷 (STATUS == NOT_PUBLISHED)，Google 便可避免在應用程式健康資訊主頁中觸發快訊。這可從提供者的角度確認內容是因預期的情況而未發布。
  • 這有助開發人員深入瞭解資料何時已發布或未發布。
  • Google 可能會使用狀態碼，提醒使用者在應用程式中執行特定動作，以便查看或解決應用程式內容。

以下為符合資格的發布狀態碼清單：

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

如果內容因使用者未登入而未發布，建議您發布登入資訊卡。如因任何原因導致提供者無法發布登入資訊卡，建議您呼叫 updatePublishStatus API，並使用狀態碼 NOT_PUBLISHED_REQUIRES_SIGN_IN。

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

這個 API 可用來刪除推薦叢集的內容。

Kotlin


client.deleteRecommendationClusters()

Java


client.deleteRecommendationClusters();

服務收到要求後，會從推薦叢集中移除現有資料。如果發生錯誤，整個要求都會遭到拒絕，現有狀態則維持不變。

deleteUserManagementCluster

這個 API 可用來刪除 UserAccountManagement 叢集的內容。

Kotlin


client.deleteUserManagementCluster()

Java


client.deleteUserManagementCluster();

服務收到要求後，會從 UserAccountManagement 叢集中移除現有資料。如果發生錯誤，整個要求都會遭到拒絕，現有狀態則維持不變。

deleteClusters

這個 API 可用於刪除指定叢集類型的內容。

Kotlin


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

Java


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

服務收到要求後，會從符合指定叢集類型的所有叢集中移除現有資料。用戶端可以選擇傳遞一或多個叢集類型。如果發生錯誤，整個要求都會遭到拒絕，現有狀態則維持不變。

處理錯誤

強烈建議您監聽來自發布 API 的工作結果，據以採取後續動作來復原及重新提交能順利執行的工作。

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

發生錯誤時會傳回 AppEngageException，並提供原因的錯誤代碼。

錯誤代碼 附註
SERVICE_NOT_FOUND 這項服務不適用於指定裝置。
SERVICE_NOT_AVAILABLE 這項服務適用於指定裝置，但無法於呼叫期間使用 (例如服務已明確停用)。
SERVICE_CALL_EXECUTION_FAILURE 執行緒發生問題，因此工作執行失敗。在這種情況下，您可以重試。
SERVICE_CALL_PERMISSION_DENIED 呼叫端未獲准發出服務呼叫。
SERVICE_CALL_INVALID_ARGUMENT 要求包含無效的資料 (例如，超過允許的叢集數量上限)。
SERVICE_CALL_INTERNAL 服務端發生錯誤。
SERVICE_CALL_RESOURCE_EXHAUSTED 服務呼叫過於頻繁。

步驟 3：處理廣播意圖

除了透過工作發出發布內容 API 呼叫，您還需要設定 BroadcastReceiver 來接收內容發布要求。

廣播意圖的目標主要用於應用程式重新啟動及強制同步處理資料。廣播意圖的傳送頻率通常不高。觸發廣播意圖的唯一時機，就是 Engage Service 判定內容可能過時 (例如已滿一週)。這樣一來，即使應用程式已有長時間未執行，使用者也能獲得最新的內容體驗。

BroadcastReceiver 必須透過下列兩種方式進行設定：

  • 使用 Context.registerReceiver() 以動態方式註冊 BroadcastReceiver 類別的例項。這樣就能接收仍在記憶體中的應用程式訊息。
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 檔案中使用 <receiver> 標記，以靜態方式宣告實作項目。這可讓未執行的應用程式接收廣播意圖，也能讓應用程式發布內容。
<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>

服務會傳送下列意圖：

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION 建議在收到此意圖時啟動 publishRecommendationClusters 呼叫。

整合工作流程

如需整合完成後驗證作業的逐步指南，請參閱「Engage 開發人員整合工作流程」一文。

常見問題

請參閱「Engage SDK 常見問題」。

聯絡資訊

如果在整合過程中有任何問題，請來信至 engage-developers@google.com 與我們聯絡。我們的團隊會盡快回覆。

後續步驟

完成這項整合後，後續步驟如下：

  • 傳送電子郵件至 engage-developers@google.com，並附上整合完成可供 Google 測試的 APK。
  • Google 會在內部執行驗證及審查，確認整合項目能夠正常運作。如果需要進行變更，Google 會與您聯絡並提供所有必要詳細資料。
  • 測試完成後，如果不需要進行任何變更，Google 會與您聯絡，通知您可以開始將完成整合的更新版 APK 發布至 Play 商店。
  • Google 確認您已將更新版 APK 發布至 Play 商店後，就會發布您的推薦叢集供使用者瀏覽。