> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# getPrivacySetting

获取隐私设置状态。

## 扫码预览

![扫码预览 getPrivacySetting](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fopen%252Fget-privacy-setting%252Findex)

## 支持版本

前端库版本不低于 `0.0.19`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>支持</td></tr>
</tbody>
</table>

## 使用说明

- 用于在展示隐私相关能力前判断是否需要引导用户完成隐私协议授权。

## 调用方式

### 异步 API

```typescript
getPrivacySetting(params?: object): Promise<PrivacySettingResult>
```

## 入参

无。

## 调用示例

```typescript
import { getPrivacySetting } from '@doubao-dev/framework/api';

const { needAuthorization } = await getPrivacySetting();

console.log(needAuthorization);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>needAuthorization</code></td><td><code>boolean</code></td><td>是</td><td>是否需要用户对隐私协议进行授权。</td></tr>
</tbody>
</table>

### 返回示例

```json
{
  "needAuthorization": false
}
```

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 错误码

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
</tbody>
</table>

## 平台差异

- 该 API 无专属错误码，失败时统一返回 102。
