- 注册开发者账号。
- 创建开发者应用并妥善保管你的令牌。
- 访问 ads.x.com/help,为你的每个开发者应用提交 Ads API 访问请求。
**注意:**如果你已在 X 开发者平台上进行集成且拥有开发者账号,请跳至第三步。
要向任一 X 的 API 产品发出请求,您必须先注册开发者账号。在开发者门户中创建一个项目(Project)和开发者应用(App)。系统会为您提供一组凭证,用于对所有发往 API 的请求进行身份验证。
在你的开发者应用中,你将获得一组 API 密钥(亦称 Consumer Keys)。你还可以生成一组访问令牌(Access Tokens),用于代表你的个人 X 账户发起请求,以及一个 Bearer Token,用于对需要 OAuth 2.0 Bearer Token 的端点进行认证。由于这些密钥和令牌除非重新生成否则不会过期,我们建议将其配置为环境变量,或使用安全的密码管理器加以保管。
请同时记录你的 App ID,可在应用详情页的 URL 中找到。这将有助于你在下一步更轻松地申请 Ads API 访问权限。
注意: 你的密钥和令牌在开发者门户中仅会显示一次,因此在生成后务必立即将这些凭证存入你的密码管理系统。如果你遗失或忘记了密钥和令牌,你需要重新生成它们,这将创建新的密钥和令牌并使旧的失效。这意味着你需要更新所有使用先前凭证配置的集成。了解更多认证最佳实践。
此时,您已拥有 X API 的基础访问权限,但尚未获得 X Ads API 的相关功能。接下来,您需要提交申请并通过审批以获取 Ads API 访问权限。前往 ads.x.com/help,为您每个开发者应用提交 Ads API 访问申请。
作为申请流程的一部分,你需要明确所需的访问级别。进一步了解应用级和广告账户级权限。
可访问移动端和网页转化端点,具有读写权限。
可对 Analytics、Campaign Management、Creatives、Custom Audiences 和 Conversion 端点进行读写访问。
**注意:**在 2023 年 7 月之前申请访问的 Ads API 开发者,其访问级别和权限可能有所不同,并且可能被限制为最多 5 个 OAuth 令牌。请参阅我们的
提升访问权限指南,以获取更多端点访问,或为现有应用解除令牌限制。
要测试你对 Ads API 的访问权限,请向 GET accounts 端点发起请求。该端点将返回当前已授权用户可访问的广告账户。在后续的 API 请求中,使用此请求返回的广告账户 ID 来读取和写入特定广告账户的数据。使用命令行中的 Twurl 时,请求如下所示。
示例请求
twurl -H ads-api.x.com "/11/accounts"
示例响应
{
"request": {
"params": {}
},
"data": [
{
"name": "Furni",
"business_name": null,
"timezone": "America/Los_Angeles",
"timezone_switch_at": "2016-04-06T07:00:00Z",
"id": "18ce54ayf0z",
"created_at": "2016-04-07T14:40:15Z",
"salt": "b88939e5cabbca720159cb3659d73c06",
"updated_at": "2017-02-08T08:49:53Z",
"business_id": null,
"approval_status": "ACCEPTED",
"deleted": false
}
]
}