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

Возвращает указанный объект.

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

GET https://jsonapi.partner2.yandex.com/vX{resource-id}/{object-id}
  ? [fields[{resource-id}]=<string>]
  & [include=<string>]

Параметр

Описание

resource-id

Идентификатор ресурса, для которого необходимо получить информацию.

object-id

Идентификатор возвращаемого объекта.

fields[{resource-id}]

Параметры, доступные для объектов. Допустимые значения:

  • 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.

Чтобы включить в запрос несколько допустимых значений, перечислите их через запятую.

include

Идентификатор связанного ресурса. В ответе будет дополнительная информация о связанном ресурсе.

Примечание

Чтобы включить в запрос несколько связанных ресурсов, перечислите их идентификаторы через запятую.

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

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

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}"
  },
  "meta": {
    "fields": [
      "{string}",
      "{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 Ссылка на текущий объект.

  • meta Объект содержит метаинформацию.

    • fields Массив запрошенных параметров.

Пример для JSON

Запрос:

curl -i -g -H "Accept: application/vnd.api+json" -H "Authorization: token bf..." -X GET "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1?fields[context_on_site_rtb]=brands,multistate,multistate_name,actions,editable_fields,geo,status"

Ответ:

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

{
  "data":
  {
    "relationships": {
      "context_on_site_campaign": {
        "links": {
          "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/context_on_site_campaign",
          "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/relationships/context_on_site_campaign"
        }
      },
      "pages": {
        "links": {
          "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/pages",
          "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/relationships/pages"
        }
      }
    },
    "id": "R-A-3228-1",
    "type": "context_on_site_rtb",
    "attributes": {
      "actions": {
        "duplicate": "Дублировать"
      },
      "geo": null,
      "status": "sync",
      "multistate_name": "Работает.",
      "multistate": 2,
      "editable_fields": {
        "geo": true,
        "brands": true
      },
      "brands": "[{"bid":"5414","blocked":true},{"bid":"827490","blocked":true}]"
    }
  },
  "links": {
    "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1"
  },
  "meta": {
    "fields": [
      "actions",
      "brands",
      "editable_fields",
      "geo",
      "multistate",
      "multistate_name",
      "status"
    ]
  }
}
Предыдущая
GET/{resource-id}
Следующая
DELETE/{resource-id}/{object-id}
В этой статье: