CloudX API

了解如何认证请求并使用 CloudX API 参考。

CloudX API

使用 CloudX API 获取报表指标、检查竞价,并读取或写入账号配置。

基础 URL

https://provisioning.cloudx.io/api/v1

认证

Settings > API Keys 中创建 API key,然后将它作为 bearer token 发送:

curl https://provisioning.cloudx.io/api/v1/auth/status \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

只有管理员可以创建、管理和撤销 API key。

权限

根据集成需要调用的端点选择权限。

权限允许访问
reports:read/report/* 下的报表端点和 /export/* 下的活动导出端点
auctions:read/auction/* 下的竞价检查端点
configuration:read/config/* 下的配置端点
configuration:write/config/* 下的配置写入端点

活动导出

通过 POST /export/impressionsPOST /export/requestsPOST /export/bids 创建异步的全天活动导出报表,然后轮询对应的 GET 端点,直到导出就绪。

大多数报表会在 5–45 分钟内准备好供下载。处理时间取决于所选日期和过滤条件对应的数据量。导出就绪后,状态响应会包含一个短期有效的下载 URL。

请参阅活动导出,了解 API 和 CLI 共用的请求正文、轮询示例和 CSV 架构。

配置写入

使用 POST /config/edit 为应用、广告单元、广告单元组、列表、标签、测试设备、网络映射和订单项创建或更新配置草稿。该端点也支持 A/B 测试操作;创建 A/B 测试会返回草稿,更新、开始、结束、提升和删除会发布生成的配置。

请求使用带类型的操作键,例如 create_appupdate_ad_unitupsert_network_mappingupdate_line_item。广告单元和订单项的 bidfloor 使用十进制 USD CPM,因此 1.5 表示 $1.50 CPM。

API 参考

API 参考由 CloudX 托管的实时 OpenAPI schema 生成。