GET/{resource-id}
Возвращает список объектов указанного ресурса.
Формат запроса
GET https://jsonapi.partner2.yandex.com/vX
? [fields[{resource-id}]=<string>]
& [page[size]=<integer>]
& [page[number]=<integer>]
& [filter=<string>]
& [include=<string>]
Параметр |
Описание |
|
Идентификатор ресурса, для которого необходимо получить информацию. |
|
Параметры, доступные для объектов. Допустимые значения:
Ограничение. Допустимые значения зависят от ресурса и перечислены в параметре Чтобы включить в запрос несколько допустимых значений, перечислите их через запятую. |
|
Количество объектов ресурса, которое необходимо включить в ответ. Значение по умолчанию: 100. Максимальное значение: 1000. |
|
Номер страницы, с которой необходимо начать вывод. |
|
Фильтр. Допустимые значения фильтров приведены в параметре Ограничение. Фильтры доступны не для всех ресурсов. |
|
Идентификатор связанного ресурса. В ответе будет дополнительная информация о связанном ресурсе. Примечание Чтобы включить в запрос несколько связанных ресурсов, перечислите их идентификаторы через запятую. |
Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.
Формат ответа
JSON
{
"included":
[
{
"relationships": {
"{string}": {
"links": {
"related": "{string}",
"self": "{string}"
}
},
...
},
"id": "{string}",
"type": "{string}",
"attributes": {
"actions": {...},
"brands": [
{
"bid": "{string}",
"blocked": {boolean}
},
{
...
}
],
"client_id": {integer},
"email": "{string}",
"excluded_domains": ["{string}"],
"excluded_phones": ["{string}"],
"geo": [
{
"id": "{string}",
"cpm": {integer}
},
{
...
}
],
"lang": "{string}",
"lastname": "{string}",
"level": {integer},
"login": "{string}",
"midname": "{string}",
"multistate": {integer},
"multistate_name": "{string}",
"name": "{string}",
"page_id": {integer},
"parent_id": {integer},
"regularity": {integer},
"roles": "{string}",
"status": "{string}"
},
"links": {
"self": "{string}"
}
}
],
"data": [
{
"relationships": {
"{string}": {
"links": {
"related": "{string}",
"self": "{string}"
}
},
...
},
"id": "{string}",
"type": "{string}",
"attributes": {
},
"links": {
"self": "{string}"
}
}
],
"links": {
"first": "{string}",
"next": "{string}",
"prev": "{string}",
"self": "{string}",
"last": "{string}"
},
"meta": {
"found_rows": {integer},
"count": {integer},
"fields": [
"{string}",
"{string}"
],
"filters":
[
{
"name": "{string}",
"values":
[
{
"label": "{string}",
"id": "{string}"
},
{
...
}
],
"label": "{string}",
"type": "{string}"
}
]
}
}
Параметры ответа
-
included Массив объектов связанного указанного ресурса.
-
relationships Связанные ресурсы и объекты.
-
links Ссылки на объекты, связанные с текущим объектом.
-
related Ссылка на список связанных объектов с параметрами.
-
self Ссылка на список связанных объектов.
-
-
-
id Идентификатор объекта.
-
type Тип ресурса.
-
attributes Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.
-
actions Действия, допустимые для текущего объекта.
-
brands Бренды, установленные на текущем объекте.
-
bid Минимальная ставка, необходимая для показа бренда (в рублях).
-
blocked Бренд заблокирован (
true
илиfalse
).
-
-
client_id Идентификатор клиента.
-
editable_fields Параметры текущего объекта, которые можно редактировать.
-
email Электронная почта клиента.
-
excluded_domains Исключенные домены.
-
excluded_phones Исключенные телефоны.
-
geo Региональные таргетинги, установленные на текущем объекте.
-
id Идентификатор региона. Узнать регион можно с помощью операции GET/{resource-id}.
-
cpm Минимальный CPM, необходимый для показа в текущем регионе (в рублях).
-
-
lang Язык интерфейса.
-
lastname Фамилия клиента.
-
level Уровень вложенности.
-
login Логин пользователя.
-
midname Отчество пользователя.
-
multistate Текущий статус объекта.
-
multistate_name Текстовое описание статуса объекта.
-
name Имя объекта.
-
page_id Идентификатор площадки.
-
parent_id Идентификатор родительского объекта.
-
regularity Порядок сортировки в интерфейсе.
-
roles Роли пользователя.
-
status Статус объекта. Допустимые значения:
- sync — синхронизирован;
- pending — отправляется.
-
-
links Ссылки, связанные с объектом.
- self Ссылка на текущий объект.
-
-
data Массив объектов указанного ресурса.
-
relationships Связанные ресурсы и объекты.
-
links Ссылки на объекты, связанные с текущим объектом.
-
related Ссылка на список связанных объектов с параметрами.
-
self Ссылка на список связанных объектов.
-
-
-
id Идентификатор объекта.
-
type Тип ресурса.
-
attributes Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.
-
actions Действия, допустимые для текущего объекта.
-
brands Бренды, установленные на текущем объекте.
-
bid Минимальная ставка, необходимая для показа бренда (в рублях).
-
blocked Бренд заблокирован (
true
илиfalse
).
-
-
client_id Идентификатор клиента.
-
editable_fields Параметры текущего объекта, которые можно редактировать.
-
email Электронная почта клиента.
-
excluded_domains Исключенные домены.
-
excluded_phones Исключенные телефоны.
-
geo Региональные таргетинги, установленные на текущем объекте.
-
id Идентификатор региона. Узнать регион можно с помощью операции GET/{resource-id}.
-
cpm Минимальный CPM, необходимый для показа в текущем регионе (в рублях).
-
-
lang Язык интерфейса.
-
lastname Фамилия клиента.
-
level Уровень вложенности.
-
login Логин пользователя.
-
midname Отчество пользователя.
-
multistate Текущий статус объекта.
-
multistate_name Текстовое описание статуса объекта.
-
name Имя объекта.
-
page_id Идентификатор площадки.
-
parent_id Идентификатор родительского объекта.
-
regularity Порядок сортировки в интерфейсе.
-
roles Роли пользователя.
-
status Статус объекта. Допустимые значения:
- sync — синхронизирован;
- pending — отправляется.
-
-
links Ссылки, связанные с объектом.
- self Ссылка на текущий объект.
-
-
links Постраничные ссылки.
-
first Ссылка на первую страницу.
-
next Ссылка на следующую страницу.
-
prev Ссылка на предыдущую страницу.
-
self Ссылка на текущую страницу.
-
last Ссылка на последнюю страницу.
-
-
meta Объект содержит метаинформацию.
-
found_rows Общее количество объектов.
-
count Количество объектов в ответе.
-
fields Массив запрошенных параметров.
-
filters Фильтры, которые можно применить к объектам указанного ресурса. Подробнее о фильтрах в разделе Построение фильтров.
-
name Название параметра.
-
values Допустимые значения параметра. Используются для построения фильтра.
-
label Название параметра в интерфейсе.
-
id Идентификатор значения фильтра.
-
-
label Название параметра в интерфейсе.
-
type Тип параметра. Помогает определить какие операторы можно использовать для построения фильтра.
-
-
Пример для JSON
Запрос:
curl -i -g -H "Accept: application/vnd.api+json" -H "Authorization: token 66..." -X GET "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?filter=["multistate","=","deleted"]&fields[context_on_site_rtb]=brands,multistate,multistate_name,actions,editable_fields,geo,status&page[size]=2&page[number]=2"
Ответ:
HTTP/1.1 200 OK Server: nginx/1.8.1 Date: Sun, 18 Dec 2016 12:39:50 GMT Content-Type: application/vnd.api+json Content-Length: 3607 Connection: keep-alive { "data": [ { "relationships": { "context_on_site_campaign": { "links": { "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/context_on_site_campaign", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/relationships/context_on_site_campaign" } }, "pages": { "links": { "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/pages", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1/relationships/pages" } } }, "id": "R-A-1166-1", "type": "context_on_site_rtb", "attributes": { "actions": {}, "geo": null, "status": "sync", "multistate_name": "Заархивирован.", "multistate": 9, "editable_fields": {}, "brands": "[]" }, "links": { "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1166-1" } }, { "relationships": { "context_on_site_campaign": { "links": { "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/context_on_site_campaign", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/relationships/context_on_site_campaign" } }, "pages": { "links": { "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/pages", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1/relationships/pages" } } }, "id": "R-A-1304-1", "type": "context_on_site_rtb", "attributes": { "actions": {}, "geo": null, "status": "sync", "multistate_name": "Заархивирован.\nНет статистики.", "multistate": 13, "editable_fields": {}, "brands": "[]" }, "links": { "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1304-1" } } ], "links": { "first": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=1", "next": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=3", "prev": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=6..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=1", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&page%5Bnumber%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D", "last": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb?apikey=66..&fields%5Bcontext_on_site_rtb%5D=brands,multistate,multistate_name,actions,editable_fields,geo,status&page%5Bsize%5D=2&filter=%7B%22multistate%22:%22deleted%22%7D&page%5Bnumber%5D=2798" }, "meta": { "found_rows": 5595, "count": 2, "fields": [ "actions", "brands", "editable_fields", "geo", "multistate", "multistate_name", "status" ], "filters": [ { "name": "multistate", "values": [ { "label": "Нет статистики", "id": "check_statistics" }, { "label": "Заархивирован", "id": "deleted" }, { "label": "Сохранение изменений", "id": "need_update" }, { "label": "Обновление", "id": "updating" }, { "label": "Работает", "id": "working" } ], "label": "Статус", "type": "multistate" } ] } }