# API 参考

> Web Offerwall JavaScript API 的详细参考。

## init##init

必须在显示 Offerwall 内容之前调用 init 函数。默认情况下会预加载 Offerwall 内容。

```javascript
Tapjoy('init', options);
```

| 选项                                                            | 类型          | 默认值             | 描述                                                                           |
| ------------------------------------------------------------- | ----------- | --------------- | ---------------------------------------------------------------------------- |
| `sdkKey</TableCell> <TableCell>ID</TableCell> <TableCell>`-\` | 应用程序 SDK 密钥 |                 |                                                                              |
| `publisherUserId`                                             | 字符串         | `-`             | 用于为用户发放奖励的发行商用户 ID。                                                          |
| `ageRestrictedUser`                                           | 布尔值         | `false`         | 如需查看值的描述，请参阅[用户隐私](./user-privacy.md)。                                       |
| `gdprConsentGiven`                                            | 布尔值         | `false`         | 如需查看值的描述，请参阅[用户隐私](./user-privacy.md)。                                       |
| `userSubjectToGdpr`                                           | 布尔值         | `false`         | 如需查看值的描述，请参阅[用户隐私](./user-privacy.md)。                                       |
| `usPrivacy`                                                   | 字符串         | `1---`          | 如需查看值的描述，请参阅[用户隐私](./user-privacy.md)。                                       |
| `eventName`                                                   | 字符串         | `#WebOfferwall` | 广告位名称。                                                                       |
| `preload`                                                     | 布尔值         | `false`         | 是否预加载 Offerwall 内容。                                                          |
| `callback`                                                    | 函数          | `() => {}`      | 初始化完成后的回调。                                                                   |
| `userTags`                                                    | 数组          | `[]`            | [用户标签](/grow/offerwall/monetization/dashboard/targeting.md)。例如：`TAG1`、`TAG2` |

## update##update

update 调用会更新初始数据并用于 SDK 重置。

## preload##preload

```javascript
Tapjoy('preload', options);
```

| 选项       | 类型 | 默认值                   | 描述       |
| -------- | -- | --------------------- | -------- |
| callback | 函数 | `(err, status) => {}` | 加载内容后的回调 |

## showOfferwall##showofferwall

必须在显示 Offerwall 内容之前调用 init 函数。默认情况下会预加载 Offerwall 内容。

```javascript
Tapjoy('showOfferwall', options);
```

| 选项       | 类型          | 默认值             | 描述                     |
| -------- | ----------- | --------------- | ---------------------- |
| node     | HTMLElement | `document.body` | 不适用                    |
| callback | 函数          | `noop`          | 使用当前 Offerwall 状态调用的函数 |

## closeOfferwall##closeofferwall

关闭所有激活的 Offerwall 窗口。

```javascript
Tapjoy('closeOfferwall');
```
