IdentifiersWrapper

Kepler Identifiers APIは、アプリやユーザーのペルソナのコンテキストでさまざまな識別子やデバイス関連のメタデータを管理するためのユーティリティを提供します。これには、UUID、ユーザーエージェント文字列、わかりやすいデバイス名などの一意の識別子を生成、取得、および管理するための機能が含まれています。

コンストラクタ

new IdentifiersWrapper()

new IdentifiersWrapper(): IdentifiersWrapper

戻り値

IdentifiersWrapper

メソッド

addAdvertisingIdListener()

static addAdvertisingIdListener(listener): Promise<ISubscription>

注： 現在、このメソッドはサポートされていません。

広告IDの変更のリスナーを追加します。

パラメーター

listener

IAdvertisingIdListener

広告IDが変更されたときに通知を受けるリスナー。

戻り値

Promise<ISubscription>

イベント受信を解除するために使用できるISubscriptionオブジェクト。

---

addFriendlyDeviceNameListener()

static addFriendlyDeviceNameListener(listener): Promise<ISubscription>

注： 現在、このメソッドはサポートされていません。

デバイスの通称の変更に対するリスナーを追加します。

パラメーター

listener

IFriendlyDeviceNameListener

デバイスの通称が変更されたときに通知されるリスナー。

戻り値

Promise<ISubscription>

イベント受信を解除するために使用できるISubscriptionオブジェクト。

---

addVendorTrackingIdListener()

static addVendorTrackingIdListener(listener): Promise<ISubscription>

注： 現在、このメソッドはサポートされていません。

トラッキングIDの変更に対するリスナーを追加します。

パラメーター

listener

IVendorTrackingIdListener

トラッキングIDが変更されたときに通知されるリスナー。

戻り値

Promise<ISubscription>

イベント受信を解除するために使用できるISubscriptionオブジェクト。

---

disableAdvertisingId()

static disableAdvertisingId(): Promise<void>

注： 現在、このメソッドはサポートされていません。

特定のユーザーの広告IDのサポートを無効にします。呼び出しのたびに、すでに無効になっているかどうかを確認します。無効になっていない場合は処理を続行し、無効になっている場合はリクエストを無視します。このAPIには権限com.amazon.kepler.identifiers.privilege.advertising-id.modifyが必要です。

戻り値

Promise<void>

---

disableVendorTrackingId()

static disableVendorTrackingId(): Promise<void>

注： 現在、このメソッドはサポートされていません。

特定のベンダーの特定のユーザーに対するトラッキングIDのサポートを無効にします。トラッキングIDがすでに無効になっている場合、リクエストは無視されます。このAPIには権限com.amazon.kepler.identifiers.privilege.tracking-id.modifyが必要です。

戻り値

Promise<void>

---

enableAdvertisingId()

static enableAdvertisingId(): Promise<void>

注： 現在、このメソッドはサポートされていません。

オプトイン時に、指定したユーザーの広告IDのサポートを有効にします。事前に設定されていない場合は、広告IDの新しいUUIDを生成します。呼び出しのたびに、すでに有効になっているかどうかを確認します。無効になっていない場合は処理を続行し、無効になっている場合はリクエストを無視します。このAPIには権限com.amazon.kepler.identifiers.privilege.advertising-id.modifyが必要です。

戻り値

Promise<void>

---

enableVendorTrackingId()

static enableVendorTrackingId(): Promise<void>

注： 現在、このメソッドはサポートされていません。

特定のベンダーの特定のユーザーのトラッキングIDのサポートを有効にします（過去にオプトアウトされている場合）。呼び出しのたびに、すでに有効になっているかどうかを確認します。無効になっていない場合は処理を続行し、無効になっている場合はリクエストを無視します。このAPIには権限com.amazon.kepler.identifiers.privilege.tracking-id.modifyが必要です。

戻り値

Promise<void>

---

generateUuidV4()

static generateUuidV4(): Uuid

カスタムIDの新しいランダムなUUID（バージョン4アルゴリズム）を生成します。

戻り値

Uuid

新しいUUID。

---

getAdvertisingId()

static getAdvertisingId(): Promise<Uuid>

注： 現在、このメソッドはサポートされていません。

現在のペルソナの広告IDを取得します。広告IDはアプリ間のトラッキングに使用され、ユーザーがリセットできます。このIDは、ユーザーがオプトインした場合にのみ使用できます。ユーザーがオプトインしていない場合、返される値は0000-0000-0000-0000です。

戻り値

Promise<Uuid>

広告IDのUUID。

---

getFriendlyDeviceName()

static getFriendlyDeviceName(): Promise<string>

現在のペルソナのデバイスの通称を取得します。この名前はアプリケーション間で共有され、ユーザーが変更できます。

次のいずれかを返します。

• ユーザーがカスタマイズしたデバイス名が存在し、かつ呼び出し元が「com.amazon.devconf.privilege.identifiers.device-friendly-name」の実行時権限を持っている場合は、ユーザーがカスタマイズしたデバイス名
• 以下のいずれかの場合は、デバイスモデル名
  • ユーザーがカスタマイズした名前を設定していない
  • 呼び出し元に必要な権限がない

戻り値

Promise<string>

このデバイスの通称。ユーザーがカスタマイズした名前（設定されていて権限が付与されている場合）またはデバイスモデル名。

---

getUserAgent()

static getUserAgent(): Promise<string>

デバイスの識別に使用されるユーザーエージェント文字列を取得します。これは、デバイスモデル、OSバージョンなどを含むプロファイル依存情報です。例： 「Amazon-TV /1.0 () () 」。注： ユーザーエージェント文字列のセマンティクスは、複数の要因によって異なる場合があります。文字列値はそのまま使用し、いかなる種類の解析にも依存しないことをお勧めします。

戻り値

Promise<string>

---

getVendorTrackingId()

static getVendorTrackingId(): Promise<Uuid>

呼び出し元のアプリケーションに署名しているベンダーのトラッキングIDのUUIDを取得します。トラッキングIDはユーザーが再設定でき、単一ベンダーのすべてのアプリケーションを追跡できます。このIDは、ユーザーがオプトインした場合にのみ使用できます。ユーザーはデフォルトでオプトインされています。ただし、オプトアウトすることもできます。ユーザーがオプトアウトした場合、この関数はnullのUUID（0000-0000-0000-0000）を返します。

戻り値

Promise<Uuid>

トラッキングIDのUUID。

---

resetAdvertisingId()

static resetAdvertisingId(): Promise<void>

注： 現在、このメソッドはサポートされていません。

広告IDをリセットします。このAPIには権限com.amazon.kepler.identifiers.privilege.advertising-id.modifyが必要です。

戻り値

Promise<void>

---

resetVendorTrackingId()

static resetVendorTrackingId(): Promise<void>

注： 現在、このメソッドはサポートされていません。

トラッキングIDを新しいUUIDにリセットします。このAPIには権限com.amazon.kepler.identifiers.privilege.tracking-id.modifyが必要です。

戻り値

Promise<void>

---

setFriendlyDeviceName()

static setFriendlyDeviceName(name): Promise<void>

現在のペルソナに新しい通称を設定します。

パラメーター

name

string

デバイスの新しい通称。デバイスの通称にはUTF-8文字を使用できます。有効な入力は、最小2バイト、最大60バイトのUTF-8エンコーディングです。このAPIはアクセス制御されており、com.amazon.devconf.privilege.identifiers.device-friendly-name.writeという権限が必要です。

戻り値

Promise<void>

---

Last updated: 2025年10月2日