PATCH/{resource-id}/{object-id}

Редактирует параметры указанного объекта.

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

PATCH https://jsonapi.partner2.yandex.com/vX/{resource-id}/{object-id}

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

JSONJSON

{
  "data":
  {
    "type": "{string}",
    "id": "{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}"
    }
  }
}     

Параметры тела запросаПараметры тела запроса

• data * Объект с параметрами.

  • id * Идентификатор объекта.

  • type * Тип ресурса.

  • attributes * Параметры объекта.

    Ограничение.

    Допустимые значения зависят от ресурса, к которому относится объект, и перечислены в параметре editable_fields операции GET/{resource-id}/{object-id}. Ниже, для примера, приведена часть параметров.

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

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

      • bid Минимальная ставка, необходимая для показа бренда (в рублях).

      • blocked Бренд заблокирован (true или false).

      • cpm Минимальный CPM, необходимый для показа в текущем регионе (в рублях).

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

    • 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 — отправляется.

* Обязательный параметр

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

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

JSONJSON

{
  "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}"
    }
  },
  "meta": {
    "fields": ["{string}"]
  },
  "links": {
    "self": "{string}"
  }
}       

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

• data Массив с информацией по указанному объекту.

  • relationships Связанные ресурсы и объекты.

    • links Ссылки на объекты, связанные с текущим объектом.

      • related Ссылка на список связанных объектов с параметрами.

      • self Ссылка на список связанных объектов.

  • id Идентификатор объекта.

  • type Тип ресурса.

  • attributes * Параметры объекта.

    Ограничение.

    Допустимые значения зависят от ресурса, к которому относится объект, и перечислены в параметре editable_fields операции GET/{resource-id}/{object-id}. Ниже, для примера, приведена часть параметров.

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

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

      • bid Минимальная ставка, необходимая для показа бренда (в рублях).

      • blocked Бренд заблокирован (true или false).

      • cpm Минимальный CPM, необходимый для показа в текущем регионе (в рублях).

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

    • 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 — отправляется.

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

  • fields Измененные параметры объекта.

• links Ссылки, связанные с объектом.

  • self Ссылка на текущий объект.

* Обязательный параметр

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

Запрос:

curl -i -g -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: token 66..." -X PATCH 'https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12' -d '{"data":{"type":"context_on_site_campaign","id":"12","attributes":{"excluded_domains":["test-domain1.ru","test-domain2.ru"]}}}'

Ответ:

HTTP/1.1 200 OK
Server: nginx/1.8.1
Date: Tue, 17 Jan 2017 09:13:07 GMT
Content-Type: application/vnd.api+json
Content-Length: 1373
Connection: keep-alive

{
  "data":
  {
    "relationships": {
      "context_on_site_adblock": {
        "links": {
          "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/context_on_site_adblock",
          "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/context_on_site_adblock"
        }
      },
      "blocks": {
        "links": {
          "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/blocks",
          "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/blocks"
        }
      },
      "context_on_site_adfox": {
        "links": {
          "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/context_on_site_adfox",
          "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/context_on_site_adfox"
        }
      },
      "context_on_site_rtb": {
        "links": {
          "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/context_on_site_rtb",
          "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/context_on_site_rtb"
        }
      }
    },
    "id": "12",
    "type": "context_on_site_campaign",
    "attributes": {
      "excluded_domains": ["test-domain1.ru","test-domain2.ru"]
    }
  },
  "meta": {
    "fields": ["excluded_domains"]
  },
  "links": {
    "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12"
  }
}