Engage SDK 健康与健身：第三方技术集成说明

准备工作

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

摘要

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

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

步骤 1：提供实体数据

SDK 已定义不同的实体来表示每种项目类型。我们支持以下用于健康和健身类别的实体

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

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

GenericFeaturedEntity

ArticleEntity

PersonEntity

EventEntity

EventReservationEntity

图片规格

此表中列出了图片资源的必填规格

图片需要托管在公共 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 能够访问它们。

使用内容类别的指南

1. 某些实体（如 **ArticleEntity** 和 **GenericFeaturedEntity**）可以使用任何内容类别。对于其他实体（如 **EventEntity**、**EventReservationEntity**、**PersonEntity**），则只能使用这些类别中的子集。在填充列表之前，请查看实体类型适用的类别列表。

2. 对于某些内容类别，请使用特定的实体类型，而不是使用通用实体和 ContentCategory 的组合。

   • TYPE_MOVIES_AND_TV_SHOWS - 在使用通用实体之前，请查看 Watch 集成指南 中的实体。
   • TYPE_BOOKS - 在使用通用实体之前，请查看 EbookEntity。
   • TYPE_AUDIOBOOKS - 在使用通用实体之前，请查看 AudiobookEntity。
   • TYPE_SHOPPING - 在使用通用实体之前，请查看 ShoppingEntity。
   • TYPE_FOOD_AND_DRINK - 在使用通用实体之前，请查看 Food 集成指南 中的实体。

3. ContentCategory 字段是可选的，如果内容不属于前面提到的任何类别，则应将其留空。

4. 如果提供了多个内容类别，请按与内容的相关性顺序提供，并将最相关的类别放在列表的第一位。

步骤 2：提供集群数据

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

AppEngagePublishClient 负责发布集群。

客户端中提供以下 API 用于发布集群：

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishContinuationCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteContinuationCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

此 API 用于检查服务是否可用于集成以及内容是否可以在设备上呈现。

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

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

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

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

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

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

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

publishFeaturedCluster

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

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

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

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

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

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

publishContinuationCluster

此 API 用于发布 ContinuationCluster 对象。

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

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

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

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

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

publishUserAccountManagementRequest

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

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

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

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

• 删除开发合作伙伴的现有 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 会建议发布登录卡片。如果出于任何原因提供商无法发布登录卡片，则建议使用状态代码 **NOT_PUBLISHED_REQUIRES_SIGN_IN** 调用 **updatePublishStatus** API。

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

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

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

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

deleteFeaturedCluster

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

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

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

deleteContinuationCluster

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

client.deleteContinuationCluster()

client.deleteContinuationCluster();

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

deleteUserManagementCluster

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

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

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

deleteClusters

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

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

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

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

错误处理

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

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

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

步骤 3：处理广播意图

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

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

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

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

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

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 建议在收到此 Intent 时启动 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 商店后，您的推荐、精选和续播集群可能会发布并对用户可见。