---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.3
alternate:
  - https://yandex.com/dev/partner-objects/doc/en/concepts/examples.md
  - https://yandex.com/dev/partner-objects/doc/ru/concepts/examples.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/partner-objects/doc/ru/llms.txt


# Примеры сценариев

## Добавление площадки {#context_on_site_campaign}

Чтобы добавить площадку, воспользуйтесь операцией [POST/{resource-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/post-resource-id.md).

> Запрос:
> 
> ```
> curl -v -H "Accept: application/vnd.api+json" \
> -H "Content-Type: application/vnd.api+json" \
> -H "Authorization: token ac3b42lp-89ls-..." \
> -X POST 
> --data \
>   '{
>      "data":
>      {
>        "type":"context_on_site_campaign",
>        "attributes":
>        {
>          "domain_id":115505,
>          "caption":"Test"
>        }
>      }
>    }' \
>  'https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign' | json_pp
> ```
> 
> Ответ:
> 
> ```json
> HTTP/1.1 201 Created
> Content-Length: 2014
> Content-Type: application/vnd.api+json
> Date: Fri, 13 Nov 2020 11:14:52 GMT
> Location: https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422
> Strict-Transport-Security: max-age=31536000; includeSubDomains
> X-Content-Type-Options: nosniff
> 
> {
>    "data" : {
>       "attributes" : {},
>       "id" : "672422",
>       "links" : {
>          "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422"
>       },
>       "relationships" : {
>          "blocks" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/blocks",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/blocks"
>             }
>          },
>          "context_on_site_adblock" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/context_on_site_adblock",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/context_on_site_adblock"
>             }
>          },
>          "context_on_site_content" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/context_on_site_content",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/context_on_site_content"
>             }
>          },
>          "context_on_site_direct" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/context_on_site_direct",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/context_on_site_direct"
>             }
>          },
>          "context_on_site_natural" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/context_on_site_natural",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/context_on_site_natural"
>             }
>          },
>          "context_on_site_rtb" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/context_on_site_rtb",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/context_on_site_rtb"
>             }
>          },
>          "context_on_site_stripe" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/context_on_site_stripe",
>                "self" : "https://jsonapi.partner2.yandex.com:443/v1/context_on_site_campaign/672422/relationships/context_on_site_stripe"
>             }
>          }
>       },
>       "type" : "context_on_site_campaign"
>    }
> }
> ```


## Добавление домена {#domain}

Чтобы добавить домен, воспользуйтесь операцией [POST/{resource-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/post-resource-id.md).

> Запрос:
> 
> ```
> curl -v -H "Accept: application/vnd.api+json" \
> -H "Content-Type: application/vnd.api+json" \
> -H "Authorization: token ac3b42lp-89ls-..." \
> -X POST \
> --data \
>   '{
>      "data":
>      {
>        "type":"site",
>        "attributes":
>        {
>          "domain":"mysite.com"
>        }
>      }
>    }' \
> 'https://jsonapi.partner2.yandex.com/v1/site' | json_pp
> ```
> 
> Ответ:
> 
> ```json
> HTTP/1.1 201 Created
> Content-Length: 147
> Content-Type: application/vnd.api+json
> Date: Fri, 13 Nov 2020 11:26:47 GMT
> Location: https://jsonapi.partner2.yandex.com/v1/site/184480
> Strict-Transport-Security: max-age=31536000; includeSubDomains
> X-Content-Type-Options: nosniff
> 
> {
>    "data" : {
>       "attributes" : {},
>       "id" : "184480",
>       "links" : {
>          "self" : "https://jsonapi.partner2.yandex.com/v1/site/184480"
>       },
>       "relationships" : {},
>       "type" : "site"
>    }
> }
> ```

## Подтверждение владения доменом {#site-owner}

1. Получите идентификатор `SITE_OWNER_ID` объекта, в котором хранится состояние проверки владения, по идентификатору площадки `PAGE_ID`. Для этого воспользуйтесь операцией [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id-object-id.md) с параметром `include=site_owner`.

   В ответе значение `SITE_OWNER_ID` содержится в поле `id` объекта с типом `site_owner` в массиве `included`.

   > Запрос:
   > 
   > ```
   > curl -s https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/{PAGE_ID}?include=site_owner \
   > -H "Authorization: $TOKEN"
   > ```
   > 
   > Ответ:
   > 
   > ```json
   > {
   >   "included": [
   >     {
   >       "id": "123",
   >       "type": "site_owner",
   >       ...
   >     }
   >   ],
   >   ...
   > }
   > ```

2. Запросите доступные способы подтверждения владения с помощью операции [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id-object-id.md).

   > 
   > ```
   > curl -s https://jsonapi.partner2.yandex.com/v1/site_owner/{SITE_OWNER_ID}?fields[site_owner]=actions \
   > -H "Authorization: $TOKEN"
   > ```

   Действия `actions` для подтверждения владения:

   - `confirm_ownership_via_file` — подтверждение через файл `ads.txt`;
   - `confirm_ownership_via_webmaster` — подтверждение через Вебмастер.

3. Подтвердите владение одним из способов:

   {% list tabs %}

   - Файл ads.txt

     1. Добавьте файл `ads.txt` на ваш сайт:

        1. Скачайте файл [ads.txt](https://yandex.ru/support/partner/ru/web/ads-txt-setup) в форме подтверждения или на вкладке [Настройки](https://partner.yandex.ru/v2/settings/general) → **Общие**.
        1. Если файл `ads.txt` уже опубликован на сайте, добавьте в него строки из скачанного файла. Если файла еще нет, используйте скачанный файл без изменений.
        1. Опубликуйте файл на вашем сайте, чтобы он был доступен по адресу `example.com/ads.txt`. 

      1. Запустите проверку с помощью операции [POST/{resource-id}/{object-id}/action/{action-name}](https://yandex.com/dev/partner-objects/doc/ru/reference/post-resource-id-object-id-action-action-name.md):

         > 
         > ```
         > curl -s -X POST \
         > "https://jsonapi.partner2.yandex.com/v1/site_owner/{SITE_OWNER_ID}/action/confirm_ownership_via_file" \
         > -H "Authorization: $TOKEN"
         > ```

   - Вебмастер

      1. Подтвердите права на сайт в [Вебмастере](https://webmaster.yandex.ru/sites/) одним из способов:
         
         - HTML-файлом в корневом каталоге сайта;
         - метатегом на главной странице;
         - TXT-записью в DNS;
         - через менеджер тегов YTM или GTM.
         
         Как это сделать, см. в разделе [Подтверждение прав на сайт](https://yandex.ru/support/webmaster/ru/service/rights#how-to) Справки Вебмастера.

      1. Запустите проверку с помощью операции [POST/{resource-id}/{object-id}/action/{action-name}](https://yandex.com/dev/partner-objects/doc/ru/reference/post-resource-id-object-id-action-action-name.md):

         > 
         > ```
         > curl -s -X POST \
         > "https://jsonapi.partner2.yandex.com/v1/site_owner/{SITE_OWNER_ID}/action/confirm_ownership_via_webmaster" \
         > -H "Authorization: $TOKEN"
         > ```

   {% endlist %}

4. Чтобы узнать статус проверки и время, когда станут доступны следующие попытки, воспользуйтесь операцией [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/get-resource-id-object-id.md):

   > 
   > ```
   > curl -s "https://jsonapi.partner2.yandex.com/v1/site_owner/{SITE_OWNER_ID}?fields[site_owner]=ownership_successfully_confirmed,file_verification_status,file_verification_not_available_until,webmaster_verification_status,webmaster_verification_not_available_until,actions" \
   > -H "Authorization: $TOKEN"
   > ```

## Добавление RTB-блока со стратегией {#rtb-block}

Чтобы добавить RTB-блок со стратегией «Максимальный доход», воспользуйтесь операцией [POST/{resource-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/post-resource-id.md).

`$PI_TOKEN` должен содержать значение токена для API партнерского интерфейса. Например, значение может начинаться с «a7b8e0-». Также задайте свое значение для параметра `page_id`.


<!--&quot;site_version&quot;: &quot;mobile&quot;, (после "page_id": "636326",-->
> Запрос:
> 
> ```
> curl -v -H "Accept: application/vnd.api+json" \
> -H "Content-Type: application/vnd.api+json" \
> -H "Authorization: token $PI_TOKEN" \
> -X POST \
> --data \
>   '{
>     "data":
>     {
>       "type":"context_on_site_rtb",
>       "attributes":
>       {
>         "caption":"API-created block",
>         "page_id": "636326",
>         
>         "block_type": "banner",
>         "design_templates":[
>           {
>             "caption":"Media design",
>             "type":"media",
>             "design_settings":
>             {
>               "filterSizes":false,
>               "horizontalAlign":true
>             }
>           },
>           {
>             "caption":"Standard design",
>             "type":"tga",
>             "filter_tags":["adaptive","vertical"],
>             "is_custom_format_direct": false, 
>             "design_settings":
>             {
>               "name":"adaptive0418",
>               "limit":1
>             }                    
>           }
>         ],
>         "dsp_blocks":["300x300","300x500","300x600","336x280","100%x250"],
>         "blind":0,
>         "strategy":1
>       }
>     }
>   }' \
> 'https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb' | json_pp
> ```
> 
> Ответ:
> 
> ```json
> HTTP/1.1 201 Created
> Content-Length: 683
> Content-Type: application/vnd.api+json
> Date: Fri, 13 Nov 2020 11:32:18 GMT
> Location: https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-3
> Strict-Transport-Security: max-age=31536000; includeSubDomains
> X-Content-Type-Options: nosniff
> 
> 
> {
>    "data" : {
>       "attributes" : {},
>       "id" : "R-A-636326-4",
>       "links" : {
>          "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4"
>       },
>       "relationships" : {
>          "context_on_site_campaign" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/context_on_site_campaign",
>                "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/relationships/context_on_site_campaign"
>             }
>          },
>          "pages" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/pages",
>                "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/relationships/pages"
>             }
>          }
>       },
>       "type" : "context_on_site_rtb"
>    }
> }
> ```

> Установить порог CPM на весь блок:
> 
> ```
> 
>          "attributes": {
>             "strategy":"0",
>             "mincpm":"123"
>         }
>          
> ```


## Редактирование параметров RTB-блока {#rtb-edit}

Чтобы отредактировать название RTB-блока, воспользуйтесь операцией [PATCH/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/ru/reference/patch-resource-id-object-id.md).

> Запрос:
> 
> ```
> curl -v -H "Accept: application/vnd.api+json" \
> -H "Content-Type: application/vnd.api+json" \
> -H "Authorization: token ac3b42lp-89ls-..." \
> -X PATCH \
> --data \
>   '{
>      "data":
>      {
>        "type":"context_on_site_rtb",
>        "id":"R-A-636326-1",
>        "attributes": 
>        {
>          "caption":"MyBlock"
>        }
>      }
>    }' \
> 'https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-1' | json_pp
> ```
> 
> Ответ:
> 
> ```
> HTTP/1.1 200 OK
> Content-Length: 732
> Content-Type: application/vnd.api+json
> Date: Fri, 13 Nov 2020 11:40:50 GMT
> Strict-Transport-Security: max-age=31536000; includeSubDomains
> X-Content-Type-Options: nosniff
> 
> {
>    "data" : {
>       "attributes" : {
>          "caption" : "MyBlock"
>       },
>       "id" : "R-A-636326-1",
>       "relationships" : {
>          "context_on_site_campaign" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-1/context_on_site_campaign",
>                "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-1/relationships/context_on_site_campaign"
>             }
>          },
>          "pages" : {
>             "links" : {
>                "related" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-1/pages",
>                "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-1/relationships/pages"
>             }
>          }
>       },
>       "type" : "context_on_site_rtb"
>    },
>    "links" : {
>       "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-1"
>    },
>    "meta" : {
>       "fields" : [
>          "caption"
>       ]
>    }
> }
> ```


## Создание универсального баннера {#universal-block}

> Запрос:
> 
> ```
> 
> curl 'https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb' \
> -X 'POST' \
> -H 'Content-Type: application/vnd.api+json' \
> -H 'Accept: application/vnd.api+json' \
> -H "Authorization: $PI_TOKEN" \
> -d '{
>     "data" : {
>         "attributes" : {
>             "block_type" : "banner",
>             "formats_setup_mode" : "standard",
>             "strategy" : 1,
>             "caption" : "Блок",
>             "page_id" : 12345,
>             "tech_type" : "none"
>         },
>     "type" : "context_on_site_rtb"
>     }
> }'
>          
> ```


## Создание баннера для Turbo {#turbo-banner}

> Запрос:
> 
> ```
> 
> curl 'https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb' \
> -X 'POST' \
> -H 'Content-Type: application/vnd.api+json' \
> -H 'Accept: application/vnd.api+json' \
> -H "Authorization: $PI_TOKEN" \
> -d '{
>     "data" : {
>         "attributes" : {
>             "block_type" : "banner",
>             "formats_setup_mode" : "standard",
>             "strategy" : 1,
>             "caption" : "Блок",
>             "page_id" : 12345,
>             "tech_type" : "turbo"
>         },
>     "type" : "context_on_site_rtb"
>     }
> }'
>          
> ```


## Настройки рекламного блока {#ad-block-settings}

Параметры отображения можно настроить на уровне всего блока.

Настройка темной темы:

> ```
> 
> "attributes":{
>    "pcode_settings":{
>          "themeIndicator":"dark",
>          "bgColorLight":"A387FF",
>          "bgColorDark":"FF6279"
>    }
> }
>          
> ```


## Блокировка рекламного формата {#format-block}

Чтобы заблокировать рекламный формат, удалите его из `design_templates`.

Блокировка брендов и тематик устанавливается на уровне сайта.

> Заблокировать видеорекламу:
> 
> ```
> 
> "attributes" : {
>             "formats_setup_mode" : "manual",
>             "design_templates" : [
>                 {
>                     ...,
>                     "caption" : "Медиа дизайн",
>                     "type" : "media",
>                     ...,
>                 },
>                 {
>                     ...,
>                     "caption" : "ТГА дизайн",
>                     "type" : "tga",
>                     ...,
>                 }
>             ]
>         },
>          
> ```

> Заблокировать медийную рекламу:
> 
> ```
> 
> "attributes" : {
>    "formats_setup_mode" : "manual",
>    "design_templates" : [
>                 {
>                     ...,
>                     "caption" : "Видео дизайн",
>                     "type" : "video",
>                     ...,
>                 },
>                 {
>                     ...,
>                     "caption" : "ТГА дизайн",
>                     "type" : "tga",
>                     ...,
>                 }
>             ]
>         },
>          
> ```


## Блокировка брендов и тематик {#brands-and-themes}

> Заблокировать бренды на уровне сайта
> 
> ```
> 
> curl 'https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12345' \
> -X PATCH \
> -H 'Accept: application/vnd.api+json' \
> -H 'content-type: application/vnd.api+json' \
> -H "Authorization: $TOKEN" \
> -d '{
>     "data":{
>         "attributes":{
>             "brands":[{"bid":"189","blocked":true}]
>         },
>         "type":"context_on_site_campaign",
>         "id":"12345"
>     }
> }'
>          
> ```

> Заблокировать тематики на уровне сайта
> 
> ```
> 
> curl 'https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12345' \
> -X PATCH \
> -H 'Accept: application/vnd.api+json' \
> -H 'content-type: application/vnd.api+json' \
> -H "Authorization: $TOKEN" \
> -d '{
>     "data":{
>         "attributes":{
>             "picategories":[{"id":"2","cpm":9999}]
>         },
>         "type":"context_on_site_campaign",
>         "id":"12345"
>     }
> }'
>          
> ```