@amazon-devices/kepler-content-personalization

Vega内容个性化API提供的功能可让应用开发者向客户提供个性化体验并展示相关内容。

开始使用

设置

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视频应用"
    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"
    ## 如果您使用账户登录或内容启动器接口，
    ## 使用相应的服务组件替换组件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"
   

   警告： 每种接口配置必须保持独立。不要在清单文件中的不同接口之间合并或混合属性。

相关主题

开始使用Vega内容个性化

API参考

类

• BaseError
• ContentEntitlementBuilder — 用于创建ContentEntitlement对象的构建器。
• ContentIdBuilder — 用于创建ContentId对象的构建器。
• ContentInteractionBuilder — 用于创建ContentInteraction对象的构建器。
• CustomerListEntryBuilder — 用于创建CustomerListEntry对象的构建器。
• InvalidArgumentError — 将无效参数传递给方法时抛出的错误。
• PlaybackEventBuilder — 用于创建PlaybackEvent对象的构建器。
• ProfileIdBuilder — 用于创建ProfileId对象的构建器。

接口

• IContentEntitlement — 表示客户个人内容权利的接口。使用ContentEntitlementBuilder创建。
• IContentEntitlementHandler — 内容提供商应用为处理来自亚马逊内容个性化服务命令而实现的接口，用于获取内容权利数据。
• IContentEntitlementsProvider — 用于响应请求内容权利数据的命令。
• IContentId — 表示内容ID的接口。使用ContentIdBuilder创建。
• IContentInteraction — 表示客户与内容交互的接口。使用ContentInteractionBuilder创建。
• IContentPersonalizationServer — 内容个性化服务器接口
• ICustomerListEntriesHandler — 内容提供商应用实现的接口，用于处理来自亚马逊内容个性化服务的命令，以获取客户管理列表数据。
• ICustomerListEntriesProvider — 用于响应请求客户管理列表数据的命令。
• ICustomerListEntry — 表示客户管理列表中条目的接口。使用CustomerListEntryBuilder创建。
• IPlaybackEvent — 表示某一时刻客户播放状态的接口。使用PlaybackEventBuilder创建。
• IPlaybackEventsHandler — 内容提供商应用为处理来自亚马逊内容个性化服务命令而实现的接口，用于获取播放事件数据。
• IPlaybackEventsProvider — 用于响应请求播放事件数据的命令。
• IProfileId — 表示命名空间内配置文件ID的接口。

枚举

• ContentIdNamespaces — 表示ContentId命名空间选项的枚举。
• ContentInteractionType — 表示内容交互类型的枚举。
• CustomerListType — 表示客户管理的列表类型的枚举。
• EntitlementType — 表示内容权利类型的枚举。
• PlaybackState — 表示内容播放状态的枚举。
• ProfileIdNamespaces — 表示ProfileId命名空间选项的枚举。

---

Last updated: 2026年7月22日