输入数据和结果的格式

输入数据的格式

POST 和 PUT 方法的输入数据结构在请求体中传递。 输入结构与对应资源的GET方法输出结构一致。

备注

要正确构造用于 POST 或 PUT 方法的输入结构,请调用已存在资源的 GET 方法。 复制得到的结构并定义所有必要的字段值。

API POST 和 PUT 方法接受 JSON 格式的输入数据。

输入数据的格式由HTTP Content-Type 头部指定。

可接受的头部值:application/x-yametrika+json 或 application/json.

结果格式

管理 API 返回的响应使用 UTF-8 编码。 响应采用 JSON 格式。

例如,以下请求会返回 ID 为 1111 的应用的信息:

GET /management/v1/application/1111 HTTP/1.1
Host: api.boost.yandex.com
Authorization: OAuth <your_token>

其中 <your_token> 是一个 OAuth 令牌,可以通过 说明 获取。

响应示例:

{
    "application": {
        "name": "Examples api.yandex.ru",
        "time_zone_name": "Europe/Moscow",
        "hide_address": false,
        "gdpr_agreement_accepted": false,
        "use_universal_links": false,
        "id": 1111,
        "uid": 178121744,
        "owner_login": "login",
        "time_zone_offset": 10800,
        "create_date": "2016-01-02"
    }
}

为了调试,结果可以进行格式化。 要做到这一点,在任何类型的请求中传递pretty参数,并将其值设置为1:

GET /management/v1/application/1111?pretty=1 HTTP/1.1
Host: api.boost.yandex.com
Authorization: OAuth <your_token>

where <your_token> 是一个 OAuth 令牌,可以通过 说明 获取。

当 DELETE 方法执行成功时,API 会返回 HTTP 状态码 200. 如果HTTP状态包含不同的代码,则删除未执行。

如果您没有找到所需答案,可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能,请附上截图。

联系支持 建议改进文档
下一篇