AI-ready documentation
接入总览
概述通过 API 或服务端 SDK 接入 Gravity Engine 高级能力的方式，并指引事件采集、报表查询和其他接口文档。
本指南将会为您介绍如何使用 API 的方式接入引力引擎部分高级能力。
由于广告归因需要采集很多参数，为避免重复造轮子，我们提供了 SDK 来封装好了数据采集的逻辑，API 接入方案建议只考虑用来查询报表或者上报某些重要的事件，例如：通过后端上报付费和广告观看事件，其他事件，建议使用 SDK 采集，这样能有效提高接入效率！
SDK 接入，请您参考SDK 导览页。
选择接口与凭证
| 场景 | 使用凭证 | 接入要求 |
|---|---|---|
| 事件采集上报 | 引力应用 Access Token，放在 query 的 access_token | 客户端先完成用户初始化，再用相同 ClientID 上报；不套用 OpenAPI 签名 |
| 报表查询、导出和应用管理 | 开发者应用 app_key，用于生成 sign 和 Authorization | 开发者应用审核通过、启用且有目标应用权限；详见 签名生成 |
| 微信/抖音 Token 透传 | 引力应用 Access Token、项目加密密钥和媒体 Token | 使用该接口专用签名；媒体 Token 与引力 Token 用途不同 |
请按具体接口准备参数，不要将后台网页登录 Token 作为 OpenAPI 的 Authorization。请求示例中的 YOUR_SIGN、YOUR_AUTHORIZATION、ID 和日期均需替换；修改请求体后必须重新生成签名和认证字符串。
功能入口
API 接入主要包括以下模块：
- 事件采集上报：您可以通过此模块的接口通过服务端上报事件给引力后台。
- Token 接入：您可以通过此模块的接口对接小游戏平台的 Access Token 到引力后台。
- 报表查询：查询报表，以及创建导出任务和获取下载结果。
- 其他接口：查询或创建应用、管理推广活动、批量上传素材。
判断结果与排错
先检查 HTTP 状态，再检查响应中的 code、msg、extra.error 和接口要求的 data 字段。接口有特殊成功判断时，以该接口说明为准；事件采集还需核对事件流入库结果，导出任务需继续查询至完成。