Engage SDK Watch：第三方技术集成说明

Google 正在构建一个设备上的界面，该界面按垂直方向组织用户的应用，并为个性化应用内容的消费和发现提供新的沉浸式体验。此全屏体验为开发者合作伙伴提供了一个机会，让他们能够在应用外部的专用频道中展示其最佳的丰富内容。

本指南包含开发者合作伙伴使用 Engage SDK 将其视频内容集成到此新界面区域和现有 Google 界面的说明。

集成细节

术语

此集成包括以下三种集群类型：**推荐**、**续播**和**精选**。

**推荐**集群显示来自单个开发者合作伙伴的个性化内容观看建议。

您的推荐采用以下结构
- **推荐集群：**包含来自同一开发者合作伙伴的一组推荐的 UI 视图。
  
  图 1. 娱乐空间 UI 显示来自单个合作伙伴的推荐集群。
- **实体：**表示集群中单个项目的对象。实体可以是电影、电视节目、电视剧、直播视频等。有关受支持的实体类型的列表，请参阅提供实体数据部分。
  
  图 2. 娱乐空间 UI 显示单个合作伙伴的推荐集群中的单个实体。
**续播**集群在一个 UI 分组中显示来自多个开发者合作伙伴的未完成视频和相关的最新发布剧集。每个开发者合作伙伴最多可以在续播集群中广播 10 个实体。研究表明，个性化推荐以及个性化续播内容可以创造最佳的用户参与度。

图 3. 娱乐空间 UI 显示一个续播集群，其中包含来自多个合作伙伴的未完成推荐（当前仅显示一个推荐）。
**精选**集群在一个 UI 分组中展示来自多个开发者合作伙伴的选择实体。将有一个精选集群，该集群在 UI 顶部附近显示，优先于所有推荐集群。每个开发者合作伙伴最多可以在精选集群中广播 10 个实体。

图 4. 娱乐空间 UI 显示一个精选集群，其中包含来自多个合作伙伴的推荐（当前仅显示一个推荐）。

准备工作

最低 API 级别：19

将com.google.android.engage:engage-core库添加到您的应用

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

有关更多信息，请参阅Android 11 中的包可见性。

总结

该设计基于绑定服务的实现。

客户端可以发布的数据受以下不同集群类型的限制

集群类型	集群限制	集群中实体的最大限制
推荐集群	最多 5 个	最多 50 个
续播集群	最多 1 个	最多 10 个
精选集群	最多 1 个	最多 10 个

步骤 0：从现有的 Media Home SDK 集成迁移

映射现有集成中的数据模型

如果您要从现有的 Media Home 集成迁移，下表概述了如何将现有 SDK 中的数据模型映射到新的 Engage SDK

MediaHomeVideoContract 集成等效项	Engage SDK 集成等效项
`com.google.android.mediahome.video.PreviewChannel`	`com.google.android.engage.common.datamodel.RecommendationCluster`
`com.google.android.mediahome.video.PreviewChannel.Builder`	`com.google.android.engage.common.datamodel.RecommendationCluster.Builder`
`com.google.android.mediahome.video.PreviewChannelHelper`	`com.google.android.engage.video.service.AppEngageVideoClient`
`com.google.android.mediahome.video.PreviewProgram`	分为单独的类：`EventVideo`、`LiveStreamingVideo`、`Movie`、`TvEpisode`、`TvSeason`、`TvShow`、`VideoClipEntity`
`com.google.android.mediahome.video.PreviewProgram.Builder`	分为单独类中的构建器：`EventVideo`、`LiveStreamingVideo`、`Movie`、`TvEpisode`、`TvSeason`、`TvShow`、`VideoClipEntity`
`com.google.android.mediahome.video.VideoContract`	不再需要。
`com.google.android.mediahome.video.WatchNextProgram`	分为单独类中的属性：`EventVideoEntity`、`LiveStreamingVideoEntity`、`MovieEntity`、`TvEpisodeEntity`、`TvSeasonEntity`、`TvShowEntity`、`VideoClipEntity`
`com.google.android.mediahome.video.WatchNextProgram.Builder`	分为单独类中的属性：`EventVideoEntity`、`LiveStreamingVideoEntity`、`MovieEntity`、`TvEpisodeEntity`、`TvSeasonEntity`、`TvShowEntity`、`VideoClipEntity`

在 Media Home SDK 和 Engage SDK 中发布集群

使用 Media Home SDK，集群和实体通过单独的 API 发布

// 1. Fetch existing channels
List<PreviewChannel> channels = PreviewChannelHelper.getAllChannels();

// 2. If there are no channels, publish new channels
long channelId = PreviewChannelHelper.publishChannel(builder.build());

// 3. If there are existing channels, decide whether to update channel contents
PreviewChannelHelper.updatePreviewChannel(channelId, builder.build());

// 4. Delete all programs in the channel
PreviewChannelHelper.deleteAllPreviewProgramsByChannelId(channelId);

// 5. publish new programs in the channel
PreviewChannelHelper.publishPreviewProgram(builder.build());

使用 Engage SDK，集群和实体发布合并为单个 API 调用。属于某个集群的所有实体都将与该集群一起发布。

Kotlin

RecommendationCluster.Builder()
            .addEntity(MOVIE_ENTITY)
            .addEntity(MOVIE_ENTITY)
            .addEntity(MOVIE_ENTITY)
            .setTitle("Top Picks For You")
            .build()

Java

new RecommendationCluster.Builder()
                        .addEntity(MOVIE_ENTITY)
                        .addEntity(MOVIE_ENTITY)
                        .addEntity(MOVIE_ENTITY)
                        .setTitle("Top Picks For You")
                        .build();

步骤 1：提供实体数据

SDK 已定义不同的实体来表示每种项目类型。我们支持以下用于“观看”类别的实体

MovieEntity
TvShowEntity
TvSeasonEntity
TvEpisodeEntity
LiveStreamingVideoEntity
VideoClipEntity

下表概述了每种类型的属性和要求。

`MovieEntity`

属性	要求	注释
名称	必需
海报图像	必需	至少需要一张图像，并且必须提供纵横比。（建议使用横向，但建议为不同场景提供纵向和横向图像。）请参阅图像规格以获取指导。
播放 URI	必需	指向提供程序应用的深层链接，用于开始播放电影。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
信息页面 URI	可选	指向提供程序应用的深层链接，用于显示有关电影的详细信息。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
发行日期	必需	以毫秒为单位的纪元时间戳。
可用性	必需	AVAILABLE：内容对用户可用，无需任何其他操作。 FREE_WITH_SUBSCRIPTION：用户购买订阅后，内容可用。 PAID_CONTENT：内容需要用户购买或租赁。 PURCHASED：内容已由用户购买或租赁。
优惠价格	可选	自由文本
时长	必需	以毫秒为单位。
类型	必需	自由文本
内容分级	必需	自由文本，遵循行业标准。（示例）
下一个观看类型	条件必需	当项目位于“续播”集群中时必须提供，并且必须是以下四种类型之一 CONTINUE：用户已观看此内容超过 1 分钟。 NEW：用户已观看某些系列内容中所有可用的剧集，但新剧集已可用，并且只有一个未观看的剧集。这适用于电视剧、系列录制的足球比赛等。 NEXT：用户已观看某些系列内容中的一个或多个完整剧集，但剩余剧集超过一个，或恰好剩余一个剧集，其中最后一个剧集不是“NEW”，并且在用户开始观看系列内容之前已发布。 WATCHLIST：用户已明确选择将电影、活动或系列添加到观看列表，以手动整理他们接下来想观看的内容。
上次参与时间	条件必需	当项目位于“续播”集群中时必须提供。以毫秒为单位的纪元时间戳。
上次播放位置时间	条件必需	当项目位于“续播”集群中且 WatchNextType 为 CONTINUE 时必须提供。以毫秒为单位的纪元时间戳。

`TvShowEntity`

属性	要求	注释
名称	必需
海报图像	必需	至少需要一张图像，并且必须提供纵横比。（建议使用横向，但建议为不同场景提供纵向和横向图像。）请参阅图像规格以获取指导。
信息页面 URI	必需	指向提供程序应用的深层链接，用于显示电视剧的详细信息。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
播放 URI	可选	指向提供程序应用的深层链接，用于开始播放电视剧。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
首播日期	必需	以毫秒为单位的纪元时间戳。
最新剧集播出日期	可选	以毫秒为单位的纪元时间戳。
可用性	必需	AVAILABLE：内容对用户可用，无需任何其他操作。 FREE_WITH_SUBSCRIPTION：用户购买订阅后，内容可用。 PAID_CONTENT：内容需要用户购买或租赁。 PURCHASED：内容已由用户购买或租赁。
优惠价格	可选	自由文本
季数	必需	正整数
类型	必需	自由文本
内容分级	必需	自由文本，遵循行业标准。（示例）
下一个观看类型	条件必需	当项目位于“续播”集群中时必须提供，并且必须是以下四种类型之一 CONTINUE：用户已观看此内容超过 1 分钟。 NEW：用户已观看某些系列内容中所有可用的剧集，但新剧集已可用，并且只有一个未观看的剧集。这适用于电视剧、系列录制的足球比赛等。 NEXT：用户已观看某些系列内容中的一个或多个完整剧集，但剩余剧集超过一个，或恰好剩余一个剧集，其中最后一个剧集不是“NEW”，并且在用户开始观看系列内容之前已发布。 WATCHLIST：用户已明确选择将电影、活动或系列添加到观看列表，以手动整理他们接下来想观看的内容。
上次参与时间	条件必需	当项目位于“续播”集群中时必须提供。以毫秒为单位的纪元时间戳。
上次播放位置时间	条件必需	当项目位于“续播”集群中且 WatchNextType 为 CONTINUE 时必须提供。以毫秒为单位的纪元时间戳。

`TvSeasonEntity`

属性	要求	注释
名称	必需
海报图像	必需	至少需要一张图像，并且必须提供纵横比。（建议使用横向，但建议为不同场景提供纵向和横向图像。）请参阅图像规格以获取指导。
信息页面 URI	必需	指向提供程序应用的深层链接，用于显示电视剧季的详细信息。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
播放 URI	可选	指向提供程序应用的深层链接，用于开始播放电视剧季。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
显示季数	可选在 v1.3.1 中可用	字符串
首播日期	必需	以毫秒为单位的纪元时间戳。
最新剧集播出日期	可选	以毫秒为单位的纪元时间戳。
可用性	必需	AVAILABLE：内容对用户可用，无需任何其他操作。 FREE_WITH_SUBSCRIPTION：用户购买订阅后，内容可用。 PAID_CONTENT：内容需要用户购买或租赁。 PURCHASED：内容已由用户购买或租赁。
优惠价格	可选	自由文本
剧集数	必需	正整数
类型	必需	自由文本
内容分级	必需	自由文本，遵循行业标准。（示例）
下一个观看类型	条件必需	当项目位于“续播”集群中时必须提供，并且必须是以下四种类型之一 CONTINUE：用户已观看此内容超过 1 分钟。 NEW：用户已观看某些系列内容中所有可用的剧集，但新剧集已可用，并且只有一个未观看的剧集。这适用于电视剧、系列录制的足球比赛等。 NEXT：用户已观看某些系列内容中的一个或多个完整剧集，但剩余剧集超过一个，或恰好剩余一个剧集，其中最后一个剧集不是“NEW”，并且在用户开始观看系列内容之前已发布。 WATCHLIST：用户已明确选择将电影、活动或系列添加到观看列表，以手动整理他们接下来想观看的内容。
上次参与时间	条件必需	当项目位于“续播”集群中时必须提供。以毫秒为单位的纪元时间戳。
上次播放位置时间	条件必需	当项目位于“续播”集群中且 WatchNextType 为 CONTINUE 时必须提供。以毫秒为单位的纪元时间戳。

`TvEpisodeEntity`

属性	要求	注释
名称	必需
海报图像	必需	至少需要一张图像，并且必须提供纵横比。（建议使用横向，但建议为不同场景提供纵向和横向图像。）请参阅图像规格以获取指导。
播放 URI	必需	指向提供程序应用的深层链接，用于开始播放剧集。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
信息页面 URI	可选	指向提供程序应用的深层链接，用于显示有关电视剧剧集的详细信息。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
显示剧集数	可选在 v1.3.1 中可用	字符串
播出日期	必需	以毫秒为单位的纪元时间戳。
可用性	必需	AVAILABLE：内容对用户可用，无需任何其他操作。 FREE_WITH_SUBSCRIPTION：用户购买订阅后，内容可用。 PAID_CONTENT：内容需要用户购买或租赁。 PURCHASED：内容已由用户购买或租赁。
优惠价格	可选	自由文本
时长	必需	必须是毫秒为单位的正值。
类型	必需	自由文本
内容分级	必需	自由文本，遵循行业标准。（示例）
下一个观看类型	条件必需	当项目位于“续播”集群中时必须提供，并且必须是以下四种类型之一 CONTINUE：用户已观看此内容超过 1 分钟。 NEW：用户已观看某些系列内容中所有可用的剧集，但新剧集已可用，并且只有一个未观看的剧集。这适用于电视剧、系列录制的足球比赛等。 NEXT：用户已观看某些系列内容中的一个或多个完整剧集，但剩余剧集超过一个，或恰好剩余一个剧集，其中最后一个剧集不是“NEW”，并且在用户开始观看系列内容之前已发布。 WATCHLIST：用户已明确选择将电影、活动或系列添加到观看列表，以手动整理他们接下来想观看的内容。
上次参与时间	条件必需	当项目位于“续播”集群中时必须提供。以毫秒为单位的纪元时间戳。
上次播放位置时间	条件必需	当项目位于“续播”集群中且 WatchNextType 为 CONTINUE 时必须提供。以毫秒为单位的纪元时间戳。

`LiveStreamingVideoEntity`

属性	要求	注释
名称	必需
海报图像	必需	至少需要一张图像，并且必须提供纵横比。（建议使用横向，但建议为不同场景提供纵向和横向图像。）请参阅图像规格以获取指导。
播放 URI	必需	指向提供程序应用的深层链接，用于开始播放视频。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
广播公司	必需	自由文本
开始时间	可选	以毫秒为单位的纪元时间戳。
结束时间	可选	以毫秒为单位的纪元时间戳。
观看次数	可选	自由文本，必须本地化。
下一个观看类型	条件必需	当项目位于“续播”集群中时必须提供，并且必须是以下四种类型之一 CONTINUE：用户已观看此内容超过 1 分钟。 NEW：用户已观看某些系列内容中所有可用的剧集，但新剧集已可用，并且只有一个未观看的剧集。这适用于电视剧、系列录制的足球比赛等。 NEXT：用户已观看某些系列内容中的一个或多个完整剧集，但剩余剧集超过一个，或恰好剩余一个剧集，其中最后一个剧集不是“NEW”，并且在用户开始观看系列内容之前已发布。 WATCHLIST：用户已明确选择将电影、活动或系列添加到观看列表，以手动整理他们接下来想观看的内容。
上次参与时间	条件必需	当项目位于“续播”集群中时必须提供。以毫秒为单位的纪元时间戳。
上次播放位置时间	条件必需	当项目位于“续播”集群中且 WatchNextType 为 CONTINUE 时必须提供。以毫秒为单位的纪元时间戳。

`VideoClipEntity`

VideoClipEntity 对象表示来自社交媒体（如 TikTok 或 YouTube）的视频实体。

属性	要求	注释
名称	必需
海报图像	必需	至少需要一张图像，并且必须提供纵横比。（建议使用横向，但建议为不同场景提供纵向和横向图像。）请参阅图像规格以获取指导。
播放 URI	必需	指向提供程序应用的深层链接，用于开始播放视频。注意：您可以使用深层链接进行归因。请参阅此常见问题解答
创建时间	必需	以毫秒为单位的纪元时间戳。
时长	必需	必须是毫秒为单位的正值。
创建者	必需	自由文本
创建者图像	可选	创建者头像的图像
观看次数	可选	自由文本，必须本地化。
下一个观看类型	条件必需	当项目位于“续播”集群中时必须提供，并且必须是以下四种类型之一 CONTINUE：用户已观看此内容超过 1 分钟。 NEW：用户已观看某些系列内容中所有可用的剧集，但新剧集已可用，并且只有一个未观看的剧集。这适用于电视剧、系列录制的足球比赛等。 NEXT：用户已观看某些系列内容中的一个或多个完整剧集，但剩余剧集超过一个，或恰好剩余一个剧集，其中最后一个剧集不是“NEW”，并且在用户开始观看系列内容之前已发布。 WATCHLIST：用户已明确选择将电影、活动或系列添加到观看列表，以手动整理他们接下来想观看的内容。
上次参与时间	条件必需	当项目位于“续播”集群中时必须提供。以毫秒为单位的纪元时间戳。
上次播放位置时间	条件必需	当项目位于“续播”集群中且 WatchNextType 为 CONTINUE 时必须提供。以毫秒为单位的纪元时间戳。

图像规格

以下部分列出了图像资产的必要规格

文件格式

PNG、JPG、静态 GIF、WebP

最大文件大小

5120 KB

其他建议

**图像安全区域：**将您的重要内容放在图像的中心 80%。

示例

Kotlin

var movie = MovieEntity.Builder()
    .setName("Avengers")
    .addPosterImage(Image.Builder()
                          .setImageUri(Uri.parse("http://www.x.com/image.png"))
                          .setImageHeightInPixel(960)
                          .setImageWidthInPixel(408)
                          .build())
    .setPlayBackUri(Uri.parse("http://tv.com/playback/1"))
    .setReleaseDateEpochMillis(1633032895L)
    .setAvailability(ContentAvailability.AVAILABILITY_AVAILABLE)
    .setDurationMillis(12345678L)
    .addGenre("action")
    .addContentRating("R")
    .setWatchNextType(WatchNextType.TYPE_NEW)
    .setLastEngagementTimeMillis(1664568895L)
    .build()

Java

MovieEntity movie = new MovieEntity.Builder()
                  .setName("Avengers")
                  .addPosterImage(
                      new Image.Builder()
                          .setImageUri(Uri.parse("http://www.x.com/image.png"))
                          .setImageHeightInPixel(960)
                          .setImageWidthInPixel(408)
                          .build())
                  .setPlayBackUri(Uri.parse("http://tv.com/playback/1"))
                  .setReleaseDateEpochMillis(1633032895L)
                  .setAvailability(ContentAvailability.AVAILABILITY_AVAILABLE)
                  .setDurationMillis(12345678L)
                  .addGenre("action")
                  .addContentRating("R")
                  .setWatchNextType(WatchNextType.TYPE_NEW)
                  .setLastEngagementTimeMillis(1664568895L)
                  .build();

步骤 2：提供集群数据

建议在后台执行内容发布作业（例如，使用WorkManager）并定期或基于事件（例如，每次用户打开应用或用户将某些内容添加到购物车时）进行计划。

AppEngagePublishClient 负责发布集群。客户端提供以下 API

isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
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 对象列表。

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

当服务收到请求时，将在一个事务中执行以下操作

删除开发合作伙伴的现有 RecommendationCluster 数据。
解析请求中的数据并将其存储在更新的推荐集群中。

如果发生错误，则会拒绝整个请求并保持现有状态。

`publishFeaturedCluster`

此 API 用于发布 FeaturedCluster 对象列表。

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

当服务收到请求时，将在一个事务中执行以下操作

删除开发合作伙伴的现有 FeaturedCluster 数据。
解析请求中的数据并将其存储在更新的特色集群中。

如果发生错误，则会拒绝整个请求并保持现有状态。

`publishContinuationCluster`

此 API 用于发布 ContinuationCluster 对象。

Kotlin

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

当服务收到请求时，将在一个事务中执行以下操作

删除开发合作伙伴的现有 ContinuationCluster 数据。
解析请求中的数据并将其存储在更新的续播集群中。

如果发生错误，则会拒绝整个请求并保持现有状态。

`publishUserAccountManagementRequest`

此 API 用于发布登录卡片。登录操作会将用户引导至应用的登录页面，以便应用可以发布内容（或提供更个性化的内容）

以下元数据是登录卡片的一部分 -

属性	要求	描述
操作 URI	必需	指向操作的深层链接（即导航到应用登录页面）
图像	可选 - 如果未提供，则必须提供标题	卡片上显示的图像 16x9 纵横比的图像，分辨率为 1264x712
标题	可选 - 如果未提供，则必须提供图像	卡片上的标题
操作文本	可选	在 CTA 上显示的文本（即登录）
副标题	可选	卡片上的可选副标题

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 数据。
解析请求中的数据并将其存储在更新的用户帐户管理集群中。

如果发生错误，则会拒绝整个请求并保持现有状态。

`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

如果由于用户未登录而未发布内容，Google 将建议发布登录卡片。如果出于任何原因提供商无法发布登录卡片，则我们建议使用状态代码**NOT_PUBLISHED_REQUIRES_SIGN_IN**调用**updatePublishStatus** API

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

当服务收到请求时，它会从推荐集群中删除现有数据。如果发生错误，则会拒绝整个请求并保持现有状态。

`deleteFeaturedCluster`

此 API 用于删除特色集群的内容。

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

当服务收到请求时，它会从特色集群中删除现有数据。如果发生错误，则会拒绝整个请求并保持现有状态。

`deleteContinuationCluster`

此 API 用于删除续播集群的内容。

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

当服务收到请求时，它会从续播集群中删除现有数据。如果发生错误，则会拒绝整个请求并保持现有状态。

`deleteUserManagementCluster`

此 API 用于删除用户帐户管理集群的内容。

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

当服务收到请求时，它会从用户帐户管理集群中删除现有数据。如果发生错误，则会拒绝整个请求并保持现有状态。

`deleteClusters`

此 API 用于删除给定集群类型的内容。

Kotlin

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

Java

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

当服务收到请求时，它会删除与指定集群类型匹配的所有集群中的现有数据。客户端可以选择传递一个或多个集群类型。如果发生错误，则会拒绝整个请求并保持现有状态。

错误处理

强烈建议侦听发布 API 的任务结果，以便可以采取后续操作来恢复并重新提交成功的任务。

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

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 返回，其中包含错误代码作为原因。

错误代码	错误名称	注释
`1`	`SERVICE_NOT_FOUND`	给定设备上没有可用服务。
`2`	`SERVICE_NOT_AVAILABLE`	给定设备上服务可用，但在调用时不可用（例如，它被明确禁用）。
`3`	`SERVICE_CALL_EXECUTION_FAILURE`	由于线程问题导致任务执行失败。在这种情况下，可以重试。
`4`	`SERVICE_CALL_PERMISSION_DENIED`	调用方无权进行服务调用。
`5`	`SERVICE_CALL_INVALID_ARGUMENT`	请求包含无效数据（例如，超过允许的集群数量）。
`6`	`SERVICE_CALL_INTERNAL`	服务端出现错误。
`7`	`SERVICE_CALL_RESOURCE_EXHAUSTED`	服务调用过于频繁。

步骤 3：处理广播意图

除了通过作业进行发布内容 API 调用外，还需要设置一个BroadcastReceiver 来接收内容发布请求。

广播意图的主要目的是重新激活应用并强制数据同步。广播意图并非设计为非常频繁地发送。仅当 Engage 服务确定内容可能已过期（例如，一周前）时才会触发。这样，即使应用程序长时间未执行，也可以更有把握地确保用户获得最新的内容体验。

必须通过以下两种方式设置BroadcastReceiver

使用Context.registerReceiver()动态注册BroadcastReceiver类的实例。这使得仍在内存中运行的应用程序能够进行通信。

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION 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))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION))
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION 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));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));

}

在您的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>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

服务发送以下意图

com.google.android.engage.action.PUBLISH_RECOMMENDATION 建议在收到此意图时启动publishRecommendationClusters调用。
com.google.android.engage.action.PUBLISH_FEATURED 建议在收到此意图时启动publishFeaturedCluster调用。
com.google.android.engage.action.PUBLISH_CONTINUATION 建议在收到此意图时启动publishContinuationCluster调用。

集成工作流程

有关完成集成后验证集成的分步指南，请参阅Engage 开发人员集成工作流程。

常见问题

有关常见问题，请参阅Engage SDK 常见问题解答。

联系方式

如果您在集成过程中有任何疑问，请联系[email protected]。

后续步骤

完成此集成后，您的后续步骤如下

发送电子邮件至[email protected]，并附上您已准备好在 Google 进行测试的集成 APK。
Google 会进行验证并在内部审查，以确保集成按预期工作。如果需要更改，Google 会与您联系并提供必要的详细信息。
测试完成后且无需任何更改时，Google 会与您联系，通知您可以开始将更新的集成 APK 发布到 Play 商店。
Google 确认您已将更新的 APK 发布到 Play 商店后，您的**推荐**、**特色**和**续播**集群可能会发布并对用户可见。