> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/api/zh/exoclick-gong-gong-api/kai-fa-zhe-api.md).

# 开发者 API

通过平台 API，可以自动化管理管理员面板中的所有功能。

<details>

<summary>1. 广告主可以自动化什么？</summary>

* 广告系列/组、变体、offer 和广告格式
* 定向/屏蔽定向选项、类别
* 目标
* 获取统计数据，包括 adblock 用户数据
* 每日预算、账户充值、付款类型
* 落地页名称、URL 及流量分配算法

</details>

<details>

<summary>2. 发布商可以自动化什么？</summary>

* 广告格式和广告位
* 站点、URL 验证
* 屏蔽广告类型和产品类别
* 获取所有统计数据，包括 adblock 用户数据
* 每种广告格式/GEO 的出价、定价模型
* 付款类型

</details>

<details>

<summary>3. 如何使用 API</summary>

* API 界面快速且易于使用
* 只需选择一个参数并点击 **Try It Out** 按钮即可自动生成代码

</details>

<details>

<summary>4. 下载技术文档</summary>

* [PHP 客户端](https://github.com/exads/exads-api-client-php)

</details>

## 如何使用平台 API

我们刚刚将平台 API 更新到了 2 版。这个最新版本让你能够自动化管理员面板中的每一个功能。你可以使用 API 处理简单流程，例如自动执行重复性任务以节省时间，也可以用于更复杂的项目，例如动态更改横幅创意。

### 功能

发布商和广告主都可以使用大量功能。以下是可自动化内容的概述：

#### 广告主

* 单个/分组广告系列、变体、offer、广告格式。
* 定向/屏蔽定向选项、类别、分时投放。
* 目标。
* 获取统计数据，包括 adblock 用户数据。
* 每日预算、账户充值、付款类型。
* 落地页名称、URL 及流量分配算法。

#### 发布商

* 广告格式和广告位。
* 站点、URL 验证。
* 屏蔽广告类型和产品类别。
* 获取所有统计数据，包括 adblock 用户数据。
* 每种广告格式/GEO 的出价、定价模型。
* 付款类型。

**开始之前**

API 界面会显示组标题列表。点击某个组，所有可用选项都会展开。

![列表 API](/files/2ea91af8155aa2fbfad9f22014dbba3d2ba4741a)

### HTTP 动词

API 支持以下一部分 HTTP 动词。请注意，并非所有功能都支持所有动词。

![API 使用](/files/a3e28e582cc649072a48aa1478c9ffe798d31d81)

让我们开始吧！

### 设置

为了访问受限的 API 请求，必须设置会话令牌。要设置令牌，你必须拥有一个有效账户。

API 令牌的创建可在你的 **个人资料** 菜单中找到。选择 API Tokens。

![个人资料](/files/1f254775d5ed2442b1980c9bd4418d7642273b1e)

点击 **New API Token**.

![API 令牌](/files/8160acd0da53c8eb6a6c6bf476588d4d40d9905e)

输入令牌名称，在本教程中我们将其命名为 ‘testToken’，然后点击 **保存**.

令牌 ID 已创建。

![令牌 ID](/files/54d6028b1f0932cea2200d4d50996fc01d65665f)

### 登录 API

在 API 界面中，点击 **登录** 屏幕右上角的按钮，然后输入你的用户名和密码，或提供一个 API 令牌。点击 **发送** ，系统将向 API 发送登录请求以获取有效的会话令牌。随后，这个令牌将用于验证你在本次会话中希望发出的所有 API 请求。

![API 登录](/files/c8f3da8d6e8c4ff6292afbe0139de9c95951e4f7)

![API 登录](/files/798e19fb8f83b158470dc966214928bedc1b8c5f)

### 如何向 API 发起请求

以 Campaigns 组为例，点击它后该组会展开并列出可用请求：

点击你想自动化的请求，在这个示例中，我们将使用以下方式请求 CID 1923724 的数据：

![获取广告系列](/files/a12d5e911d8b4cb33e376a7fb789f6b4c6c1e2f7)

点击 **获取广告系列** 这会展开窗口。在字段中输入广告系列 ID：

![广告系列 ID](/files/1da4507b7f159fb87669345eaa3c6852b96f53c6)

然后点击 **立即试用** 按钮。响应正文会自动生成代码。

![响应正文](/files/ea9231f27c7e825fc4930c952b907e300a85bc18)

响应代码为 200 表示可以正常使用。

### 如何暂停广告系列

下面是另一个示例。首先从 Campaigns 组中选择正确的功能：

![暂停广告系列](/files/29d73711b21bac617168c1530d949a7cb80a225c)

点击 **暂停** 一个或多个广告系列。打开后，点击 Example Value，再点击黄色框，这会自动将 json 结构粘贴到正文框中。

![暂停](/files/3d03051bb238df1bf66a51a03a74eee36119a690)

现在当前值为零，所以把零改成你想要暂停的 CID。然后点击 **试用** 按钮即可生成所需代码。

![广告系列 ID](/files/18bad089f81c764a5af3849b6c248ac8c4f4cbea)

### 如何更新广告系列定价

选择正确的功能：

![广告系列 ID](/files/34ca47ecd6390b9a01a94d0bcf94ff2734651cc9)

点击 **更新广告系列**，打开窗口。在广告系列 ID 字段中添加 CID，然后点击 Example Value，再点击黄色框，它会把 json 结构复制到正文框中。

这段代码包含几个不同的功能，但我们要的是广告系列定价代码，因此删除不需要的部分，只保留框中的广告系列定价代码，如下所示：

![广告系列 ID](/files/c229e9762e4350cf4483112fc69210efb1d22cc7)

现在我们需要在正文框中更改两项内容，模型（下面是与定价模型相关的取值列表）。

```
CampaignPricing {
model（整数，可选）：广告系列定价模型（1：CPC，2：CPM，3：CPA，4：Smart CPM，5：CPV）= [‘1’, ‘2’, ‘3’, ‘4’, ‘5’]，
price（数字，可选）：广告系列价格
}
```

我们将保持 CPC，所以把 model 保持为 1

现在我们需要把价格从零改成我们想要的价格。我们会把它改为 200，这意味着新价格将是 200 美分，也就是 2 欧元。

![广告系列 ID](/files/ff19fb4a388f4ebb5c9b187d9b4984930347febc)

然后只需点击 **试用** 按钮即可生成代码。很简单！

正如你所见，API 功能非常丰富，可以实现大量自动化操作，解锁自动化能力的唯一限制就是你的想象力。

最后，请确保订阅我们的 API 新闻通讯，你可以在 API 界面底部找到它，这样就能获取最新新闻和更新。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.exoclick.com/api/zh/exoclick-gong-gong-api/kai-fa-zhe-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
