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

Google は、ユーザーのアプリをカテゴリ別に整理し、没入感のある新しいエクスペリエンスによってアプリ コンテンツの使用や発見をパーソナライズできるオンデバイス サーフェスを構築しています。デベロッパー パートナーは、この全画面エクスペリエンスで 自社の優れたリッチ コンテンツを Google 以外の専用チャネルで紹介する機会 ダウンロードしてください。このガイドでは、デベロッパー パートナーが エンゲージ SDK を使用して出会い系コンテンツを統合し、 表面積。

統合の詳細

用語

この統合には、推奨事項注目コンテンツ継続です。

  • おすすめコンテンツ クラスタには、パーソナライズされたおすすめの出会い系コンテンツが表示されます 提供しますこれらの推奨事項は ユーザーに合わせてパーソナライズできます

    • おすすめコンテンツ クラスタは、ArticleEntityPersonEntity、 または EventEntity ですが、異なるエンティティ タイプを混在させることはできません。

    おすすめコンテンツの構成は次のとおりです。

    • おすすめコンテンツ クラスタ: 同一のデベロッパー パートナーが提供するおすすめコンテンツのグループが表示される UI ビュー。

    • エンティティ: クラスタ内の単一のアイテムを表すオブジェクト。この 統合には、いくつかのエンティティが おすすめコンテンツ クラスタ:

      • ArticleEntity: ArticleEntity は、 出会い系に関連するテキストベースのコンテンツ。ArticleEntity アイテム デベロッパーがさまざまなテキストや画像コンテンツを より多くのメタデータで情報を ユーザーに明確に示します

        <ph type="x-smartling-placeholder">
        </ph>
        図 1: おすすめコンテンツ クラスタ内の 1 つの ArticleEntity を表示する UI
      • PersonEntity: PersonEntity は、人物を表します。「 出会い系の人を取り上げたり 見込み顧客にアピールできます。

        <ph type="x-smartling-placeholder">
        </ph>
        図 2: UI 内に 1 つの PersonEntity が表示されています。 おすすめコンテンツ クラスタ。
      • EventEntity: EventEntity は、 説明します。イベントの開始時間は ユーザーに伝える必要があります

        <ph type="x-smartling-placeholder">
        </ph>
        図 3: 単一の EventEntity を表示する UI おすすめします。
  • 継続クラスタには、ユーザーの最近のエンゲージメント コンテンツが表示されます。 1 つの UI グループで、複数のデベロッパー パートナーを使用できます。各デベロッパー パートナーは、 Continuation で最大 10 個のエンティティをブロードキャストできます 作成します。

    継続コンテンツの構造は次のとおりです。

    • ArticleEntity: ArticleEntity は、 出会い系に関連するテキストベースのコンテンツ。このエンティティは 読み終えていないニュース記事など、ユーザーが興味を持ちそうな そのまま消費し続けたいと思うでしょう

      図 6. 1 つの ArticleEntity を表示する UI 作成します
    • EventReservationEntity: EventReservationEntity が表すもの 予約して、今後の予定や進行中のイベントを 出会いやミートアップ イベントの予約などです。

      図 8. 1 つの UI を 継続クラスタ内の EventReservationEntity 。
  • 注目コンテンツ クラスタは、選択したヒーローを表示する UI ビューです。 1 つの UI グループに表示される、多数のデベロッパー パートナーが提供する GenericFeaturedEntity。 注目コンテンツ クラスタが 1 つあり、 UI。どのおすすめコンテンツ クラスタよりも優先されて表示されます。各 デベロッパー パートナーは、サポートされている 多数のエンティティ(場合によってはさまざまなタイプ)が 注目コンテンツ クラスタには複数のアプリ デベロッパーが表示されます。

    • GenericAllowedEntity: GenericRecommendedEntity が以下と異なる その注目のアイテムのおすすめアイテムは、1 つのアイテムにのみ使用する デベロッパーから上位にあったコンテンツのうち、特に ユーザーの興味を引く関連性の高い重要な コンテンツを作成します

      <ph type="x-smartling-placeholder">
      </ph>
      図 12: 注目のクラスタを示す UI GenericFEATUREEntity のリスト

事前作業

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

概要

この設計は、Terraform の バインドされたサービス

クライアントが公開できるデータには、各種クラスタに関する次の上限が適用されます。

クラスタタイプ クラスタ数の上限 クラスタ内のエンティティ数の下限 クラスタ内のエンティティ数の上限
おすすめコンテンツ クラスタ 最大 5 個 5 以上 最大 25 個(ArticleEntityPersonEntity、または EventEntity
継続クラスタ 最大 1 個 1 以上 最大 10 個(ArticleEntity、または EventReservationEntity
注目コンテンツ クラスタ 最大 1 個 1 以上 最大 10 個(GenericFeaturedEntity

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

この SDK では、各アイテムタイプを表すさまざまなエンティティを定義しています。Google がサポート 「出会い」カテゴリの次のエンティティがあるとします。

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

下記の表に、各タイプで使用可能な属性と、必須か任意かをまとめています。

GenericFeaturedEntity

属性 必須 / 任意 説明 形式
アクション URI 必須

プロバイダ アプリ内のエンティティへのディープリンク。

注: アトリビューションにはディープリンクを使用できます。<ph type="x-smartling-placeholder"></ph> よくある質問を参照する

URI
ポスター画像 必須

複数の画像が指定されている場合、1 つの画像のみが表示されます。 推奨のアスペクト比は 16:9 です

注: バッジを使用する場合は、24 文字分のスペースを確保してください。 画像の上部と下部の両方で dps

詳しくは、画像の仕様をご覧ください。
タイトル 任意 エンティティのタイトル。

自由形式のテキスト

推奨テキストサイズは 50 文字

説明 任意

エンティティを説明する 1 段落のテキスト。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

推奨テキストサイズは 180 文字

字幕リスト 任意

最大 3 つの字幕(各サブタイトルに 1 行のテキスト)。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

各サブタイトルの推奨テキストサイズ: 最大 50 文字

バッジ 任意

各バッジは、自由形式のテキスト(最大 15 文字)か小さい画像のいずれかです。

画像や動画に加えて、バッジなど、特別な UX 表示が実現されます。 画像に重ねて

  • 「リアルタイムの最新情報」
  • 記事の読み取り時間
バッジ - テキスト 任意

バッジのタイトル

注: バッジにはテキストまたは画像が必要です。

自由形式のテキスト

推奨テキストサイズは 15 文字以下

バッジ - 画像 任意

小さい画像

特別な UX の取り扱い(画像または動画にバッジが重なるなど) クリックします。

注: バッジにはテキストまたは画像が必要です。

詳しくは、画像の仕様をご覧ください。
コンテンツ カテゴリ 任意 エンティティ内のコンテンツのカテゴリを記述します。

列挙型のリスト

[コンテンツ カテゴリ] セクションをご覧ください。 をご覧ください。

ArticleEntity

属性 必須 / 任意 説明 形式
アクション URI 必須

プロバイダ アプリ内のエンティティへのディープリンク。

注: アトリビューションにはディープリンクを使用できます。<ph type="x-smartling-placeholder"></ph> よくある質問を参照する

URI
タイトル 必須 エンティティのタイトル。

自由形式のテキスト

推奨テキストサイズ: 最大 50 文字

ポスター画像 任意

複数の画像が指定されている場合、1 つの画像のみが表示されます。 推奨のアスペクト比は 16:9 です

注: 画像を使用することを強くおすすめします。バッジが 上部と下部の両方で 24 dps の安全なスペースを確保 画像

詳しくは、画像の仕様をご覧ください。
ソース - タイトル 任意 著者、組織、または報告者の名前

自由形式のテキスト

推奨テキストサイズは 25 文字未満

ソース - 画像 任意 著者、組織、記者などの情報源の画像 詳しくは、画像の仕様をご覧ください。
説明 任意

エンティティを説明する 1 段落のテキスト。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

推奨テキストサイズは 180 文字

字幕リスト 任意

最大 3 つの字幕(各サブタイトルに 1 行のテキスト)。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

各サブタイトルの推奨テキストサイズ: 最大 50 文字

バッジ 任意

各バッジは、自由形式のテキスト(最大 15 文字)か小さい画像のいずれかです。

画像や動画に加えて、バッジなど、特別な UX 表示が実現されます。 画像に重ねて

  • 例: 「リアルタイム更新」
  • 例: 記事の読み取り時間
バッジ - テキスト 任意

バッジのタイトル

注: バッジにはテキストまたは画像が必要です。

自由形式のテキスト

推奨テキストサイズは 15 文字以下

バッジ - 画像 任意

小さい画像

特別な UX の取り扱い(画像または動画にバッジが重なるなど) クリックします。

注: バッジにはテキストまたは画像が必要です。

詳しくは、画像の仕様をご覧ください。
コンテンツの公開時刻 任意 コンテンツが正常に視聴されたときのエポック タイムスタンプ(ミリ秒単位) 確認できます。 エポック タイムスタンプ(ミリ秒)
前回のエンゲージメント時間 条件付き必須

ユーザーが操作を行ったときのエポック タイムスタンプ(ミリ秒単位) 最後のエンティティです。

注: このエンティティが 継続クラスタです

エポック タイムスタンプ(ミリ秒)
進行状況の割合 条件付き必須

現在までにユーザーが消費したコンテンツ全体の割合。

注: このエンティティが 継続クラスタです

0 ~ 100 の int 値(両端を含む)。
コンテンツ カテゴリ 任意 エンティティ内のコンテンツのカテゴリを記述します。

列挙型のリスト

[コンテンツ カテゴリ] セクションをご覧ください。 をご覧ください。

PersonEntity

属性 必須 / 任意 説明 形式
アクション URI 必須

プロバイダ アプリ内のエンティティへのディープリンク。

注: アトリビューションにはディープリンクを使用できます。<ph type="x-smartling-placeholder"></ph> よくある質問を参照する

URI
プロフィール - 名前 必須 プロフィール名または ID またはハンドル(「John Doe」、「@TeamPixel」など)。

文字列

推奨テキストサイズ: 最大 50 文字

プロフィール - アバター 必須

ユーザーのプロフィール写真またはアバター画像。

注: 1:1 の正方形の画像にする必要があります。

詳しくは、画像の仕様をご覧ください。
プロフィール - 追加のテキスト 任意 プロフィール ハンドルなどの自由形式のテキスト。

自由形式のテキスト

推奨テキストサイズ: 最大 15 文字

プロフィール - 追加の画像 任意 認証バッジなどの小さい画像。 詳しくは、画像の仕様をご覧ください。
ヘッダー画像 任意

ヘッダー画像を表します。プロフィール画像とは異なる画像を指定してください。 これは、ハイライトを強調する追加の画像がある場合に使用できます。 好むこともあります

注: 16:9 の画像にしてください。バッジを提供している場合は 画像の上部と下部に 24 dps のセーフスペースを確保する

詳しくは、画像の仕様をご覧ください。
人気度 - 数 任意

フォロワー数や人気度の値を指定します。次に例を示します。 「3.7 M.」。

注: 件数と件数の両方を指定した場合は、 カウントが使用されます

文字列

推奨テキストサイズ: 文字数とラベルは半角 20 文字(全角 10 文字)以内 組み合わせた

人気度 - 数量 任意

フォロワー数または人気度の値。

注: アプリでカウント方法を指定しない場合は、カウント値を指定してください。 どのように大きな数値を最適化すべきかに関するロジックを 表示サイズを変更できます。Count と Count Value の両方を指定した場合は、 件数がユーザーに表示されます。

Long
人気度 - ラベル 任意 人気度ラベルを示します。例: 「高評価」。

文字列

推奨テキストサイズ: 文字数とラベルは半角 20 文字(全角 10 文字)以内 組み合わせた

人気度 - ビジュアル 任意

インタラクションの目的を表します。例 - 画像の表示 高評価アイコン、絵文字。

複数の画像を指定できますが、一部の画像が表示されない場合もあります サポートしています。

注: 1:1 の正方形の画像を使用する必要があります。

詳しくは、画像の仕様をご覧ください。
評価 - 最高値 必須

段階別評価の最高値。

現在の評価値も指定する場合は必須です。

0.0 以上の数値。
評価 - 現在値 必須

段階別評価の現在の値。

評価の最高値も指定する場合は必須です。

0.0 以上の数値。
評価 - 件数 任意

エンティティの評価の件数。

注: このフィールドは、アプリが許可または拒否を ユーザーへの表示方法を制御します。簡潔な文字列を指定する リソースを定義できます。たとえば、カウントが 1,000,000 を超える場合、1M などの略語を使用して、 サイズが小さい場合は切り捨てられます

文字列
評価 - 件数 任意

エンティティの評価の件数。

注: 使用する必要があります。[件数] と [件数] の両方がある場合 Count を使用してユーザーに表示します。

Long
場所 - 国 任意 その人物の所在地またはサービス提供中の国。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 市区町村 任意 その人物の所在地または勤務先の市区町村。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 表示住所 任意 ユーザーの所在地またはサービス提供中の住所は できます。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 住所 任意 その人の所在地または あります。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 都道府県 任意 その人物の所在地またはサービス提供地域(該当する場合)。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

地域 - 郵便番号 任意 その人物の所在地または勤務地の郵便番号(該当する場合)。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 周辺地域 任意 その人物の所在地またはサービス提供地域(該当する場合)。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

バッジ 任意

各バッジは、自由形式のテキスト(最大 15 文字)か小さい画像のいずれかです。

バッジ - テキスト 任意

バッジのタイトル

注: バッジにはテキストまたは画像が必要です。

自由形式のテキスト

推奨テキストサイズは 15 文字以下

バッジ - 画像 任意

小さい画像

特別な UX の取り扱い(画像または動画にバッジが重なるなど) クリックします。

注: バッジにはテキストまたは画像が必要です。

詳しくは、画像の仕様をご覧ください。
説明 任意

エンティティを説明する 1 段落のテキスト。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

推奨テキストサイズは 180 文字

字幕リスト 任意

最大 3 つの字幕(各サブタイトルに 1 行のテキスト)。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

各サブタイトルの推奨テキストサイズ: 最大 50 文字

コンテンツ カテゴリ 任意 エンティティ内のコンテンツのカテゴリを記述します。

有効な列挙型のリスト

  • TYPE_HEALTH_AND_FITENESS(例 - ヨガ/フィットネス トレーナー)
  • TYPE_HOME_AND_AUTO(例 - 配管工)
  • TYPE_SPORTS(例 - Player)
  • データ型の DATING

[コンテンツ カテゴリ] セクションをご覧ください。 をご覧ください。

EventEntity

属性 必須 / 任意 説明 形式
アクション URI 必須

プロバイダ アプリ内のエンティティへのディープリンク。

注: アトリビューションにはディープリンクを使用できます。<ph type="x-smartling-placeholder"></ph> よくある質問を参照する

URI
タイトル 必須 エンティティのタイトル。

文字列

推奨テキストサイズ: 最大 50 文字

開始時刻 必須

イベントの開始予定時間のエポック タイムスタンプ。

注: これはミリ秒単位で表されます。

エポック タイムスタンプ(ミリ秒)
イベントモード 必須

イベントがオンライン、対面、または あります。

列挙型: VIRTUAL、IN_PERSON、HYBRID
ポスター画像 必須

複数の画像が指定されている場合、1 つの画像のみが表示されます。 推奨のアスペクト比は 16:9 です

注: 画像を使用することを強くおすすめします。バッジが 上部と下部の両方で 24 dps の安全なスペースを確保 画像

詳しくは、画像の仕様をご覧ください。
場所 - 国 条件付き必須

イベントが行われる国。

注: これは、IN_PERSON または ハイブリッド

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 市区町村 条件付き必須

イベントが実施される都市。

注: これは、IN_PERSON または ハイブリッド

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 表示住所 条件付き必須

イベント開催地の住所または会場名 表示する必要があります。

注: これは、IN_PERSON または ハイブリッド

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 住所 任意 イベントが開催される場所の番地(該当する場合) あります。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 都道府県 任意 イベントが行われる州または都道府県(該当する場合) ホストされます。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

地域 - 郵便番号 任意 イベントを開催する地域の郵便番号(該当する場合) ホストされます。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 周辺地域 任意 イベントが開催されている地域(該当する場合)。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

終了時間 任意

イベントの終了予定時刻のエポック タイムスタンプ。

注: これはミリ秒単位で表されます。

エポック タイムスタンプ(ミリ秒)
説明 任意

エンティティを説明する 1 段落のテキスト。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

推奨テキストサイズは 180 文字

字幕リスト 任意

最大 3 つの字幕(各サブタイトルに 1 行のテキスト)。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

各サブタイトルの推奨テキストサイズ: 最大 50 文字

バッジ 任意

各バッジは、自由形式のテキスト(最大 15 文字)か小さい画像のいずれかです。

バッジ - テキスト 任意

バッジのタイトル

注: バッジにはテキストまたは画像が必要です。

自由形式のテキスト

推奨テキストサイズは 15 文字以下

バッジ - 画像 任意

小さい画像

特別な UX の取り扱い(画像または動画にバッジが重なるなど) クリックします。

注: バッジにはテキストまたは画像が必要です。

詳しくは、画像の仕様をご覧ください。
価格 - 現在の価格 条件付きで必須

イベントのチケットまたはパスの現在の価格。

<ph type="x-smartling-placeholder"></ph> 取り消し線が引かれた価格を指定する場合は指定する必要があります。

自由形式のテキスト
価格 - StrikethroughPrice 任意 イベントのチケットまたはパスの元の価格。 自由形式のテキスト
価格のコールアウト 任意 プロモーション、イベント、メンバー割引(利用可能な場合)をアピールするための価格のコールアウト。

自由形式のテキスト

推奨テキストサイズは 45 文字未満(長すぎるテキスト) 省略記号が表示されます)

コンテンツ カテゴリ 任意 エンティティ内のコンテンツのカテゴリを記述します。

有効な列挙型のリスト

  • TYPE_MOVIES_AND_TV_SHOWS(例 - 映画)
  • TYPE_DIGITAL_GAMES(例 - e スポーツ)
  • TYPE_music(例 - コンサート)
  • TYPE_TRAVEL_AND_LOCAL(例 - ツアー、フェスティバル)
  • TYPE_HEALTH_AND_FITENESS(例 - ヨガのクラス)
  • TYPE_EDUCATION(例 - クラス)
  • TYPE_SPORTS(例 - サッカーの試合)
  • TYPE_DATING(例 - 会合)

[コンテンツ カテゴリ] セクションをご覧ください。 をご覧ください。

EventReservationEntity

属性 必須 / 任意 説明 形式
アクション URI 必須

プロバイダ アプリ内のエンティティへのディープリンク。

注: アトリビューションにはディープリンクを使用できます。<ph type="x-smartling-placeholder"></ph> よくある質問を参照する

URI
タイトル 必須 エンティティのタイトル。

文字列

推奨テキストサイズ: 最大 50 文字

開始時刻 必須

イベントの開始予定時間のエポック タイムスタンプ。

注: これはミリ秒単位で表されます。

エポック タイムスタンプ(ミリ秒)
イベントモード 必須

イベントがオンライン、対面、または あります。

列挙型: VIRTUAL、IN_PERSON、HYBRID
場所 - 国 条件付き必須

イベントが行われる国。

注: これは、IN_PERSON または ハイブリッド

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 市区町村 条件付き必須

イベントが実施される都市。

注: これは、IN_PERSON または ハイブリッド

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 表示住所 条件付き必須

イベント開催地の住所または会場名 表示する必要があります。

注: これは、IN_PERSON または ハイブリッド

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 住所 任意 イベントが開催される場所の番地(該当する場合) あります。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 都道府県 任意 イベントが行われる州または都道府県(該当する場合) ホストされます。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

地域 - 郵便番号 任意 イベントを開催する地域の郵便番号(該当する場合) ホストされます。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

場所 - 周辺地域 任意 イベントが開催されている地域(該当する場合)。

自由形式のテキスト

推奨テキストサイズは 20 文字以下

ポスター画像 任意

複数の画像が指定されている場合、1 つの画像のみが表示されます。 推奨のアスペクト比は 16:9 です

注: 画像を使用することを強くおすすめします。バッジが 上部と下部の両方で 24 dps の安全なスペースを確保 画像

詳しくは、画像の仕様をご覧ください。
終了時間 任意

イベントの終了予定時刻のエポック タイムスタンプ。

注: これはミリ秒単位で表されます。

エポック タイムスタンプ(ミリ秒)
サービス プロバイダ - 名前 任意

サービス プロバイダの名前。

注: サービスにはテキストと画像のどちらかが必要です。 接続します。

自由形式のテキスト。例: イベントの主催者やツアーの名前
サービス プロバイダ - 画像 任意

サービス プロバイダのロゴや画像。

注: サービスにはテキストと画像のどちらかが必要です。 接続します。

詳しくは、画像の仕様をご覧ください。
説明 任意

エンティティを説明する 1 段落のテキスト。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

推奨テキストサイズは 180 文字

字幕リスト 任意

最大 3 つの字幕(各サブタイトルに 1 行のテキスト)。

注: 説明または字幕のリストは、 両方ではなく表示されます

自由形式のテキスト

各サブタイトルの推奨テキストサイズ: 最大 50 文字

バッジ 任意

各バッジは、自由形式のテキスト(最大 15 文字)か小さい画像のいずれかです。

バッジ - テキスト 任意

バッジのタイトル

注: バッジにはテキストまたは画像が必要です。

自由形式のテキスト

推奨テキストサイズは 15 文字以下

バッジ - 画像 任意

小さい画像

特別な UX の取り扱い(画像または動画にバッジが重なるなど) クリックします。

注: バッジにはテキストまたは画像が必要です。

詳しくは、画像の仕様をご覧ください。
予約 ID 任意 イベント予約の予約 ID。 自由形式のテキスト
価格 - 現在の価格 条件付きで必須

イベントのチケットまたはパスの現在の価格。

<ph type="x-smartling-placeholder"></ph> 取り消し線が引かれた価格を指定する場合は指定する必要があります。

自由形式のテキスト
価格 - StrikethroughPrice 任意 イベントのチケットまたはパスの元の価格。 自由形式のテキスト
価格のコールアウト 任意 プロモーション、イベント、メンバー割引(利用可能な場合)をアピールするための価格のコールアウト。

自由形式のテキスト

推奨テキストサイズは 45 文字未満(長すぎるテキスト) 省略記号が表示されます)

評価 - 最高値 任意

段階別評価の最高値。

現在の評価値も指定する場合は必須です。

0.0 以上の数値。
評価 - 現在値 任意

段階別評価の現在の値。

評価の最高値も指定する場合は必須です。

0.0 以上の数値。
評価 - 件数 任意

イベントの評価の件数。

注: このフィールドは、アプリが許可または拒否を ユーザーへの表示方法を制御します。簡潔な文字列を指定する リソースを定義できます。たとえば、カウントが 1,000,000 を超える場合、1M などの略語を使用して、 サイズが小さい場合は切り捨てられます

文字列
評価 - 件数 任意

イベントの評価の件数。

注: 使用する必要があります。[件数] と [件数] の両方がある場合 Count を使用してユーザーに表示します。

Long
コンテンツ カテゴリ 任意 エンティティ内のコンテンツのカテゴリを記述します。

有効な列挙型のリスト

  • TYPE_MOVIES_AND_TV_SHOWS(例 - 映画)
  • TYPE_DIGITAL_GAMES(例 - e スポーツ)
  • TYPE_music(例 - コンサート)
  • TYPE_TRAVEL_AND_LOCAL(例 - ツアー、フェスティバル)
  • TYPE_HEALTH_AND_FITENESS(例 - ヨガのクラス)
  • TYPE_EDUCATION(例 - クラス)
  • TYPE_SPORTS(例 - サッカーの試合)
  • TYPE_DATING(例 - 会合)

[コンテンツ カテゴリ] セクションをご覧ください。 をご覧ください。

画像の仕様

画像アセットに必要な仕様を次の表に示します。

アスペクト比 最小ピクセル数 推奨ピクセル数

スクエア(1×1)

推奨

300×300 1200×1200
横向き(1.91×1) 600×314 1200×628
縦向き(4×5) 480×600 960×1200

Google が画像にアクセスできるようにするため、画像は公開 CDN でホストする必要があります。

ファイル形式

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

Google が画像にアクセスできるようにするため、画像は公開 CDN でホストする必要があります。

コンテンツ カテゴリを使用するためのガイドライン

  1. ArticleEntityGenericPhotosEntity などのエンティティには、 コンテンツカテゴリも使用できますたとえば EventEntityEventReservationEntityPersonEntity、サブセットのみ 次のカテゴリが対象となります。広告配信の対象となるカテゴリのリストを確認する エンティティ タイプを指定してから、リストにデータを入力します。
  2. コンテンツ カテゴリによっては、組み合わせではなく特定のエンティティ タイプを使用する ContentCategory を使用すると、

    • TYPE_MOVIES_AND_TV_SHOWS - 次のエンティティをご覧ください: 使用する前に、統合ガイドを見る 一般的なエンティティです。
    • TYPE_BOOKS - 書籍の EbookEntity の実装前に、 一般的なエンティティです。
    • TYPE_AUDIOBOOKS - チェックアウト AudiobookEntity が次の日付より前 一般的なエンティティを使って識別されます
    • TYPE_SHOPPING - 決済 ShoppingEntity: 一般的なエンティティを使って識別されます
    • TYPE_FOOD_AND_DRINK - エンティティのチェックアウト 食品統合ガイド( 一般的なエンティティです。
  3. ContentCategory フィールドは省略可能で、 コンテンツが前述のカテゴリのいずれにも属していない。

  4. コンテンツ カテゴリが複数ある場合は、順番に入力してください。 最も関連性の高いコンテンツ カテゴリが配置されたコンテンツとの関連性の度合い リストの先頭に表示されます。

ステップ 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());

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

  • デベロッパー パートナーが提供した既存の 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());

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

  • デベロッパー パートナーが提供した既存の 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());

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

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

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

publishUserAccountManagementRequest

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

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

属性 必須 / 任意 説明
アクション URI 必須 アクションへのディープリンク(アプリのログインページへの移動など)
画像 省略可 - 指定しない場合は、タイトルを指定する必要があります

カードに表示される画像

解像度 1264×712 でアスペクト比 16×9 の画像

タイトル 省略可 - 指定しない場合は、画像を指定する必要があります カード上のタイトル
アクション テキスト 任意 行動を促すフレーズ(ログインなど)で表示されるテキスト
字幕 任意 カードの字幕(省略可)

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

サービスがリクエストを受信すると、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 は ログインカードを公開することをおすすめしますなんらかの理由でプロバイダが ログインカードを公開する場合は、 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();

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

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

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

エラー処理

公開 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 として返され、その原因はエラーコードとして含まれます。

エラーコード
SERVICE_NOT_FOUND そのデバイスではこのサービスを利用できません。
SERVICE_NOT_AVAILABLE サービスをそのデバイスで利用することはできますが、呼び出し時には利用できません(明示的に無効になっている場合など)。
SERVICE_CALL_EXECUTION_FAILURE スレッドに関する問題が発生し、タスクを実行できませんでした。その場合は再試行できます。
SERVICE_CALL_PERMISSION_DENIED 呼び出し元がサービスの呼び出しを行うことができません。
SERVICE_CALL_INVALID_ARGUMENT リクエストに無効なデータが含まれています(クラスタ数が許容数を超えているなど)。
SERVICE_CALL_INTERNAL サービス側でエラーが発生しています。
SERVICE_CALL_RESOURCE_EXHAUSTED サービスの呼び出し頻度が高すぎます。

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

ジョブを介してコンテンツ公開 API の呼び出しを行うだけでなく、コンテンツ公開のリクエストを受信するために BroadcastReceiver を設定する必要もあります。

ブロードキャスト インテントの主目的は、アプリの再有効化とデータ同期の強制です。ブロードキャスト インテントは、頻繁に送信されることを想定した設計にはなっていません。Engage のサービスが、コンテンツが古い可能性がある(1 週間前など)と判断した場合にのみトリガーされます。そうすることで、アプリが長時間実行されていない場合でも、より確実にユーザーに新しいコンテンツを提供できます。

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

  • 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 に関するよくある質問をご覧ください。

お問い合わせ

問い合わせ先 engage-developers@google.com(該当する場合) お問い合わせください

次のステップ

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

  • メールを送信: engage-developers@google.com、 Google によるテストの準備が整った統合 APK を添付します。
  • Google 内部で検証と審査を行い、想定どおりに統合が機能するかどうかを確認します。変更が必要な場合は、Google から必要な詳細事項をご連絡します。
  • テストが完了し、変更の必要もない場合は、Google からご連絡差し上げます。 更新された統合済みの APK を 。
  • 更新された APK が Google Play ストアに公開されていることを Google が確認したら、おすすめコンテンツ注目コンテンツ連続性の各クラスタが公開され、ユーザーに表示されます。