• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.identifier.oaid (开放匿名设备标识服务)
2
3<!--Kit: Ads Kit-->
4<!--Subsystem: Advertising-->
5<!--Owner: @SukiEvas-->
6<!--Designer: @zhansf1988-->
7<!--Tester: @hongmei_may-->
8<!--Adviser: @RayShih-->
9
10本模块提供开放匿名设备标识符(Open Anonymous Device Identifier, 以下简称OAID)的获取能力。
11
12> **说明:**<br/>
13> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。<br/>
14> 使用开放匿名设备标识服务接口,需[向用户申请授权](../../security/AccessToken/request-user-authorization.md):ohos.permission.APP_TRACKING_CONSENT15
16## 导入模块
17
18```ts
19import { identifier } from '@kit.AdsKit';
20```
21
22## identifier.getOAID
23
24getOAID(): Promise&lt;string&gt;
25
26获取开放匿名设备标识符(OAID),使用Promise异步返回。
27
28**需要权限:** ohos.permission.APP_TRACKING_CONSENT
29
30**系统能力:** SystemCapability.Advertising.OAID
31
32**返回值:**
33
34| 类型                  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                           |
35|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
36| Promise&lt;string&gt; | Promise对象。返回开放匿名设备标识符(OAID)。<br/>1.如应用已配置ohos.permission.APP_TRACKING_CONSENT权限,且跨应用关联访问权限为“允许”,则返回OAID。<br/>2.如应用已配置ohos.permission.APP_TRACKING_CONSENT权限,且跨应用关联访问权限为“禁止”,则返回00000000-0000-0000-0000-000000000000。<br/>3.如应用未配置ohos.permission.APP_TRACKING_CONSENT权限,则返回00000000-0000-0000-0000-000000000000。 |
37
38**错误码:**
39
40以下错误码的详细介绍请参见[开放匿名设备标识服务错误码参考](errorcode-oaid.md)。
41
42| 错误码ID | 错误信息                         |
43|----------|----------------------------------|
44| 17300001 | System&nbsp;internal&nbsp;error. |
45
46**示例:**
47
48```ts
49import { identifier } from '@kit.AdsKit';
50
51identifier.getOAID().then((data: string) => {
52  const oaid: string = data;
53});
54```
55
56## identifier.getOAID
57
58getOAID(callback: AsyncCallback&lt;string&gt;): void
59
60获取开放匿名设备标识符(OAID),使用回调函数异步获取。
61
62**需要权限:** ohos.permission.APP_TRACKING_CONSENT
63
64**系统能力:** SystemCapability.Advertising.OAID
65
66**参数:**
67
68| 参数名   | 类型                        | 必填 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                         |
69|----------|-----------------------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
70| callback | AsyncCallback&lt;string&gt; | 是   | 异步获取开放匿名设备标识符(OAID)的回调。<br/>1.如应用已配置ohos.permission.APP_TRACKING_CONSENT权限,且跨应用关联访问权限为“允许”,则返回OAID。<br/>2.如应用已配置ohos.permission.APP_TRACKING_CONSENT权限,且跨应用关联访问权限为“禁止”,则返回00000000-0000-0000-0000-000000000000。<br/>3.如应用未配置ohos.permission.APP_TRACKING_CONSENT权限,则返回00000000-0000-0000-0000-000000000000。 |
71
72**错误码:**
73
74以下错误码的详细介绍请参见[开放匿名设备标识服务错误码参考](errorcode-oaid.md)。
75
76| 错误码ID | 错误信息                         |
77|----------|----------------------------------|
78| 17300001 | System&nbsp;internal&nbsp;error. |
79
80**示例:**
81
82```ts
83import { identifier } from '@kit.AdsKit';
84import { BusinessError } from '@kit.BasicServicesKit';
85
86identifier.getOAID((err: BusinessError, data: string) => {
87  if (err.code) {
88    return;
89  }
90  const oaid: string = data;
91});
92```