@amazon-devices/kepler-content-personalization

​

はじめに

​

セットアップ

1. package.jsonファイルのdependenciesセクションに、以下のライブラリ依存関係を追加します。

    "@amazon-devices/kepler-content-personalization": "~1.3.3",
    "@amazon-devices/kepler-epg-provider": "~1.9.124",
    "@amazon-devices/headless-task-manager": "~1.0.0"

• kepler-content-personalizationパッケージは、コンテンツパーソナライゼーションデータをシステムに送信する機能を提供します。
• amzn/kepler-epg-providerパッケージは、PlaybackEventデータモデルのchannelDescriptorに使用される依存関係を提供します。
• headless-task-managerパッケージは、データプルバックグラウンドサービスをシステムに登録する機能を提供します。

2. manifest.tomlに、以下の権限を追加します。
    schema-version = 1
   
    ## パッケージを定義します
    [package]
    title = "Vega Video app"
    version = "2.17.0"
    id = "com.amazondeveloper.keplervideoapp"
   
    [components]
    ## アプリの対話型コンポーネントを定義します（まだ存在しない場合）
    [[components.interactive]]
    id = "com.amazondeveloper.keplervideoapp.main"
    library-name = "com.amazondeveloper.keplervideoapp"
    runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"
    categories = ["com.amazon.category.kva"]
    launch-type = "singleton"
   
    ## データリクエストを処理できるアプリのサービスコンポーネントを定義します。
    [[components.service]]
    id = "com.amazondeveloper.keplervideoapp.content.dataRefresh.provider"
    runtime-module = "/com.amazon.kepler.headless.runtime.loader_2@IKeplerScript_2_0"
    launch-type = "singleton"
    categories = ["com.amazon.category.kepler.media"]
   
    ## 各コンポーネントのプロセスグループを定義します
    [processes]
    [[processes.group]]
    component-ids = ["com.amazondeveloper.keplervideoapp.main"]
   
    [[processes.group]]
    component-ids = ["com.amazondeveloper.keplervideoapp.content.dataRefresh.provider"]
   
    [wants]
    ## アプリがコンテンツパーソナライゼーションデータサービスに依存していることを定義します
    [[wants.service]]
    id = "com.amazon.tv.developer.dataservice"
   
    [needs]
    ## コンテンツパーソナライゼーションインターフェイスを使用してデータを提供するためにアプリが必要とする権限を定義します
    [[needs.privilege]]
    id = "com.amazon.tv.content-personalization.privilege.provide-data"
   
    [offers]
    ## アプリのデータ更新サービスコンポーネントを定義します。
    [[offers.service]]
    id = "com.amazondeveloper.keplervideoapp.content.dataRefresh.provider"
   
    ## アプリの対話型コンポーネントを定義します
    [[offers.interaction]]
    id = "com.amazondeveloper.keplervideoapp.main"
   
    ## コンテンツパーソナライゼーションのサポートを宣言するためのエクストラを追加します
    [[extras]]
    key = "interface.provider"
    ## アカウントログインまたはコンテンツランチャーインターフェイスを利用している場合は、
    ## component-idを適切なサービスコンポーネントに置き換えます。アカウントログイン統合ガイドに従ってください。
    component-id = "com.amazondeveloper.keplervideoapp.content.dataRefresh.provider"
   
    ## コンテンツパーソナライゼーションのインターフェイスと属性のサポートを定義します
    [[extras.value.application.interface]]
    interface_name = "com.amazon.kepler.media.IContentPersonalizationServer"
    attribute_options = ["SupportedCustomerLists", "DataRefreshComponentId"]
   
    [extras.value.application.interface.static_values]
    SupportedCustomerLists = ["Watchlist"]
    DataRefreshComponentId = "com.amazondeveloper.keplervideoapp.content.dataRefresh.provider"
   

​

関連トピック

​

APIリファレンス

​

クラス

• BaseError
• ContentEntitlementBuilder - ContentEntitlementオブジェクトを作成するためのビルダー。
• ContentIdBuilder - ContentIdオブジェクトを作成するためのビルダー。
• ContentInteractionBuilder - ContentInteractionオブジェクトを作成するためのビルダー。
• CustomerListEntryBuilder - CustomerListEntryオブジェクトを作成するためのビルダー。
• InvalidArgumentError - 無効な引数がメソッドに渡されたときにスローされるエラー。
• PlaybackEventBuilder - PlaybackEventオブジェクトを作成するためのビルダー。
• ProfileIdBuilder - ProfileIdオブジェクトを作成するためのビルダー。

​

インターフェイス

• IContentEntitlement - ユーザーの個々のコンテンツエンタイトルメントを表すインターフェイス。ContentEntitlementBuilderを使用して作成されます。
• IContentEntitlementsHandler - コンテンツプロバイダーアプリがAmazonのコンテンツパーソナライゼーションサービスからのコマンドを処理し、コンテンツエンタイトルメントデータを取得するためのインターフェイス。
• IContentEntitlementsProvider - コンテンツエンタイトルメントデータを要求するコマンドへのレスポンスを提供します。
• IContentId - コンテンツIDを表すインターフェイス。ContentIdBuilderを使用して作成します。
• IContentInteraction - ユーザーによるコンテンツのインタラクションを表すインターフェイス。ContentInteractionBuilderを使用して作成します。
• IContentPersonalizationServer - コンテンツパーソナライゼーションサーバーのインターフェイス。
• ICustomerListEntriesHandler - コンテンツプロバイダーアプリがAmazonのコンテンツパーソナライゼーションサービスからのコマンドを処理し、ユーザー管理リストのデータを取得するためのインターフェイス。
• ICustomerListEntriesProvider - ユーザー管理リストのデータを要求するコマンドへのレスポンスを提供します。
• ICustomerListEntry - ユーザー管理リストのエントリを表すインターフェイス。CustomerListEntryBuilderを使用して作成します。
• IPlaybackEvent - ある時点でのユーザーの再生状態を表すインターフェイス。PlaybackEventBuilderを使用して作成します。
• IPlaybackEventsHandler - コンテンツプロバイダーアプリがAmazonのコンテンツパーソナライゼーションサービスからのコマンドを処理し、再生イベントデータを取得するためのインターフェイス。
• IPlaybackEventsProvider - 再生イベントデータを要求するコマンドへのレスポンスを提供します。
• IProfileId - 名前空間内のプロフィールIDを表すインターフェイス。

​

列挙型

• ContentIdNamespaces - ContentId名前空間のオプションを表す列挙型。
• ContentInteractionType - コンテンツインタラクションのタイプを表す列挙型。
• CustomerListType - ユーザーが管理するリストのタイプを表す列挙型。
• EntitlementType - コンテンツエンタイトルメントのタイプを表す列挙型。
• PlaybackState - コンテンツの再生状態を表す列挙型。
• ProfileIdNamespaces - ProfileId名前空間のオプションを表す列挙型。