Google 正在构建一个设备上的界面,该界面按垂直方向组织用户的应用,并为个性化应用内容使用和发现提供新的沉浸式体验。此全屏体验为开发者合作伙伴提供了一个机会,让他们能够在一个专门的渠道中展示其最佳的丰富内容,而不是在其应用之外。
本指南包含开发者合作伙伴集成其可读内容的说明,使用 Engage SDK 填充此新界面区域和现有的 Google 界面。
集成详情
术语
此集成包括以下三种集群类型:**推荐**、**续读**和**精选**。
**推荐**集群显示来自单个开发者合作伙伴的个性化内容阅读建议。
您的推荐采用以下结构
**推荐集群:**包含来自单个开发者合作伙伴的一组推荐的 UI 视图。
**实体:**表示集群中单个项目的对象。实体可以是电子书、有声书、书籍系列等。有关支持的实体类型的列表,请参阅提供实体数据部分。
**续读**集群显示来自多个开发者合作伙伴的未完成书籍,在一个 UI 分组中。每个开发者合作伙伴最多允许在续读集群中广播 10 个实体。
**精选**集群在一个 UI 分组中展示来自多个开发者合作伙伴的一些项目。将有一个精选集群,它显示在 UI 的顶部附近,优先于所有推荐集群。每个开发者合作伙伴最多允许在精选集群中广播 10 个实体。
准备工作
最低 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 个 | 最多 50 个 |
续读集群 | 最多 1 个 | 最多 10 个 |
精选集群 | 最多 1 个 | 最多 10 个 |
步骤 1:提供实体数据
SDK 已定义不同的实体来表示每种项目类型。我们支持以下阅读类别的实体
EbookEntity
AudiobookEntity
BookSeriesEntity
下表概述了每种类型的可用属性和要求。
EbookEntity
EbookEntity
对象表示电子书(例如,米歇尔·奥巴马的《成为》的电子书)。
属性 | 要求 | 备注 |
---|---|---|
名称 | 必需 | |
海报图片 | 必需 | 必须提供至少一张图片。有关指南,请参阅图片规范。 |
作者 | 必需 | 必须提供至少一个作者姓名。 |
操作链接 URI | 必需 |
电子书提供商应用的深层链接。 注意:您可以使用深层链接进行归因。 参考此常见问题解答 |
发布日期 | 可选 | 如果提供,则以毫秒为单位的纪元时间。 |
描述 | 可选 | 如果提供,则必须在 200 个字符以内。 |
价格 | 可选 | 自由文本 |
页数 | 可选 | 如果提供,则必须为正整数。 |
类型 | 可选 | 与书籍关联的类型列表。 |
系列名称 | 可选 | 电子书所属系列的名称(例如,《哈利·波特》)。 |
系列单元索引 | 可选 | 电子书在系列中的索引,其中 1 代表系列中的第一本电子书。例如,如果《哈利波特与阿兹卡班的囚徒》是该系列中的第 3 本书,则应将其设置为 3。 |
续订书籍类型 | 可选 |
TYPE_CONTINUE - 续订未完成的书籍。 TYPE_NEXT - 续订系列中的下一本。 TYPE_NEW - 新发布的。 |
上次参与时间 | 条件性必需 |
当项目位于续订聚类中时,必须提供。 *新* 获取的电子书可以是续读聚类的一部分。 以毫秒为单位的纪元时间戳。 |
进度百分比完成 | 条件性必需 |
当项目位于续订聚类中时,必须提供。 值必须大于 0 且小于 100。 |
DisplayTimeWindow - 为内容在界面上显示设置时间窗口 | ||
开始时间戳 | 可选 |
内容应在界面上显示后的纪元时间戳。 如果未设置,则内容有资格在界面上显示。 以毫秒为单位的纪元时间戳。 |
结束时间戳 | 可选 |
内容不再在界面上显示后的纪元时间戳。 如果未设置,则内容有资格在界面上显示。 以毫秒为单位的纪元时间戳。 |
AudiobookEntity
The AudiobookEntity
对象代表一个有声书(例如,米歇尔·奥巴马的《成为》的有声书)。
属性 | 要求 | 备注 |
---|---|---|
名称 | 必需 | |
海报图片 | 必需 | 必须提供至少一张图片。有关指南,请参阅图片规范。 |
作者 | 必需 | 必须提供至少一个作者姓名。 |
旁白 | 必需 | 必须提供至少一个旁白的名字。 |
操作链接 URI | 必需 |
有声书提供商应用的深度链接。 注意:您可以使用深层链接进行归因。 参考此常见问题解答 |
发布日期 | 可选 | 如果提供,则以毫秒为单位的纪元时间。 |
描述 | 可选 | 如果提供,则必须在 200 个字符以内。 |
价格 | 可选 | 自由文本 |
时长 | 可选 | 如果提供,必须为正值。 |
类型 | 可选 | 与书籍关联的类型列表。 |
系列名称 | 可选 | 有声书所属系列的名称(例如,《哈利波特》)。 |
系列单元索引 | 可选 | 有声书在系列中的索引,其中 1 代表系列中的第一个有声书。例如,如果《哈利波特与阿兹卡班的囚徒》是该系列中的第 3 本书,则应将其设置为 3。 |
续订书籍类型 | 可选 |
TYPE_CONTINUE - 续订未完成的书籍。 TYPE_NEXT - 续订系列中的下一本。 TYPE_NEW - 新发布的。 |
上次参与时间 | 条件性必需 | 当项目位于续订聚类中时,必须提供。 以毫秒为单位的纪元时间戳。 |
进度百分比完成 | 条件性必需 |
当项目位于续订聚类中时,必须提供。 *新* 获取的有声书可以是续读聚类的一部分。 值必须大于 0 且小于 100。 |
DisplayTimeWindow - 为内容在界面上显示设置时间窗口 | ||
开始时间戳 | 可选 |
内容应在界面上显示后的纪元时间戳。 如果未设置,则内容有资格在界面上显示。 以毫秒为单位的纪元时间戳。 |
结束时间戳 | 可选 |
内容不再在界面上显示后的纪元时间戳。 如果未设置,则内容有资格在界面上显示。 以毫秒为单位的纪元时间戳。 |
BookSeriesEntity
The BookSeriesEntity
对象代表一个书籍系列(例如,《哈利波特》系列,共有 7 本书)。
属性 | 要求 | 备注 |
---|---|---|
名称 | 必需 | |
海报图片 | 必需 | 必须提供至少一张图片。有关指南,请参阅图片规范。 |
作者 | 必需 | 必须至少有一个作者姓名。 |
操作链接 URI | 必需 |
有声书或电子书提供商应用的深度链接。 注意:您可以使用深层链接进行归因。 参考此常见问题解答 |
书籍数量 | 必需 | 系列中书籍的数量。 |
描述 | 可选 | 如果提供,则必须在 200 个字符以内。 |
类型 | 可选 | 与书籍关联的类型列表。 |
续订书籍类型 | 可选 |
TYPE_CONTINUE - 续订未完成的书籍。 TYPE_NEXT - 续订系列中的下一本。 TYPE_NEW - 新发布的。 |
上次参与时间 | 条件性必需 | 当项目位于续订聚类中时,必须提供。 以毫秒为单位的纪元时间戳。 |
进度百分比完成 | 条件性必需 | 当项目位于续订聚类中时,必须提供。 *新* 获取的书籍系列可以是续读聚类的一部分。 值必须大于 0 且小于 100。 |
DisplayTimeWindow - 为内容在界面上显示设置时间窗口 | ||
开始时间戳 | 可选 |
内容应在界面上显示后的纪元时间戳。 如果未设置,则内容有资格在界面上显示。 以毫秒为单位的纪元时间戳。 |
结束时间戳 | 可选 |
内容不再在界面上显示后的纪元时间戳。 如果未设置,则内容有资格在界面上显示。 以毫秒为单位的纪元时间戳。 |
图片规格
下面列出了图片素材的必要规格
纵横比 | 要求 | 最小像素 | 推荐像素 |
---|---|---|---|
正方形 (1x1) | 必需 | 300x300 | 1200x1200 |
横向 (1.91x1) | 可选 | 600x314 | 1200x628 |
纵向 (4x5) | 可选 | 480x600 | 960x1200 |
文件格式
PNG、JPG、静态 GIF、WebP
最大文件大小
5120 KB
其他建议
- 图片安全区域:将重要内容放在图片中央 80% 的区域。
示例
AudiobookEntity audiobookEntity =
new AudiobookEntity.Builder()
.setName("Becoming")
.addPosterImage(
new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.addAuthor("Michelle Obama")
.addNarrator("Michelle Obama")
.setActionLinkUri(Uri.parse("https://play.google/audiobooks/1"))
.setDurationMillis(16335L)
.setPublishDateEpochMillis(1633032895L)
.setDescription("An intimate, powerful, and inspiring memoir")
.setPrice("$16.95")
.addGenre("biography")
.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("Reconnect with yourself") .build()) .build())
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Reconnect with yourself") .build()) .build());
当服务收到请求时,以下操作将在一个事务中进行
- 删除开发合作伙伴的现有
RecommendationCluster
数据。 - 解析请求中的数据并将其存储在更新的推荐聚类中。
如果发生错误,则整个请求将被拒绝,并保持现有状态。
publishFeaturedCluster
此 API 用于发布 FeaturedCluster
对象列表。
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() ... .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( new FeaturedCluster.Builder() ... .build()) .build());
当服务收到请求时,以下操作将在一个事务中进行
- 删除开发合作伙伴的现有
FeaturedCluster
数据。 - 解析请求中的数据并将其存储在更新的特色聚类中。
如果发生错误,则整个请求将被拒绝,并保持现有状态。
publishContinuationCluster
此 API 用于发布 ContinuationCluster
对象。
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(book_entity1) .addEntity(book_entity2) .build()) .build())
Java
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(book_entity1) .addEntity(book_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_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) ... .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_FEATURED) .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
返回,其中包含错误代码作为原因。
错误代码 | 错误名称 | 备注 |
---|---|---|
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
类的实例。这使得仍在内存中运行的应用程序能够进行通信。
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
建议在收到此 Intent 后启动
publishContinuationCluster` 调用。
集成工作流程
有关完成集成后验证集成步骤的逐步指南,请参阅Engage 开发者集成工作流程。
常见问题解答
有关常见问题解答,请参阅Engage SDK 常见问题解答。
联系方式
如有任何疑问,请在集成过程中联系[email protected]。我们的团队会尽快回复您。
后续步骤
完成此集成后,您的后续步骤如下
- 发送电子邮件至[email protected],并附上您已集成的 APK,以便 Google 进行测试。
- Google 将在内部进行验证和审查,以确保集成按预期工作。如果需要更改,Google 将与您联系并提供必要的详细信息。
- 测试完成后,并且不需要任何更改,Google 将与您联系,通知您可以开始将更新的集成 APK 发布到 Play 商店。
- Google 确认您已将更新的 APK 发布到 Play 商店后,您的**推荐**、**精选**和**续播**集群将发布并对用户可见。