このページは Cloud Translation API によって翻訳されました。

Engage SDK Read: サードパーティの技術的統合手順

Google が構築しているオンデバイスサーフェスでは、ユーザーのアプリがカテゴリ別に整理され、パーソナライズされたアプリコンテンツの使用や発見における没入感のある新しいエクスペリエンスが提供されます。デベロッパーパートナーは、この全画面エクスペリエンスを活用することで、アプリ外の専用チャネルで良質なリッチコンテンツをアピールできます。

このガイドでは、Engage SDK を使用して書籍コンテンツを統合し、この新しいサーフェス領域と既存の Google サーフェスの両方にコンテンツを表示する手順を説明します。

統合の詳細

用語

この統合には、おすすめコンテンツ、継続、注目コンテンツの 3 種類のクラスタがあります。

おすすめコンテンツ クラスタには、個々のデベロッパーパートナーが提供する書籍コンテンツについて、パーソナライズされたおすすめ情報が表示されます。

おすすめコンテンツの構成は次のとおりです。
- おすすめコンテンツクラスタ: 単一のデベロッパーパートナーが提供するおすすめコンテンツのグループが表示される UI ビュー。
  
  図 1. 単一のパートナーが提供するおすすめコンテンツクラスタが表示されているエンターテイメントスペースの UI。
- エンティティ: クラスタ内の単一のアイテムを表すオブジェクト。エンティティには、電子書籍やオーディオブック、書籍シリーズなどがあります。サポートされているエンティティタイプの一覧については、「エンティティデータを提供する」セクションをご覧ください。
  
  図 2. 単一のパートナーのおすすめコンテンツクラスタ内のエンティティが 1 つ表示されているエンターテイメントスペースの UI。
継続クラスタでは、複数のデベロッパーパートナーが提供する未読了の書籍が 1 つの UI グループに表示されます。各デベロッパーパートナーは、継続クラスタ内で最大 10 個のエンティティをブロードキャストできます。

図 3. 複数のパートナーが提供する未読了のおすすめコンテンツを含む継続クラスタが表示されているエンターテイメントスペースの UI（現時点ではおすすめコンテンツが 1 つのみ表示されます）。
注目コンテンツ クラスタでは、複数のデベロッパーパートナーが提供するアイテムのセレクションが 1 つの UI グループに表示されます。1 つの注目クラスタが UI の上部付近に、どのおすすめコンテンツクラスタよりも優先されて表示されます。各デベロッパーパートナーは、注目コンテンツクラスタ内で最大 10 個のエンティティをブロードキャストできます。

図 4. 複数のパートナーが提供するおすすめコンテンツを含む注目コンテンツクラスタが表示されているエンターテインメントスペースの UI（現時点ではおすすめコンテンツが 1 つのみ表示されます）。

事前作業

最小 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 オブジェクトは、電子書籍を表します（ミシェルオバマ著『Becoming』の電子書籍など）。

属性	必須 / 任意	備考
名前	必須
ポスター画像	必須	画像を少なくとも 1 つ指定する必要があります。詳しくは、画像の仕様をご覧ください。
作者	必須	作者名を少なくとも 1 つ指定する必要があります。
アクションリンク URI	必須	電子書籍のプロバイダアプリへのディープリンク。注: アトリビューションにはディープリンクを使用できます。よくある質問をご覧ください
公開日	任意	エポックミリ秒単位（指定する場合）。
説明	任意	指定する場合は 200 文字以内にする必要があります。
価格	任意	自由形式のテキスト
ページ数	任意	指定する場合は正の整数にする必要があります。
ジャンル	任意	書籍に関連付けられているジャンルのリスト。
シリーズ名	任意	電子書籍が属するシリーズの名前（ハリー・ポッターなど）。
シリーズユニットの索引	任意	シリーズものの電子書籍の索引（1 はシリーズの最初の電子書籍）。たとえば、『ハリー・ポッターとアズカバンの囚人』が同シリーズの 3 番目の書籍の場合は、3 に設定します。
書籍の継続の種類	任意	TYPE_CONTINUE - 読み終えていない書籍を再開します。 TYPE_NEXT - シリーズの新しいアイテムに進みます。 TYPE_NEW - 新しいリリースです。
前回のエンゲージメント時間	条件付きで必須	アイテムが連続性クラスタ内にある場合は指定する必要があります。新規に取得した電子書籍は、「続けて読む」クラスタの一部にできます。エポックミリ秒単位。
進捗率	条件付きで必須	アイテムが継続クラスタ内にある場合は指定する必要があります。 0 より大きく 100 より小さい値を指定してください。
DisplayTimeWindow - コンテンツがサーフェスに表示される時間帯を設定します
開始タイムスタンプ	任意	このエポックタイムスタンプ以降にコンテンツがサーフェスに表示されます。設定されていない場合、コンテンツはサーフェスに表示されます。エポックミリ秒単位。
終了タイムスタンプ	任意	このエポックタイムスタンプ以降は、コンテンツがサーフェスに表示されなくなります。設定されていない場合、コンテンツはサーフェスに表示されます。エポックミリ秒単位。

`AudiobookEntity`

AudiobookEntity オブジェクトはオーディオブックを表します（ミシェルオバマ著『Becoming』のオーディオブックなど）。

属性	必須 / 任意	備考
名前	必須
ポスター画像	必須	画像を少なくとも 1 つ指定する必要があります。詳しくは、画像の仕様をご覧ください。
作者	必須	作者名を少なくとも 1 つ指定する必要があります。
ナレーター	必須	少なくとも 1 人のナレーターの名前を指定する必要があります。
アクションリンク URI	必須	オーディオブックのプロバイダアプリへのディープリンク。注: アトリビューションにはディープリンクを使用できます。よくある質問をご覧ください
公開日	任意	エポックミリ秒単位（指定する場合）。
説明	任意	指定する場合は 200 文字以内にする必要があります。
価格	任意	自由形式のテキスト
時間	任意	指定する場合は正の値にする必要があります。
ジャンル	任意	書籍に関連付けられているジャンルのリスト。
シリーズ名	任意	オーディオブックが属するシリーズの名前（ハリー・ポッターなど）。
シリーズユニットの索引	任意	シリーズもののオーディオブックの索引（1 はシリーズの最初のオーディオブック）。たとえば、『ハリー・ポッターとアズカバンの囚人』が同シリーズの 3 番目の書籍の場合は、3 に設定します。
書籍の継続の種類	任意	TYPE_CONTINUE - 読み終えていない書籍を再開します。 TYPE_NEXT - シリーズの新しいアイテムに進みます。 TYPE_NEW - 新しいリリースです。
前回のエンゲージメント時間	条件付きで必須	アイテムが継続クラスタ内にある場合は指定する必要があります。エポックミリ秒単位。
進捗率	条件付きで必須	アイテムが継続クラスタ内にある場合は指定する必要があります。新規に取得したオーディオブックは、「続けて読む」クラスタの一部にできます。 0 より大きく 100 より小さい値を指定してください。
DisplayTimeWindow - コンテンツがサーフェスに表示される時間帯を設定します
開始タイムスタンプ	任意	このエポックタイムスタンプ以降にコンテンツがサーフェスに表示されます。設定されていない場合、コンテンツはサーフェスに表示されます。エポックミリ秒単位。
終了タイムスタンプ	任意	このエポックタイムスタンプ以降は、コンテンツがサーフェスに表示されなくなります。設定されていない場合、コンテンツはサーフェスに表示されます。エポックミリ秒単位。

`BookSeriesEntity`

BookSeriesEntity オブジェクトは、書籍のシリーズ（7 冊の書籍で構成されるハリー・ポッターシリーズなど）を表します。

属性	必須 / 任意	備考
名前	必須
ポスター画像	必須	画像を少なくとも 1 つ指定する必要があります。詳しくは、画像の仕様をご覧ください。
作者	必須	作者名を少なくとも 1 つ指定する必要があります。
アクションリンク URI	必須	オーディオブックや電子書籍のプロバイダアプリへのディープリンク。注: アトリビューションにはディープリンクを使用できます。よくある質問をご覧ください
書籍数	必須	シリーズ内の書籍の数。
説明	任意	指定する場合は 200 文字以内にする必要があります。
ジャンル	任意	書籍に関連付けられているジャンルのリスト。
書籍の継続の種類	任意	TYPE_CONTINUE - 読み終えていない書籍を再開します。 TYPE_NEXT - シリーズの新しいアイテムに進みます。 TYPE_NEW - 新しいリリースです。
前回のエンゲージメント時間	条件付きで必須	アイテムが継続クラスタ内にある場合は指定する必要があります。エポックミリ秒単位。
進捗率	条件付きで必須	アイテムが継続クラスタ内にある場合は指定する必要があります。新規に取得した書籍シリーズは、「続けて読む」クラスタの一部にできます。 0 より大きく 100 より小さい値を指定してください。
DisplayTimeWindow - コンテンツがサーフェスに表示される時間帯を設定します
開始タイムスタンプ	任意	このエポックタイムスタンプ以降にコンテンツがサーフェスに表示されます。設定されていない場合、コンテンツはサーフェスに表示されます。エポックミリ秒単位。
終了タイムスタンプ	任意	このエポックタイムスタンプ以降は、コンテンツがサーフェスに表示されなくなります。設定されていない場合、コンテンツはサーフェスに表示されます。エポックミリ秒単位。

画像の仕様

画像アセットの要件となる仕様は次のとおりです。

アスペクト比	必須 / 任意	最小ピクセル数	推奨ピクセル数
スクエア（1×1）	必須	300×300	1200×1200
横向き（1.91×1）	任意	600×314	1200×628
縦向き（4×5）	任意	480×600	960×1200

ファイル形式

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 は、サービスを統合に使用できるかどうか、コンテンツをデバイスに表示できるかどうかを確認するために使用されます。

KotlinJava

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 オブジェクトのリストを公開するために使用されます。

KotlinJava

client.publishRecommendationClusters(
            PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build())

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Reconnect with yourself")
                        .build())
                .build());

サービスがリクエストを受信すると、1 つのトランザクション内で次のアクションが行われます。

デベロッパーパートナーが提供した既存の RecommendationCluster データが削除されます。
リクエストのデータが解析されて、更新されたおすすめコンテンツクラスタに保存されます。

エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`publishFeaturedCluster`

この API は、FeaturedCluster オブジェクトのリストを公開するために使用されます。

KotlinJava

client.publishFeaturedCluster(
            PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    FeaturedCluster.Builder()
                        ...
                        .build())
                .build())

client.publishFeaturedCluster(
            new PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    new FeaturedCluster.Builder()
                        ...
                        .build())
                .build());

サービスがリクエストを受信すると、1 つのトランザクション内で次のアクションが行われます。

デベロッパーパートナーが提供した既存の FeaturedCluster データが削除されます。
リクエストのデータが解析されて、更新された注目コンテンツクラスタに保存されます。

エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`publishContinuationCluster`

この API は、ContinuationCluster オブジェクトを公開するために使用されます。

KotlinJava

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

client.publishContinuationCluster(
            PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    ContinuationCluster.Builder()
                        .addEntity(book_entity1)
                        .addEntity(book_entity2)
                        .build())
                .build())

サービスがリクエストを受信すると、1 つのトランザクション内で次のアクションが行われます。

デベロッパーパートナーが提供した既存の ContinuationCluster データが削除されます。
リクエストのデータが解析されて、更新された継続クラスタに保存されます。

エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`publishUserAccountManagementRequest`

この API は、ログインカードを公開するために使用されます。ログインアクションにより、ユーザーをアプリのログインページに誘導し、アプリでコンテンツを公開（または、よりパーソナライズされたコンテンツを提供）できるようにします。

次のメタデータはログインカードの一部です。

属性	必須 / 任意	説明
アクション URI	必須	アクションへのディープリンク（アプリのログインページへの移動など）
画像	省略可 - 指定しない場合は、タイトルを指定する必要があります	カードに表示される画像解像度 1264×712 でアスペクト比 16×9 の画像
タイトル	省略可 - 指定しない場合は、画像を指定する必要があります	カード上のタイトル
アクションテキスト	任意	行動を促すフレーズ（ログインなど）で表示されるテキスト
字幕	任意	カードの字幕（省略可）

KotlinJava

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

サービスがリクエストを受信すると、1 つのトランザクション内で次のアクションが行われます。

デベロッパーパートナーが提供した既存の UserAccountManagementCluster データが削除されます。
リクエストのデータが解析されて、更新済みのユーザーアカウント管理クラスタに保存されます。

エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`updatePublishStatus`

社内の業務上の理由でいずれのクラスタも公開されていない場合は、updatePublishStatus API を使用して公開ステータスを更新することを強くおすすめします。公開ステータスの更新が必要な理由は:

ダッシュボードではこのステータスの値に基づいて、統合の健全性などの指標が追加されるため、コンテンツが公開されている（STATUS == PUBLISHED）場合でも公開ステータスを明示する必要があります。
コンテンツは未公開でも統合ステータスが壊れていなければ（STATUS == NOT_PUBLISHED）、アプリの健全性ダッシュボードでアラートがトリガーされるのを回避できます。未公開ステータスを明示することで、プロバイダにとって想定済みの理由からコンテンツが非公開であるという確認がとれます。
デベロッパーは、データが公開されるタイミングと、公開されていないタイミングに関する分析情報を提供できます。
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 を呼び出すことをおすすめします。

KotlinJava

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 は、おすすめコンテンツクラスタのコンテンツを削除するために使用されます。

KotlinJava

client.deleteRecommendationClusters()

client.deleteRecommendationClusters();

サービスがリクエストを受信すると、おすすめコンテンツクラスタから既存のデータが削除されます。エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`deleteFeaturedCluster`

この API は、注目コンテンツクラスタのコンテンツを削除するために使用されます。

KotlinJava

client.deleteFeaturedCluster()

client.deleteFeaturedCluster();

サービスがリクエストを受信すると、注目コンテンツクラスタから既存のデータが削除されます。エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`deleteContinuationCluster`

この API は、継続クラスタのコンテンツを削除するために使用されます。

KotlinJava

client.deleteContinuationCluster()

client.deleteContinuationCluster();

サービスがリクエストを受信すると、継続クラスタから既存のデータが削除されます。エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`deleteUserManagementCluster`

この API は、ユーザーアカウント管理クラスタのコンテンツを削除するために使用されます。

KotlinJava

client.deleteUserManagementCluster()

client.deleteUserManagementCluster();

サービスがリクエストを受信すると、ユーザーアカウント管理クラスタから既存のデータが削除されます。エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

`deleteClusters`

この API は、特定のクラスタタイプのコンテンツを削除するために使用されます。

KotlinJava

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

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

サービスがリクエストを受信すると、指定したクラスタタイプに一致するすべてのクラスタから既存のデータが削除されます。クライアントは、1 つまたは複数のクラスタタイプを渡すこともできます。エラーが発生した場合は、リクエスト全体が拒否され、それまでの状態が維持されます。

エラー処理

publish 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 のサービスが、コンテンツが古い可能性がある（1 週間前など）と判断した場合にのみトリガーされます。そうすることで、アプリが長時間実行されていない場合でも、より確実にユーザーに新しいコンテンツを提供できます。

BroadcastReceiver は、次の 2 つの方法で設定する必要があります。

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.play.engage.action.PUBLISH_CONTINUATION このインテントを受信したときに、It is recommended to start a publishContinuationCluster の呼び出しを開始することをおすすめします。

統合ワークフロー

統合完了後に検証を行う手順のガイドについては、デベロッパー向けの Engage 統合ワークフローをご覧ください。

よくある質問

よくある質問については、Engage SDK に関するよくある質問をご覧ください。

お問い合わせ

統合プロセスについてご不明な点がありましたら、engage-developers@google.com までお問い合わせください。担当チームができる限り速やかに返信いたします。

次のステップ

この統合が完了した後のステップは次のとおりです。

Google によるテストの準備が整った統合済みの APK を添付して、engage-developers@google.com にメールを送信します。
Google が社内で検証とレビューを行い、統合が適切に機能するか確認します。変更が必要な場合は、Google から詳細をご連絡いたします。
テストが完了し、変更の必要もない場合は、更新された統合済みの APK を Play ストアに公開できるようになったことを Google からお知らせします。
更新された APK が Play ストアに公開されていることを Google が確認したら、おすすめコンテンツ、注目コンテンツ、継続の各クラスタが公開され、ユーザーに表示されます。

Engage SDK Read: サードパーティの技術的統合手順

統合の詳細

用語

事前作業

まとめ

ステップ 1: エンティティ データを提供する

EbookEntity

AudiobookEntity

BookSeriesEntity

画像の仕様

例

ステップ 2: クラスタデータを提供する

isServiceAvailable

publishRecommendationClusters

publishFeaturedCluster

publishContinuationCluster

publishUserAccountManagementRequest

updatePublishStatus

deleteRecommendationClusters

deleteFeaturedCluster

deleteContinuationCluster

deleteUserManagementCluster

deleteClusters

エラー処理

ステップ 3: ブロードキャスト インテントを処理する

統合ワークフロー

よくある質問

お問い合わせ

次のステップ

ステップ 1: エンティティデータを提供する

`EbookEntity`

`AudiobookEntity`

`BookSeriesEntity`

`isServiceAvailable`

`publishRecommendationClusters`

`publishFeaturedCluster`

`publishContinuationCluster`

`publishUserAccountManagementRequest`

`updatePublishStatus`

`deleteRecommendationClusters`

`deleteFeaturedCluster`

`deleteContinuationCluster`

`deleteUserManagementCluster`

`deleteClusters`

ステップ 3: ブロードキャストインテントを処理する