Форматы входных данных и результата
Формат входных данных
Входные структуры данных POST- и PUT-методов передаются в теле запроса. Входные структуры совпадают с выходными структурами GET-методов соответствующих ресурсов.
Совет
Чтобы корректно сформировать входную структуру для POST- или PUT-метода, вызовите GET-метод для уже существующего ресурса. Скопируйте полученную структуру и задайте нужные значения полей.
POST- и PUT-методы API принимают входные данные в формате JSON.
Формат входных данных указывается в HTTP-заголовке Content-Type.
Возможные значения заголовка:
application/json— формат JSON;multipart/form-data— используется для загрузки файлов (см. формат multipart/form-data)).
Формат результата
API возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON.
Например, в результате выполнения следующего запроса будет получен список доступных сегментов:
GET https://api-audience.yandex.ru/v1/management/segments
Пример:
GET /v1/management/segments HTTP/1.1
Host: https://api-audience.yandex.ru
Authorization: OAuth <access_token>
Content-Type: application/json
Content-Length: 127
{
"segments" : [{
"id" : 1111,
"name" : "номера",
...
},
{
"id" : 1122,
"name" : "e-mail",
...
}
]
}
Для удобства отладки результат может отображаться в отформатированном виде. Для этого в запросе любого типа передайте параметр pretty со значением равным 1:
GET https://api-audience.yandex.ru/v1/management/segments?pretty=1
PUT https://api-audience.yandex.ru/v1/management/segments?pretty=1
При успешном выполнении DELETE-методов API возвращает HTTP-статус с кодом 200. Если HTTP-статус содержит другой код, удаление не выполнено.