IdentifiersWrapper

Kepler标识符API提供一系列实用工具，方便您在某个应用和用户角色场景中，管理各种标识符和与设备相关的元数据。它包括生成、检索和管理唯一标识符（例如UUID、用户代理字符串和易记型设备名称）的功能。

构造函数

new IdentifiersWrapper()

new IdentifiersWrapper(): IdentifiersWrapper

返回值

IdentifiersWrapper

方法

addAdvertisingIdListener()

static addAdvertisingIdListener(listener): Promise<ISubscription>

注意：​ 目前不支持此方法。

添加侦听器，监视广告标识符更改事件。

参数

listener

IAdvertisingIdListener

广告标识符更改时将通知的侦听器。

返回值

Promise<ISubscription>

ISubscription：一个ISubscription对象，可用于取消订阅相关事件。

---

addFriendlyDeviceNameListener()

static addFriendlyDeviceNameListener(listener): Promise<ISubscription>

注意：​ 目前不支持此方法。

添加侦听器，监视易记型设备名称更改事件。

参数

listener

IFriendlyDeviceNameListener

易记型设备名称更改时将通知的侦听器。

返回值

Promise<ISubscription>

ISubscription：一个ISubscription对象，可用于取消订阅相关事件。

---

addVendorTrackingIdListener()

static addVendorTrackingIdListener(listener): Promise<ISubscription>

注意：​ 目前不支持此方法。

添加侦听器，监视跟踪标识符更改事件。

参数

listener

IVendorTrackingIdListener

跟踪标识符更改时将通知的侦听器。

返回值

Promise<ISubscription>

ISubscription：一个ISubscription对象，可用于取消订阅相关事件。

---

disableAdvertisingId()

static disableAdvertisingId(): Promise<void>

注意：​ 目前不支持此方法。

禁用指定用户的广告标识符支持。每次调用时，它都会检查广告标识符是否已经被禁用了。如果还没有禁用，则继续执行；如果已经禁用了，它将忽略该请求。此API需要权限：com.amazon.kepler.identifiers.privilege.advertising-id.modify

返回值

Promise<void>

---

disableVendorTrackingId()

static disableVendorTrackingId(): Promise<void>

注意：​ 目前不支持此方法。

禁用特定供应商的指定用户的跟踪标识符支持。如果跟踪标识符已经被禁用了，则该请求将被忽略。此API需要权限：com.amazon.kepler.identifiers.privilege.tracking-id.modify

返回值

Promise<void>

---

enableAdvertisingId()

static enableAdvertisingId(): Promise<void>

注意：​ 目前不支持此方法。

在加入时，启用指定用户的广告标识符支持。如果之前未进行此设置，则将为广告标识符生成新的UUID。每次调用时，它都会检查广告标识符是否已经启用了。如果还没有禁用，则继续执行；如果已经禁用了，它将忽略该请求。此API需要权限：com.amazon.kepler.identifiers.privilege.advertising-id.modify

返回值

Promise<void>

---

enableVendorTrackingId()

static enableVendorTrackingId(): Promise<void>

注意：​ 目前不支持此方法。

启用特定供应商的指定用户的跟踪标识符支持（如果之前已选择退出）。每次调用时，它都会检查广告标识符是否已经启用了。如果还没有禁用，则继续执行；如果已经禁用了，它将忽略该请求。此API需要权限：com.amazon.kepler.identifiers.privilege.tracking-id.modify

返回值

Promise<void>

---

generateUuidV4()

static generateUuidV4(): Uuid

为自定义标识符生成新的随机UUID（版本4算法）。

返回值

Uuid

UUID：一个新的UUID。

---

getAdvertisingId()

static getAdvertisingId(): Promise<Uuid>

注意：​ 目前不支持此方法。

获取当前角色的广告标识符。该广告标识符用于跨应用跟踪，可由用户重置。只有在用户选择加入时，此标识符才可以使用。如果用户尚未选择加入，则返回的值为0000-0000-0000-0000。

返回值

Promise<Uuid>

一个广告标识符UUID。

---

getFriendlyDeviceName()

static getFriendlyDeviceName(): Promise<string>

获取当前角色的设备的易记型名称。多个应用程序共享该名称，可以由用户修改。

返回以下任一项：

• 用户自定义的设备名称，前提是该名称存在且调用者拥有“com.amazon.devconf.privilege.identifiers.device-friendly-name”运行时权限
• 如果满足以下任一条件，则返回设备型号名称：
  • 尚未设置用户自定义的名称
  • 调用者缺乏所需的权限

返回值

Promise<string>

此设备的易记型名称：用户自定义名称（如果已设置并获得权限）或设备型号名称。

---

getUserAgent()

static getUserAgent(): Promise<string>

获取用于识别设备的用户代理字符串。这是与配置文件相关的信息，包含设备型号、操作系统版本等。示例： “Amazon-TV /1.0 () () ”。注意：​ 用户代理字符串的语义可能会因多种因素而异。建议直接使用原始字符串值，不要用它进行任何类型的解析。

返回值

Promise<string>

---

getVendorTrackingId()

static getVendorTrackingId(): Promise<Uuid>

获取为调用方应用程序签名的供应商的跟踪标识符UUID。跟踪标识符可由用户重置，可用于跟踪来自单个供应商的所有应用程序。只有在用户选择加入时，此标识符才可以使用。系统默认用户已加入。但用户可以自行选择退出。如果用户选择退出，则该函数将返回一个空的UUID (0000-0000-0000-0000)。

返回值

Promise<Uuid>

UUID：一个跟踪标识符UUID。

---

resetAdvertisingId()

static resetAdvertisingId(): Promise<void>

注意：​ 目前不支持此方法。

重置广告标识符。此API需要权限：com.amazon.kepler.identifiers.privilege.advertising-id.modify

返回值

Promise<void>

---

resetVendorTrackingId()

static resetVendorTrackingId(): Promise<void>

注意：​ 目前不支持此方法。

将跟踪标识符重置为一个新的UUID。此API需要权限：com.amazon.kepler.identifiers.privilege.tracking-id.modify

返回值

Promise<void>

---

setFriendlyDeviceName()

static setFriendlyDeviceName(name): Promise<void>

为当前角色设置一个新的易记型名称。

参数

name

string

设备的新的易记型名称。设备易记型名称接受UTF-8字符。有效输入为UTF-8编码，最短2字节，最长60字节。此API有访问控制，需要权限：com.amazon.devconf.privilege.identifiers.device-friendly-name.write。

返回值

Promise<void>

---

Last updated: 2025年10月2日