# OAID Service Component

## Introduction

The Open Anonymous Device Identifier (OAID) service facilitates personalized ad placement based on OAIDs, each of which is a non-permanent device identifier. The service provides personalized ads for users while protecting their personal data privacy. It can also interact with third-party tracking platforms to provide conversion attribution analysis for advertisers.

## Directory Structure

```
/domains/advertising/oaid # Service code of the OAID service component
├── interfaces                         # API code
├── profile                            # Service configuration profile
├── services                           # Service code
├── test                               # Test cases
├── LICENSE                            # License file
└── bundle.json                        # Build file
```

## How to Use

### Obtaining an OAID

You can use the APIs provided in this repository to obtain OAIDs.

1. Request the ad tracking permission.

   Configure the [ohos.permission.APP_TRACKING_CONSENT](https://docs.openharmony.cn/pages/v4.0/zh-cn/application-dev/security/permission-list.md/) permission in the **module.json5** file of the module.

   ```javascript
   {
     "module": {
       "requestPermissions": [
         {
           "name": "ohos.permission.APP_TRACKING_CONSENT" // Request the ad tracking permission.
         }
       ]
     }
   }
   ```

2. Request authorization from the user by displaying a dialog box when the application is started.

   ```javascript
   import abilityAccessCtrl from '@ohos.abilityAccessCtrl';

   private requestOAIDTrackingConsentPermissions(context: any): void {
     // Display a dialog box when the page is displayed to request the user to grant the ad tracking permission.
     const atManager = abilityAccessCtrl.createAtManager();
     try {
       atManager.requestPermissionsFromUser(context, ["ohos.permission.APP_TRACKING_CONSENT"]).then((data) => {
         if (data.authResults[0] == 0) {
           console.info(`request permission success`);
         } else {
           console.info(`user rejected`);
         }
       }).catch((err) => {
         console.error(`request permission failed, error message: ${err.message}`);
       })
     } catch(err) {
       console.error(`catch err->${JSON.stringify(err)}`);
     }
   }
   ```

3. Obtain an OAID.

- Obtain an OAID through the callback function.

  ```javascript
  import identifier from '@ohos.identifier.oaid';

  private getOaidByCallback() {
    try {
      identifier.getOAID((err, data) => {
        if (err.code) {
          console.info(`getAdsIdentifierInfo failed, message: ${err.message}`);
  	  } else {
  		const oaid = data;
  		console.error(`getOaidFromOaidSaAPi by callback success`);
  	  }
  	});
    } catch (err) {
      console.error(`catch err->${JSON.stringify(err)}`);
    }
  }
  ```

- Obtain an OAID through the promise.

  ```javascript
  import identifier from '@ohos.identifier.oaid';

  private getOaidByPromise() {
    try {
      // Obtain an OAID.
      identifier.getOAID().then((data) => {
        const oaid = data;
        console.info(`getAdsIdentifierInfo by promise success`);
      }).catch((err) => {
        console.error(`getAdsIdentifierInfo failed, message: ${err.message}`);
      })
    } catch (err) {
      console.error(`catch err->${JSON.stringify(err)}`);
    }
  }
  ```

### Resetting the OAID

You can use the API provided in this repository to reset OAIDs.  The API is a system API.

```javascript
import identifier from '@ohos.identifier.oaid';

private resetOaid() {
  try {
    identifier.resetOAID();
  } catch (err) {
    console.error(`reset oaid catch error: ${err.code} ${err.message}`);
  }
}
```

## Repositories Involved

# 广告标识服务部件

## 简介

开放匿名设备标识符（Open Anonymous Device Identifier, OAID，以下简称OAID）：是一种非永久性设备标识符，基于开放匿名设备标识符，可在保护用户个人数据隐私安全的前提下，向用户提供个性化广告，同时三方监测平台也可以向广告主提供转化归因分析。


## 目录

```
/domains/advertising/oaid  # 广告标识服务部件业务代码
├── interfaces                         # 接口代码
├── profile                            # 服务配置文件
├── services                           # 服务代码
├── test                               # 测试用例
├── LICENSE                            # 证书文件
└── bundle.json                        # 编译文件
```

## 使用说明

### 获取OAID

可以使用此仓库内提供的接口获取OAID。以下步骤描述了如何使用接口获取OAID。

1. 申请广告跟踪权限

   在模块的module.json5文件中，申请[ohos.permission.APP_TRACKING_CONSENT](https://docs.openharmony.cn/pages/v4.0/zh-cn/application-dev/security/permission-list.md/)权限。

   ```

   {
     "module": {
       "requestPermissions": [
         {
           "name": "ohos.permission.APP_TRACKING_CONSENT" // 申请广告跟踪权限
         }
       ]
     }
   }
   ```

2. 在应用启动时触发动态授权弹框，向用户请求授权。

  ```
  import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
  import { BusinessError } from '@ohos.base';
  import hilog from '@ohos.hilog';

  private requestOAIDTrackingConsentPermissions(context: common.Context): void {
    // 进入页面时触发动态授权弹框，向用户请求授权广告跟踪权限
    const atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
     try {
       atManager.requestPermissionsFromUser(context, ["ohos.permission.APP_TRACKING_CONSENT"]).then((data) => {
         if (data.authResults[0] == 0) {
           hilog.info(0x0000, 'testTag', '%{public}s', 'request permission success');
         } else {
           hilog.info(0x0000, 'testTag', '%{public}s', `user rejected`);
         }
       }).catch((err) => {
         const e: BusinessError = err as BusinessError;
         hilog.error(0x0000, 'testTag', '%{public}s', `request permission failed, error message: ${e.message}`);
       })
     } catch(err) {
       const e: BusinessError = err as BusinessError;
       hilog.error(0x0000, 'testTag', '%{public}s', `catch err->${JSON.stringify(e)}`);
     }
   }
  ```

3. 获取OAID信息

- 通过Callback回调函数获取OAID

  ```

  import identifier from '@ohos.identifier.oaid';
  import hilog from '@ohos.hilog';
  import { BusinessError } from '@ohos.base';

  try {
    identifier.getOAID((err, data) => {
      if (err.code) {
        hilog.info(0x0000, 'testTag', '%{public}s', `getOAID failed, message: ${err.message}`);
    } else {
      const oaid: string = data;
      hilog.info(0x0000, 'testTag', '%{public}s', `getOAID by callback success`);
    }
    });
  } catch (err) {
    const e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'get oaid catch error: %{public}d %{public}s', e.code, e.message);
  }
  ```

- 通过Promise异步获取OAID

  ```

  import identifier from '@ohos.identifier.oaid';
  import hilog from '@ohos.hilog';
  import { BusinessError } from '@ohos.base';

  try {
    identifier.getOAID().then((data) => {
      const oaid: string = data;
      hilog.info(0x0000, 'testTag', '%{public}s', `get oaid by callback success`);
    }).catch((err) => {
      hilog.info(0x0000, 'testTag', '%{public}s', `get oaid failed, message: ${(err as BusinessError).message}`);
    })
  } catch (err) {
    const e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'get oaid catch error: %{public}d %{public}s', e.code, e.message);
  }
  ```

### 重置OAID

可以使用此仓库内提供的接口重置OAID。以下步骤描述了如何使用接口重置OAID。该接口为系统接口。

```

  import identifier from '@ohos.identifier.oaid';
  import hilog from '@ohos.hilog';
  import { BusinessError } from '@ohos.base';

  try {
    identifier.resetOAID();
  } catch (err) {
    const e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'reset oaid catch error: %{public}d %{public}s', e.code, e.message);
  }
```

## 相关仓