GET/{resource-id1}/{object-id}/{resource-id2}

Формат запроса
Формат ответа
JSON
Параметры ответа
Пример для JSON

Возвращает объекты (с параметрами), которые связаны с указанным объектом.

Формат запроса

GET https://jsonapi.partner2.yandex.com/vX
  ? [fields[{resource-id2}]=<string>]
  & [page[size]=<integer>]
  & [page[number]=<integer>]
  & [filter=<string>]

Параметр	Описание
`resource-id1`	Идентификатор первого ресурса.
`object-id`	Идентификатор объекта, который принадлежит первому ресурсу.
`resource-id2`	Идентификатор второго ресурса. Из списка объектов второго ресурса будут найдены объекты, связанные с указанным объектом.
`fields[{resource-id2}]`	Параметры, доступные для объектов. Допустимые значения: `actions` — действия, допустимые для текущего объекта; `block_type` — тип рекламного блока; `brands` — бренды, установленные на текущем объекте; `client_id` — идентификатор клиента; `dsp_blocks` – размер блока медийной рекламы. Для полноэкранных и rewarded блоков поле указывать не нужно. `editable_fields` — параметры текущего объекта, которые можно редактировать; `email` — электронная почта клиента; `excluded_domains` — исключенные домены; `excluded_phones` — исключенные телефоны; `formats_setup_mode` — настройки формата. Допустимые значения: standard — форматы блоков настраиваются автоматически с параметрами по умолчанию; manual — форматы блоков настраиваются в параметре `design_templates`. `geo` — региональные таргетинги, установленные на текущем объекте; `lang` — язык интерфейса; `lastname` — фамилия клиента; `level` — уровень вложенности; `login` — логин пользователя; `midname` — отчество пользователя; `multistate` — текущий статус объекта; `multistate_name` — текстовое описание статуса объекта; `name` — имя объекта; `page_id` — идентификатор площадки; `parent_id` — идентификатор родительского объекта; `regularity` — порядок сортировки в интерфейсе; `roles` — роли пользователя; `status` — статус объекта. Допустимые значения: sync — синхронизирован; pending — отправляется. `tech_type` — поле для работы с блоками для Turbo и AMP страниц. Применимо только для `"block_type" : "banner"`. Допустимые значения: turbo — блок для Turbo; amp — блок для AMP. Ограничение. Допустимые значения зависят от ресурса и перечислены в параметре `available_fields` операции GET/resources. Чтобы включить в запрос несколько допустимых значений, перечислите их через запятую.
`page[size]`	Количество объектов ресурса, которое необходимо включить в ответ. Значение по умолчанию: 100. Максимальное значение: 1000.
`page[number]`	Номер страницы, с которой необходимо начать вывод.
`filter`	Фильтр. Допустимые значения фильтров приведены в параметре `filters` операции GET/{resource-id}. Подробнее о фильтрах в разделе Построение фильтров. Ограничение. Фильтры доступны не для всех ресурсов.
`notitle`	Идентификатор связанного ресурса. В ответе будет дополнительная информация о связанном ресурсе. Примечание Чтобы включить в запрос несколько связанных ресурсов, перечислите их идентификаторы через запятую.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

JSON

{
  "included":
  [
    {
      "relationships": {
        "{string}": {
          "links": {
            "related": "{string}",
            "self": "{string}"
          }
        },
        ...
      },
      "id": "{string}",
      "type": "{string}",
      "attributes": {
        "actions": {...},
        "brands": [
          {
            "bid": "{string}",
            "blocked": {boolean},
            "cpm": {integer}
          },
          {
            ...
          }
        ],
        "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": {
        "actions": {...},
        "brands": [
          {
            "bid": "{string}",
            "blocked": {boolean},
            "cpm": {integer}
          },
          {
            ...
          }
        ],
        "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}"
      }
    }
  ],
  "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/R-A-3228-1/context_on_site_campaign?fields[context_on_site_campaign]=multistate,multistate_name,editable_fields,status&page[size]=2&page[number]=1"

Ответ:

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: 2973
Connection: keep-alive

{
  "data": [
    {
      "relationships": {
        "context_on_site_adblock": {
          "links": {
            "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/context_on_site_adblock",
            "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/relationships/context_on_site_adblock"
          }
        },
        "blocks": {
          "links": {
            "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/blocks",
            "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/relationships/blocks"
          }
        },
        "context_on_site_adfox": {
          "links": {
            "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/context_on_site_adfox",
            "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/relationships/context_on_site_adfox"
          }
        },
        "context_on_site_rtb": {
          "links": {
            "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/context_on_site_rtb",
            "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882/relationships/context_on_site_rtb"
          }
        }
      },
      "id": "882",
      "type": "context_on_site_campaign",
      "attributes": {
        "status": "sync",
        "multistate_name": "Работает.\nДобавлена в Баланс.",
        "multistate": 17,
        "editable_fields": {
          "excluded_domains": true,
          "excluded_phones": true
        }
      },
      "links": {
        "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/882"
      }
    }
  ],
  "links": {
    "first": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/context_on_site_campaign?apikey=66...&fields%5Bcontext_on_site_campaign%5D=multistate,multistate_name,editable_fields,status&page%5Bsize%5D=2&page%5Bnumber%5D=1",
    "next": null,
    "prev": null,
    "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/context_on_site_campaign?apikey=6...&fields%5Bcontext_on_site_campaign%5D=multistate,multistate_name,editable_fields,status&page%5Bsize%5D=2&page%5Bnumber%5D=1",
    "last": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/context_on_site_campaign?apikey=66...&fields%5Bcontext_on_site_campaign%5D=multistate,multistate_name,editable_fields,status&page%5Bsize%5D=2&page%5Bnumber%5D=1"
  },
  "meta":
  {
    "found_rows": 1,
    "count": 1,
    "fields":
    [
      "editable_fields",
      "multistate",
      "multistate_name",
      "status"
    ],
    "filters":
    [
      {
        "name": "page_id",
        "type": "number",
        "label": "Page ID"
      },
      {
        "name": "multistate",
        "values":
        [
          {
            "label": "Заблокирована",
            "id": "blocked"
          },
          {
            "label": "Необходимо утвердить",
            "id": "need_approve"
          },
          {
            "label": "Сохранение изменений",
            "id": "need_update"
          },
          {
            "label": "Закрыт от редактирования",
            "id": "protected"
          },
          {
            "label": "Отклонена модератором",
            "id": "rejected"
          },
          {
            "label": "Остановлена",
            "id": "stopped"
          },
          {
            "label": "Тестирование",
            "id": "testing"
          },
          {
            "label": "Обновление",
            "id": "updating"
          },
          {
            "label": "Работает",
            "id": "working"
          }
        ],
        "type": "multistate",
        "label": "Статус"
      }
    ]
  }
}

GET/{resource-id1}/{object-id}/{resource-id2}

Формат запросаФормат запроса

Формат ответаФормат ответа

JSONJSON

Параметры ответаПараметры ответа

Пример для JSONПример для JSON

Была ли статья полезна?

Формат запроса

Формат ответа

JSON

Параметры ответа

Пример для JSON