GET/resources

Возвращает список доступных ресурсов.

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

GET https://jsonapi.partner2.yandex.com/vX/resources
  ? [fields[resources]=<string>]

ПараметрыПараметры

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

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

JSONJSON

{
  "data": [
    {
      "type": "{string}",
      "id": "{string}",
      "attributes": {
        "available_actions": [
          "{string}",
          "{string}"
        ],
        "methods": [
          "{string}",
          "{string}"
        ],
        "available_fields": [
          "actions",
          "brands",
          "client_id",
          "email",
          "excluded_domains",
          "excluded_phones",
          "geo",
          "lang",
          "lastname",
          "level",
          "login",
          "midname",
          "multistate",
          "multistate_name"
          "name",
          "page_id",
          "parent_id",
          "regularity",
          "roles",
          "status",
          ...
        ],
        "title": "{string}"
      },
      "meta": {
        "show_in_menu": {boolean}
      },
      "links": {
        "self": "{string}"
      }
    },
    ...
  ],
  "links": {
    "self": "{string}"
  },
  "meta": {
    "count": {integer},
    "fields": [
      "{string}",
      "{string}"
    ]
  }
}

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

• data Массив с доступными ресурсами.

  • type Тип данных (в данном случае ресурс).

  • id Идентификатор ресурса.

  • attributes Объект содержит параметры, доступные для ресурса.

    • available_actions Массив действий, доступных для ресурса.

    • methods Массив методов, доступных для ресурса. Используется в интерфейсе.

    • available_fields Массив параметров, доступных для ресурса. Список параметров зависит от ресурса. Ниже, для примера, приведена часть параметров.

      • actions Действия, допустимые для текущего объекта.

      • brands Бренды, установленные на текущем объекте.

      • client_id Идентификатор клиента.

      • editable_fields Параметры текущего объекта, которые можно редактировать.

      • email Электронная почта клиента.

      • excluded_domains Исключенные домены.

      • excluded_phones Исключенные телефоны.

      • geo Региональные таргетинги, установленные на текущем объекте.

      • lang Язык интерфейса.

      • lastname Фамилия клиента.

      • level Уровень вложенности.

      • login Логин пользователя.

      • midname Отчество пользователя.

      • multistate Текущий статус объекта.

      • multistate_name Текстовое описание статуса объекта.

      • name Имя объекта.

      • page_id Идентификатор площадки.

      • parent_id Идентификатор родительского объекта.

      • regularity Порядок сортировки в интерфейсе.

      • roles Роли пользователя.

      • status Статус объекта.

    • title Название ресурса.

  • meta Объект содержит служебные параметры.

    • show_in_menu Признак наличия ресурса в меню в интерфейсе.

  • links Ссылки, связанные с ресурсом.

    • self Ссылка на ресурс.

• links Ссылки, связанные с ресурсом.

  • self Ссылка на запрос.

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

  • count Общее количество ресурсов.

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

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

Запрос:

curl -i -g -H "Accept: application/vnd.api+json" -H "Authorization: token 66..." -X GET 'https://jsonapi.partner2.yandex.com/v1/resources?fields[resources]=available_fields,title,available_actions,methods'

Ответ:

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

{
  "data": [
    {
      "type": "resources",
      "id": "resources",
      "attributes": {
        "available_actions": [],
        "methods": [
          "GET"
        ],
        "available_fields": [
          "title",
          "available_fields",
          "available_actions",
          "methods"
        ],
        "title": "Ресурсы"
      },
      "meta": {
        "show_in_menu": false
      },
      "links": {
        "self": "https://jsonapi.partner2...v1/resources/resources"
      }
    },
    {
      "type": "resources",
      "id": "context_on_site_rtb",
      "attributes": {
        "available_actions": [
          "duplicate"
        ],
        "methods": [
          "GET",
          "POST"
        ],
        "available_fields": [
          "brands",
          "multistate",
          "multistate_name",
          "actions",
          "editable_fields",
          "geo",
          "status"
        ],
        "title": "RTB-блоки"
      },
      "meta": {
        "show_in_menu": true
      },
      "links": {
        "self": "https://jsonapi.partner2...v1/resources/context_on_site_rtb"
      }
    },
    ...
    {
      "type": "resources",
      "id": "search_on_site_campaign",
      "attributes": {
        "available_actions": [],
        "methods": [
          "GET",
          "POST"
        ],
        "available_fields": [
          "excluded_domains",
          "excluded_phones",
          "multistate",
          "multistate_name",
          "editable_fields",
          "status"
        ],
        "title": "Поисковые площадки"
      },
      "meta": {
        "show_in_menu": true
      },
      "links": {
        "self": "https://jsonapi.partner2...v1/resources/search_on_site_campaign"
      }
    },
    {
      "type": "resources",
      "id": "context_on_site_campaign",
      "attributes": {
        "available_actions": [],
        "methods": [
          "GET",
          "POST"
        ],
        "available_fields": [
          "page_id",
          "excluded_domains",
          "excluded_phones",
          "multistate",
          "multistate_name",
          "editable_fields",
          "status"
        ],
        "title": "Тематические площадки"
      },
      "meta": {
        "show_in_menu": true
      },
      "links": {
        "self": "https://jsonapi.partner2...v1/resources/context_on_site_campaign"
      }
    }
  ],
  "links": {
  "self": "https://jsonapi.partner2...v1/resources?fields%5Bresources%5D=available_fields,title,available_actions,methods..."
  },
  "meta": {
    "count": 13,
    "fields": [
      "available_fields",
      "title",
      "available_actions",
      "methods"
    ]
  }
}