此页面由 Cloud Translation API 翻译。

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

Google 将打造一种设备端 surface，该 surface 可按行业整理用户的应用，并且支持全新的沉浸式体验，使用户能够以个性化的方式消费和发现应用内容。这种全屏体验可为开发者合作伙伴提供新的机会，使其能够通过自己的应用以外的专用渠道展示最优质的富媒体内容。本指南包含面向开发者合作伙伴的说明，介绍了如何使用 Engage SDK 填充这个新的 surface 区域，以便集成旅游和活动内容。

集成详情

术语

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

推荐集群用于显示来自单个开发者合作伙伴的个性化旅行和活动建议。这些推荐可以针对用户进行个性化设置，也可以泛化（例如，热门商品）。您可以使用这些数据卡片显示文章、活动、住宿或地图注点建议。
- 推荐集群可以由 ArticleEntity、EventEntity、LodgingEntity、PointOfInterestEntity 或 StoreEntity 列表组成，但不能由不同实体类型混合组成。
您的推荐将采用如下结构：
- 推荐集群：一个界面视图，其中包含来自同一开发者合作伙伴的一组推荐。
- 实体：代表集群中单个内容的对象。此集成提供了一些将使用推荐集群显示的实体：
  - ArticleEntity：ArticleEntity 表示与旅行和活动相关的基于文本的内容推荐。它可用于文章、博文、营销内容、新闻摘要等。
    
    图 1：显示推荐集群内单个 ArticleEntity 的界面。
  - EventEntity：EventEntity 表示未来发生的事件。活动开始时间是一项需要传达给用户的重要信息。
    
    图 2：显示推荐集群中单个 EventEntity 的界面。
  - LodgingEntity：LodgingEntity 表示住宿，例如酒店、公寓、民宿（短期和长期出租）。
    
    图 3：显示推荐集群内的单个 LodgingEntity 的界面。
  - StoreEntity：StoreEntity 代表商店、餐厅、咖啡馆等。它会突出显示餐厅或商店是需要传达给用户的关键信息的内容。
    
    图 4：显示推荐集群内的单个 StoreEntity 的界面。
  - PointOfInterestEntity：PointOfInterestEntity 表示地图注点，例如加油站、活动场地、主题公园、博物馆、旅游景点、远足小路等。它会突出显示需要向用户传达的位置信息至关重要的内容。它不应用于住宿、商店或餐饮场所。
    
    图 5：显示推荐集群内单个 PointOfInterestEntity 的界面。
接续集群用于在单个界面分组中显示来自多个开发者合作伙伴、最近与用户互动过的内容。每个开发者合作伙伴最多可以在接续集群中广播 10 个实体。

您的接续内容可以采用以下结构：
- ArticleEntity：ArticleEntity 表示与旅行和活动相关的内容推荐。此实体可用于表示未看完的新闻报道或其他用户想要从其离开时继续观看的内容。例如：有关旅游目的地或活动的新闻摘要、博文摘要。
  
  图 6. 显示接续集群内单个 ArticleEntity 的界面。
- RestaurantReservationEntity：RestaurantReservationEntity 表示餐厅或咖啡馆的预订，可帮助用户跟踪即将到来或正在进行的餐厅预订。
  
  图 7. 显示接续集群内单个 RestaurantReservationEntity 的界面。
- EventReservationEntity：EventReservationEntity 表示活动预约，可帮助用户跟踪即将举办或正在进行的活动预约。事件可能包括但不限于以下内容：
  - 体育赛事，例如预订足球赛
  - 游戏活动，例如电子竞技赛事的预订
  - 娱乐活动，例如电影院电影预订、音乐会、剧院、签书会
  - 旅行或地图注点预订，例如导游、博物馆门票
  - 社交活动/讲座/会议预订
  - 教育 / 培训课程预订
  图 8. 显示接续集群内单个 EventReservationEntity 的界面。
- LodgingReservationEntity：LodgingEntityReservation 表示旅游住宿预订，可帮助用户跟踪即将开始或正在进行的酒店或民宿预订。
  
  图 9. 显示接续集群内单个 LodgingReservationEntity 的界面。
- TransportationReservationEntity：TransportationReservationEntity 表示任何方式的交通预订，可帮助用户跟踪即将开始或正在进行的航班、渡轮、火车、公交车、网约车或游轮的预订。
  
  图 10. 显示接续集群内单个 TransportationReservationEntity 的界面。
- VehicleRentalReservationEntity：VehicleRentalReservationEntity 代表租车预订，可帮助用户跟踪即将到来或正在进行的租车预订。
  
  图 11. 显示接续集群内单个 VehicleRentalReservationEntity 的界面。
精选集群用于在一个界面分组中展示来自多个开发者合作伙伴的精选实体。精选集群只有一个，并将显示在界面顶部附近，其展示位置的优先级高于所有推荐集群。每个开发者合作伙伴最多可以在精选集群中广播 10 个实体。
- GenericFeaturedEntity：GenericFeaturedEntity 与推荐内容不同，精选内容应用于开发者提供的单个热门内容，并且应代表对用户而言既有趣又相关的最重要的单个内容。
  
  图 12：显示包含 GenericFeaturedEntity 列表的 FeaturedCluster 的界面

准备工作

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

摘要

设计的前提是已实现了绑定服务。

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

集群类型	集群限制	集群中的实体数下限	集群中的实体数上限
推荐集群	最多 5 个	至少 5 个	最多 25 个（`ArticleEntity`、`EventEntity`、`LodgingEntity`、`StoreEntity` 或 `PointOfInterestEntity`）
接续集群	最多 1 个	至少 1 个	最多 10 个（`ArticleEntity`、`RestaurantReservationEntity`、`EventReservationEntity`、`LodgingReservationEntity`、`TransportationReservationEntity` 或 `VehicleRentalReservationEntity`）
精选集群	最多 1 个	至少 1 个	最多 10 个 (`GenericFeaturedEntity`)

第 1 步：提供实体数据

SDK 定义了不同的实体来代表每种内容类型。对于“旅游与活动”类别，我们支持下列实体：

GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
VehicleRentalReservationEntity

下面的图表列出了每种类型的可用属性和相关要求。

`GenericFeaturedEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
海报图片	必需	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：如果提供了标记，请确保图片的顶部和底部安全间距均为 24 dp	如需相关指导，请参阅图片规范。
标题	可选	实体的标题。	自由文本建议的文本大小：50 个字符
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
徽章	可选	每个徽章可以是自由文本（最多 15 个字符）或小图片。在图片/视频上提供特殊的用户体验处理，例如在图片上叠加徽章 “实时更新” 文章阅读时长
徽章 - 文本	可选	徽章的标题注意：必须为此标志提供文字或图片	自由文本建议的文本大小：最多 15 个字符
徽章 - 图片	可选	小图片对用户体验的特殊处理，例如，作为图片/视频缩略图上的标记叠加层。注意：徽章必须包含文本或图片	如需相关指导，请参阅图片规范。
内容分类	可选	说明实体中内容的类别。	枚举列表如需指导，请参阅“内容类别”部分。

`ArticleEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	自由文本建议的文本大小：最多 50 个字符
海报图片	可选	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：强烈建议使用图片。如果提供了标记，请确保图片的顶部和底部安全间距均为 24 dp	如需相关指导，请参阅图片规范。
来源 - 标题	可选	作者、组织或报告者的姓名	自由文本建议的文本大小：少于 25 个字符
来源 - 图片	可选	来源的图片，例如作者、组织、记者	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
徽章	可选	每个徽章可以是自由文本（最多 15 个字符）或小图片。对图片/视频进行特殊用户体验处理，例如，作为图片上的标记叠加层 “实时动态” 文章阅读时长
徽章 - 文本	可选	徽章的标题注意：必须为此标志提供文字或图片	自由文本建议的文本大小：最多 15 个字符
徽章 - 图片	可选	小图片对用户体验的特殊处理，例如，作为图片/视频缩略图上的标记叠加层。注意：徽章必须包含文本或图片	如需相关指导，请参阅图片规范。
内容发布时间	可选	这是内容在应用中发布/更新的时间（以从公元纪年开始计算的毫秒数表示）。	纪元时间戳（以毫秒为单位）
上次互动时长	必需（有条件）	用户上次与此实体互动时的时间戳（以自纪元以来经历的毫秒数表示）。注意：如果此实体属于接续集群，则此字段是必需的。	纪元时间戳（以毫秒为单位）
进度百分比	必需（有条件）	用户到目前为止消费的完整内容所占的百分比。注意：如果此实体属于接续集群，则此字段是必需的。	一个介于 0 到 100（包括这两个数值）之间的整数值。
内容分类	可选	说明实体中内容的类别。	枚举列表如需相关指导，请参阅“内容类别”部分。

`EventEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	字符串建议的文本大小：最多 50 个字符
开始时间	必需	事件预计开始的公元纪年时间戳。注意：此值以毫秒为单位。	纪元时间戳（以毫秒为单位）
事件模式	必需	用于指明活动是线上、线下还是二者兼有的字段。	枚举值：VIRTUAL、IN_PERSON 或 HYBRID
海报图片	必需	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：强烈建议提供图片。如果提供徽章，请确保图片顶部和底部的安全区域为 24 dps	如需相关指导，请参阅图片规范。
位置 - 国家/地区	必需（有条件）	活动进行的国家/地区。注意：对于 IN_PERSON 或 HYBRID 类型的事件，此参数为必需参数	自由文本建议的文本大小：最多 20 个字符
地点 - 城市	必需（有条件）	活动的举办城市。注意：这对于 IN_PERSON 或 HYBRID 事件而言是必需的	自由文本建议的文本大小：最多 20 个字符
位置 - 显示地址	必需（有条件）	应向用户显示的活动的举办地址或场地名称。注意：对于 IN_PERSON 或 HYBRID 类型的事件，此参数为必需参数	自由文本建议的文本大小：最多 20 个字符
位置 - 街道地址	可选	举办活动的地点的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
营业地点 - 州	可选	活动举办地所在的州或省（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
地理位置 - 邮政编码	可选	活动举办地点的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
位置 - 社区	可选	活动举办的社区（如果适用）。	自由文本建议的文本大小：最多 20 个字符
结束时间	可选	事件预计结束的公元纪年时间戳。注意：此值以毫秒为单位。	纪元时间戳（以毫秒为单位）
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
徽章	可选	每个徽章可以是自由文本（最多 15 个字符）或小图片。
徽章 - 文本	可选	徽章的标题注意：必须为此标志提供文字或图片	自由文本建议的文本大小：最多 15 个字符
徽章 - 图片	可选	小图片对用户体验的特殊处理，例如，作为图片/视频缩略图上的标记叠加层。注意：必须为此标志提供文字或图片	如需相关指导，请参阅图片规范。
价格 - 当前价格	在特定条件下必需	活动门票/通行证的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	活动门票/卡的原始价格。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
内容分类	可选	说明实体中内容的类别。	符合条件的枚举列表 TYPE_MOVIES_AND_TV_SHOWS（示例 - 电影院） TYPE_DIGITAL_GAMES（示例 - 电子竞技） TYPE_MUSIC（示例 - 音乐会） TYPE_TRAVEL_AND_LOCAL（示例：导览、节日） TYPE_HEALTH_AND_FITENESS（示例 - 瑜伽课） TYPE_EDUCATION（示例 - 课程） TYPE_SPORTS（示例 - 橄榄球游戏） TYPE_DATING（示例 - 相亲相友）如需指导，请参阅“内容类别”部分。

`LodgingEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	字符串建议的文本大小：最多 50 个字符
海报图片	必需	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：如果提供了标志，请确保图片的顶部和底部安全间距均为 24 dp	如需相关指导，请参阅图片规范。
地理位置 - 国家/地区	必需	住宿地点所在的国家/地区。	自由文本建议的文本大小：最多 20 个字符
地点 - 城市	必需	住宿地点所在的城市。	自由文本建议的文本大小：最多 20 个字符
位置 - 显示地址	必需	将向用户显示的住宿地址。	自由文本建议的文本大小：最多 20 个字符
位置 - 街道地址	可选	住宿的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
营业地点 - 州	可选	住宿所在的州或省（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
地理位置 - 邮政编码	可选	住宿的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
位置 - 社区	可选	住宿的所在社区（如果适用）。	自由文本建议的文本大小：最多 20 个字符
徽章	可选	每个徽章可以是自由文本（最多 15 个字符）或小图片。
徽章 - 文本	可选	徽章的标题注意：必须为此标志提供文字或图片	自由文本建议的文本大小：最多 15 个字符
徽章 - 图片	可选	小图片对用户体验的特殊处理，例如，作为图片/视频缩略图上的标记叠加层。注意：徽章必须包含文本或图片	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
AvailabilityTimeWindow - 开始时间	可选	住宿预计开放/可用的时间戳（以从公元纪年开始计算的毫秒数表示）。	纪元时间戳（以毫秒为单位）
AvailabilityTimeWindow - 结束时间	可选	公元纪年时间戳（以毫秒为单位），表示住宿预计开放/可供预订的时间。	纪元时间戳（以毫秒为单位）
评分 - 最大值	可选	评分量表的最大值。如果同时提供当前评分值，则必须提供。	数值 >= 0.0
评分 - 当前值	可选	评分量表的当前值。如果同时提供最大评分值，则必须提供。	数值 >= 0.0
评分 - 计数	可选	酒店的评分数量。注意：如果您的应用想要控制向用户显示此信息的方式，请提供此字段。提供可向用户显示的简洁字符串。例如，如果计数为 1,000,000，请考虑使用 1M 等缩写形式，以免在较小的显示大小下被截断。	字符串
评分 - 计数值	可选	住宿的评分数量。注意：如果您不想自行处理显示缩写逻辑，请提供此字段。如果“计数”和“计数值”均存在，我们将使用“计数”向用户显示	长
价格 - CurrentPrice	在特定条件下必需	住宿的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	住宿的原始价格，在界面中带有删除线。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）

`StoreEntity`

StoreEntity 对象代表开发者合作伙伴想要发布的单个商店，例如餐馆或杂货店。

属性	要求	说明	格式
海报图片	必需	必须提供至少一张图片。	如需相关指导，请参阅图片规范。
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此常见问题解答	URI
标题	可选	商店的名称。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
位置	可选	商店的位置信息。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
宣传信息	可选	用于展示商店的促销、活动或最新动态的宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
宣传信息附属细则	可选	宣传信息的附属细则文本。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
说明	可选	商店的说明。	自由文本建议的文本大小：少于 90 个字符（如果文本过长，可能会显示省略号）
评分 - 最大值	可选	评分量表的最大值。如果同时提供当前评分值，则必须提供。	数值 >= 0.0
评分 - 当前值	可选	评分量表的当前值。如果同时提供最大评分值，则必须提供。	数值 >= 0.0
评分 - 计数	可选	酒店的评分数量。注意：如果您的应用想要控制向用户显示此信息的方式，请提供此字段。提供可向用户显示的简洁字符串。例如，如果计数为 1,000,000，请考虑使用 1M 等缩写形式，以免在较小的显示大小下被截断。	字符串
评分 - 计数值	可选	住宿的评分数量。注意：如果您不想自行处理显示缩写逻辑，请提供此字段。如果“计数”和“计数值”均存在，我们将使用“计数”向用户显示	长

`PointOfInterestEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	字符串建议的文本大小：最多 50 个字符
海报图片	必需	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：强烈建议提供图片。如果提供徽章，请确保图片顶部和底部的安全区域均为 24 dps	如需相关指导，请参阅图片规范。
位置 - 国家/地区	必需	地图注点所在的国家/地区。	自由文本建议的文本大小：最多 20 个字符
地点 - 城市	必需	地图注点所在的城市。	自由文本建议的文本大小：最多 20 个字符
位置 - 显示地址	必需	将向用户显示的地图注点的地址。	自由文本建议的文本大小：最多 20 个字符
位置 - 街道地址	可选	地图注点的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
营业地点 - 州	可选	地图注点所在的州或省（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
地理位置 - 邮政编码	可选	地图注点的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
位置 - 社区	可选	地图注点所在的社区（如果适用）。	自由文本建议的文本大小：最多 20 个字符
AvailabilityTimeWindow - 开始时间	可选	地图注点预计开放/可用的时间戳（以从公元纪年开始计算的毫秒数表示）。	纪元时间戳（以毫秒为单位）
AvailabilityTimeWindow - 结束时间	可选	公元纪年时间戳（以毫秒为单位），表示相应地图注点预计会保持开放/可用状态的时长。	纪元时间戳（以毫秒为单位）
徽章	可选	每个徽章可以是自由文本（最多 15 个字符）或小图片。
徽章 - 文本	可选	徽章的标题注意：必须为此标志提供文字或图片	自由文本建议的文本大小：最多 15 个字符
徽章 - 图片	可选	小图片对用户体验的特殊处理，例如，作为图片/视频缩略图上的标记叠加层。注意：徽章必须包含文本或图片	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每条字幕建议的文本大小：最多 50 个字符
评分 - 最大值	可选	评分量表的最大值。如果同时提供当前评分值，则必须提供。	数值 >= 0.0
评分 - 当前值	可选	评分量表的当前值。如果同时提供最大评分值，则必须提供。	数值 >= 0.0
评分 - 计数	可选	地图注点的评分计数。注意：如果您的应用想要控制向用户显示此信息的方式，请提供此字段。提供可向用户显示的简洁字符串。例如，如果计数为 1,000,000，请考虑使用 1M 等缩写形式，以免在较小的显示大小下被截断。	字符串
评分 - 计数值	可选	地图注点的评分数量。注意：如果您不想自行处理显示缩写逻辑，请提供此字段。如果“计数”和“计数值”均存在，我们将使用“计数”向用户显示	长
价格 - CurrentPrice	在特定条件下必需	相应地图注点的票券/门票的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	地图注点的门票/入场券的原始价格。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
内容分类	可选	说明实体中内容的类别。	符合条件的枚举列表 TYPE_TRAVEL_AND_LOCAL TYPE_MOVIES_AND_TV_SHOWS（示例 - 剧院） TYPE_MEDical（示例 - 医院） TYPE_EDUCATION（示例 - 学校） TYPE_SPORTS（示例：体育馆）如需指导，请参阅“内容类别”部分。

`RestaurantReservationEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	字符串建议的文本大小：最多 50 个字符
预订开始时间	必需	预留预计将开始时的纪元时间戳（以毫秒为单位）。	纪元时间戳（以毫秒为单位）
位置 - 国家/地区	必需	餐馆开业的国家/地区。	自由文本建议的文本大小：最多 20 个字符
地点 - 城市	必需	餐厅所在的城市。	自由文本建议的文本大小：最多 20 个字符
位置 - 显示地址	必需	将向用户显示的餐厅地址。	自由文本建议的文本大小：最多 20 个字符
位置 - 街道地址	可选	餐厅的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
营业地点 - 州	可选	餐馆所在的州或省（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
地理位置 - 邮政编码	可选	餐馆的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
位置 - 社区	可选	餐厅所在的社区（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
海报图片	可选	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
表大小	可选	预订群组中的人数	整数 > 0

`EventReservationEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	字符串建议的文本大小：最多 50 个字符
开始时间	必需	事件预计开始的公元纪年时间戳。注意：此值以毫秒为单位。	纪元时间戳（以毫秒为单位）
事件模式	必需	用于指明活动是线上、线下还是二者兼有的字段。	枚举：VIRTUAL、IN_PERSON 或 HYBRID
位置 - 国家/地区	必需（有条件）	活动进行的国家/地区。注意：对于 IN_PERSON 或 HYBRID 类型的事件，此参数为必需参数	自由文本建议的文本大小：最多 20 个字符
地点 - 城市	必需（有条件）	活动的举办城市。注意：这对于 IN_PERSON 或 HYBRID 事件而言是必需的	自由文本建议的文本大小：最多 20 个字符
位置 - 显示地址	必需（有条件）	应向用户显示的活动的举办地址或场地名称。注意：对于 IN_PERSON 或 HYBRID 类型的事件，此参数为必需参数	自由文本建议的文本大小：最多 20 个字符
位置 - 街道地址	可选	举办活动的地点的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
营业地点 - 州	可选	活动举办地所在的州或省（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
地理位置 - 邮政编码	可选	活动举办地点的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
位置 - 社区	可选	活动举办的社区（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
海报图片	可选	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：强烈建议提供图片。如果提供徽章，请确保图片顶部和底部的安全区域为 24 dps	如需相关指导，请参阅图片规范。
结束时间	可选	事件预计结束的公元纪年时间戳。注意：此值以毫秒为单位。	纪元时间戳（以毫秒为单位）
服务提供商 - 名称	可选	服务提供商的名称。注意：服务提供商必须提供文本或图片。	自由文本。例如活动主办方/巡回演出的名称
服务提供商 - 图片	可选	服务提供商的徽标/图片。注意：服务提供商必须提供文本或图片。	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
徽章	可选	每个徽章可以是自由文本（最多 15 个字符）或小图片。
徽章 - 文本	可选	徽章的标题注意：必须为此标志提供文字或图片	自由文本建议的文本大小：最多 15 个字符
徽章 - 图片	可选	小图片对用户体验的特殊处理，例如，作为图片/视频缩略图上的标记叠加层。注意：徽章必须包含文本或图片	如需相关指导，请参阅图片规范。
预留 ID	可选	活动预订的预订 ID。	自由文本
价格 - CurrentPrice	在特定条件下必需	活动门票/通行证的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	活动门票/卡的原始价格。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
评分 - 最大值	可选	评分量表的最大值。如果同时提供当前评分值，则必须提供。	数值 >= 0.0
评分 - 当前值	可选	评分量表的当前值。如果同时提供最大评分值，则必须提供。	数值 >= 0.0
评分 - 计数	可选	活动评分的计数。注意：如果您的应用想要控制向用户显示此信息的方式，请提供此字段。提供可向用户显示的简洁字符串。例如，如果计数为 1,000,000，请考虑使用 1M 之类的缩写，以便在屏幕尺寸较小的设备上不会被截断。	字符串
评分 - 计数值	可选	活动评分的计数。注意：如果您不想自行处理显示缩写逻辑，请提供此字段。如果“计数”和“计数值”都存在，我们将使用“计数”向用户显示	长
内容分类	可选	说明实体中内容的类别。	符合条件的枚举列表 TYPE_MOVIES_AND_TV_SHOWS（示例 - 电影院） TYPE_DIGITAL_GAMES（示例 - 电子竞技） TYPE_MUSIC（示例 - 音乐会） TYPE_TRAVEL_AND_LOCAL（示例：导览、节日） TYPE_HEALTH_AND_FITENESS（示例 - 瑜伽课） TYPE_EDUCATION（示例 - 课程） TYPE_SPORTS（示例 - 橄榄球游戏） TYPE_DATING（示例 - 相亲相友）如需相关指导，请参阅“内容类别”部分。

`LodgingReservationEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	自由文本。例如，“12 月 12 日入住” 建议的文本大小：最多 50 个字符
入住时间	必需	纪元时间戳（以毫秒为单位），表示预留的签入时间。	纪元时间戳（以毫秒为单位）
退房时间	必需	纪元时间戳（以毫秒为单位），表示预订的退房时间。	纪元时间戳（以毫秒为单位）
位置 - 国家/地区	必需	住宿所在的国家/地区。	自由文本建议的文本大小：最多 20 个字符
地点 - 城市	必需	住宿所在的城市。	自由文本建议的文本大小：最多 20 个字符
位置 - 显示地址	必需	将向用户显示的住宿地址。	自由文本建议的文本大小：最多 20 个字符
位置 - 街道地址	可选	住宿的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
营业地点 - 州	可选	住宿所在的州或省（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
地理位置 - 邮政编码	可选	住宿的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
位置 - 社区	可选	住宿的所在社区（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
海报图片	可选	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9 注意：如果提供了标志，请确保图片顶部和底部的安全间距为 24 dp	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每条字幕建议的文本大小：最多 50 个字符
预留 ID	可选	住宿预订的预订 ID。	自由文本
评分 - 最大值	可选	评分量表的最大值。如果同时提供当前评分值，则必须提供。	数值 >= 0.0
评分 - 当前值	可选	评分量表的当前值。如果同时提供最大评分值，则必须提供。	数值 >= 0.0
评分 - 计数	可选	酒店的评分数量。注意：如果您的应用想要控制向用户显示此信息的方式，请提供此字段。提供可向用户显示的简洁字符串。例如，如果计数为 1,000,000，请考虑使用 1M 等缩写形式，以免在较小的显示大小下被截断。	字符串
评分 - 计数值	可选	住宿的评分数量。注意：如果您不想自行处理显示缩写逻辑，请提供此字段。如果“计数”和“计数值”均存在，我们将使用“计数”向用户显示	长
价格 - CurrentPrice	在特定条件下必需	住宿的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	住宿的原始价格，在界面中带有删除线。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）

`TransportationReservationEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	自由文本。例如：“SFO to SAN” 建议的文本大小：最多 50 个字符
交通方式	必需	预订的交通方式/类型。	枚举值：FLIGHT、TRAIN、BUS 或 FERRY
出发时间	必需	表示出发时间的纪元时间戳（以毫秒为单位）。	纪元时间戳（以毫秒为单位）
到达时间	必需	表示到达时间的纪元时间戳（以毫秒为单位）。	纪元时间戳（以毫秒为单位）
出发地点 - 国家/地区	可选	出发国家/地区。	自由文本建议的文本大小：最多 20 个字符
出发地点 - 城市	可选	出发城市。	自由文本建议的文本大小：最多 20 个字符
出发地点 - 显示地址	可选	将向用户显示的出发地点。	自由文本建议的文本大小：最多 20 个字符
出发地点 - 街道地址	可选	出发地点的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
出发地点 - 州/省/直辖市	可选	出发地点所在的州或省/直辖市/自治区（如果有）。	自由文本建议的文本大小：最多 20 个字符
出发地 - 邮政编码	可选	出发地点的邮政编码（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
出发地点 - 街区	可选	出发地点所在的社区（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
到达地点 - 国家/地区	可选	抵达时所在的国家/地区。	自由文本建议的文本大小：最多 20 个字符
到达地点 - 城市	可选	到达城市。	自由文本建议的文本大小：最多 20 个字符
到达地点 - 显示地址	可选	将向用户显示的到达地点。	自由文本建议的文本大小：最多 20 个字符
到达地点 - 街道地址	可选	目的地的街道地址（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
到达地点 - 州/省/自治区/直辖市	可选	到达地点所在的州或省（如适用）。	自由文本建议的文本大小：最多 20 个字符
到达地点 - 邮政编码	可选	目的地的邮政编码（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
到达地点 - 社区	可选	到达地点所在的社区（如果适用）。	自由文本建议的文本大小：最多 20 个字符
服务提供商 - 名称	可选	服务提供商的名称。注意：服务提供商必须提供文本或图片。	自由文本。例如，航空公司名称
服务提供商 - 图片	可选	服务提供商的徽标/图片。注意：服务提供商必须提供文本或图片。	如需相关指导，请参阅图片规范。
海报图片	可选	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每条字幕建议的文本大小：最多 50 个字符
预留 ID	可选	交通预订的预订 ID。	自由文本
价格 - CurrentPrice	在特定条件下必需	预订的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	预订的原始价格，在界面中带有删除线。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）
运输编号	必需	航班号、公交车号、火车车次或渡轮/游轮编号。	自由文本
登机时间	必需	表示预订登机时间的纪元时间戳（如果适用）	纪元时间戳（以毫秒为单位）

`VehicleRentalReservationEntity`

属性	要求	说明	格式
操作 URI	必需	指向提供商应用中实体的深层链接。注意：您可以使用深层链接进行归因。请参阅此处的常见问题解答	URI
标题	必需	实体的标题。	自由文本。例如，“Avis Union Square SF” 建议的文本大小：最多 50 个字符
取件时间	必需	表示预约的接人时间的从公元纪年开始计算的时间戳。	纪元时间戳（以毫秒为单位）
返程时间	可选	公元纪年时间戳，表示预订的退房时间。	纪元时间戳（以毫秒为单位）
取货地址 - 国家/地区	可选	自提地点所在的国家/地区。	自由文本建议的文本大小：最多 20 个字符
取件地址 - 城市	可选	上车点所在的城市。	自由文本建议的文本大小：最多 20 个字符
取件地址 - 显示地址	可选	将向用户显示的接人地点。	自由文本建议的文本大小：最多 20 个字符
取车地址 - 街道地址	可选	自提地点的街道地址（如果适用）。	自由文本建议的文本大小：最多 20 个字符
取件地址 - 州/省/直辖市/自治区	可选	自提地点所在的州或省（如适用）。	自由文本建议的文本大小：最多 20 个字符
自提地址 - 邮政编码	可选	自提地点的邮政编码（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
取件地址 - 街区	可选	自提点所在的街区（如果适用）。	自由文本建议的文本大小：最多 20 个字符
退货地址 - 国家/地区	可选	退货地址所在的国家/地区。	自由文本建议的文本大小：最多约 20 个字符
退货地址 - 城市	可选	返回地点的城市。	自由文本建议的文本大小：最多 20 个字符
退货地址 - 显示地址	可选	将向用户显示的退货地点。	自由文本建议的文本大小：最多约 20 个字符
退货地址 - 街道地址	可选	退货地点的街道地址（如果适用）。	自由文本建议的文本大小：最多约 20 个字符
退货地址 - 州/省/直辖市	可选	退货地址所在的州或省（如适用）。	自由文本建议的文本大小：最多约 20 个字符
退货地址 - 邮政编码	可选	退货地点的邮政编码（如果适用）。	自由文本建议的文本大小：最多 20 个字符
退货地址 - 街区	可选	退货地址的街区（如适用）。	自由文本建议的文本大小：最多 20 个字符
服务提供商 - 名称	可选	服务提供商的名称。注意：服务提供商必须提供文本或图片。	自由文本。例如：“Avis 租车”
服务提供商 - 图片	可选	服务提供商的徽标/图片。注意：服务提供商必须提供文本或图片。	如需相关指导，请参阅图片规范。
海报图片	可选	如果提供了多张图片，我们只会显示 1 张图片。建议的宽高比为 16:9	如需相关指导，请参阅图片规范。
说明	可选	用于描述实体的单个段落文本。注意：向用户显示的是说明或字幕列表，不能同时显示。	自由文本建议的文本大小：180 个字符
字幕列表	可选	最多 3 个字幕，每个字幕都是一行文本。注意：系统只会向用户显示说明或字幕列表，不会同时显示这两者。	自由文本每个字幕建议的文本大小：最多 50 个字符
确认 ID	可选	租车预订的确认 ID。	自由文本
价格 - CurrentPrice	在特定条件下必需	预订的当前价格。如果提供带删除线的价格，则必须提供。	自由文本
价格 - StrikethroughPrice	可选	预订的原始价格，在界面中带有删除线。	自由文本
价格宣传信息	可选	用于展示促销、活动、会员折扣的价格宣传信息（如果有）。	自由文本建议的文本大小：少于 45 个字符（如果文本过长，可能会显示省略号）

图片规范

下表列出了图片素材资源必须遵循的规范：

宽高比	最小像素	建议的像素
方形 (1x1) 首选	300x300	1200x1200
横向 (1.91x1)	600x314	1200x628
纵向 (4x5)	480x600	960x1200

宽高比

最小像素

建议的像素

方形 (1x1)

首选

300x300

1200x1200

横向 (1.91x1)

600x314

1200x628

纵向 (4x5)

480x600

960x1200

图片必须托管在公共 CDN 上，以便 Google 可以访问。

文件格式

PNG、JPG、静态 GIF、WebP

文件大小上限

5120 KB

其他建议

图片安全区域：将重要内容放在图片中间 80% 的区域内。
请使用透明背景，以便图片可在“深色主题”和“浅色主题”设置中正常显示。

内容类别

借助内容类别，应用可以发布属于多个类别的内容。这会将内容与一些预定义类别（即：

TYPE_EDUCATION
TYPE_SPORTS
TYPE_MOVIES_AND_TV_SHOWS
TYPE_BOOKS
TYPE_AUDIOBOOKS
TYPE_MUSIC
TYPE_DIGITAL_GAMES
TYPE_TRAVEL_AND_LOCAL
TYPE_HOME_AND_AUTO
TYPE_BUSINESS
TYPE_NEWS
TYPE_FOOD_AND_DRINK
TYPE_SHOPPING
TYPE_HEALTH_AND_FITENESS
TYPE_MEDICAL
TYPE_PARENTING
TYPE_DATING

图片必须托管在公共 CDN 上，以便 Google 可以访问。

内容分类使用准则

有些实体（例如 ArticleEntity 和 GenericFeaturedEntity）可以使用任何内容类别。对于其他实体（例如 EventEntity、EventReservationEntity、PointOfInterestEntity），只有部分类别符合条件。在填充列表之前，请先查看符合实体类型条件的类别列表。
针对某些内容类别，请使用特定实体类型，而不是使用通用实体和 ContentCategory 的组合：
- TYPE_MOVIES_AND_TV_SHOWS - 在使用通用实体之前，请先查看观看集成指南中的实体。
- TYPE_BOOKS - 请先查看 EbookEntity，然后再使用通用实体。
- TYPE_AUDIOBOOKS - 在使用通用实体之前，请先查看 AudiobookEntity。
- TYPE_SHOPPING - 在使用通用实体之前，请先查看 ShoppingEntity。
- TYPE_FOOD_AND_DRINK - 在使用通用实体之前，请先查看食品集成指南中的实体。
ContentCategory 字段为可选字段，如果内容不属于前面提到的任何类别，则应将其留空。
如果提供多个内容类别，请按与内容的相关性顺序提供，并将相关性最高的内容类别放在列表的首位。

第 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 数据。
系统会解析请求中的数据，并将其存储在经过更新的 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 建议发布登录卡片。如果提供商因任何原因无法发布登录卡片，建议调用 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();

当服务收到请求时，此 API 会从建议集群中移除现有数据。如果发生错误，系统将拒绝整个请求，并保留现有状态。

`deleteFeaturedCluster`

此 API 用于删除精选集群的内容。

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

当服务收到请求时，此 API 会从精选集群中移除现有数据。如果发生错误，系统将拒绝整个请求，并保留现有状态。

`deleteContinuationCluster`

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

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

当服务收到请求时，此 API 会从接续集群中移除现有数据。如果发生错误，系统将拒绝整个请求，并保留现有状态。

`deleteUserManagementCluster`

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

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

当服务收到请求时，此 API 会从 UserAccountManagement 集群中移除现有数据。如果发生错误，系统将拒绝整个请求，并保留现有状态。

`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 会从所有与指定集群类型匹配的集群中移除现有数据。客户端可以选择传递一个或多个集群类型。如果发生错误，系统将拒绝整个请求，并保留现有状态。

错误处理

强烈建议开发者监听来自发布 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 步：处理广播 intent

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

广播 intent 主要用于重新激活应用和强制同步数据。不应过于频繁地发送广播 intent。仅在 Engage Service 确定内容可能已过时（例如，内容是一周前的）的情况下，广播 intent 才会触发。这样一来，开发者将更加确信，即使应用长时间未执行，用户也能够获得新鲜的内容体验。

必须通过以下两种方式设置 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> 标记静态声明实现。这样一来，应用便可以在未运行时接收广播 intent，并且应用也可以发布内容。

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

该服务会发送以下 intent：

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

集成工作流

如需查看在集成完成后验证集成的分步指南，请参阅 Engage 开发者集成工作流程。

常见问题解答

如需查看常见问题解答，请参阅 Engage SDK 常见问题解答。

联系人

如果在集成过程中有任何疑问，请与 engage-developers@google.com 联系。

后续步骤

完成此集成后，请执行下列后续步骤：

发送电子邮件至 engage-developers@google.com，并将可供 Google 测试的集成 APK 添加为附件。
Google 会执行验证，并在内部进行审核，以确保集成按预期运行。如果需要更改，Google 会与您联系，将所有必要的详细信息告知您。
测试完成后，如果无需进行任何更改，Google 将与您联系，向您说明您已可以开始将经过更新的集成 APK 发布到 Play 商店。
在 Google 确认经过更新的 APK 已发布到 Play 商店后，您的推荐、精选和接续集群便可被发布并向用户显示。