toggle

Включает/выключает набор корректировок.

Узнайте больше

Запрос

Структура запроса в формате JSON:

{
  "method": "toggle",
  "params": { /* params */
    "BidModifierToggleItems": [{  /* BidModifierToggleItem */
      "CampaignId": (long),
      "AdGroupId": (long),
      "Type": ( "DEMOGRAPHICS_ADJUSTMENT" | "RETARGETING_ADJUSTMENT" | "REGIONAL_ADJUSTMENT" | "SERP_LAYOUT_ADJUSTMENT" | "INCOME_GRADE_ADJUSTMENT" ), /* required */
      "Enabled": ( "YES" | "NO" ) /* required */
    }, ... ] /* required */
  }
}

Параметр	Тип	Описание	Обязательный
Структура params (для JSON) / ToggleRequest (для SOAP)
`BidModifierToggleItems`	array of BidModifierToggleItem	Наборы корректировок, которые требуется включить или выключить. Не более 1000 элементов в массиве.	Да
Структура BidModifierToggleItem
`CampaignId`	long	Идентификатор кампании. Указывается при включении/выключении корректировок на уровне кампании.	Либо `CampaignId`, либо `AdGroupId`
`AdGroupId`	long	Идентификатор группы объявлений. Указывается при включении/выключении корректировок на уровне группы.	Либо `CampaignId`, либо `AdGroupId`
`Type`	BidModifierTypeEnum	Тип корректировок, которые нужно включить или выключить: DEMOGRAPHICS_ADJUSTMENT, RETARGETING_ADJUSTMENT, REGIONAL_ADJUSTMENT, SERP_LAYOUT_ADJUSTMENT или INCOME_GRADE_ADJUSTMENT.	Да
`Enabled`	YesNoEnum	YES — включить набор корректировок, NO — выключить набор корректировок.	Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "ToggleResults": [{  /* ToggleResult */
      "CampaignId": (long),
      "AdGroupId": (long),
      "Type": ( "DEMOGRAPHICS_ADJUSTMENT" | "RETARGETING_ADJUSTMENT" | "REGIONAL_ADJUSTMENT" | "SERP_LAYOUT_ADJUSTMENT" | "INCOME_GRADE_ADJUSTMENT" ), /* required */
      "Warnings": [{  /* ExceptionNotification */
         "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ]
    }, ... ]
  }
}

Параметр	Тип	Описание
Структура result (для JSON) / ToggleResponse (для SOAP)
`ToggleResults`	array of ToggleResult	Результаты включения/выключения корректировок.
Структура ToggleResult
`CampaignId`	long	Идентификатор кампании. Возвращается в случае успешного выполнения операции (если был указан в запросе).
`AdGroupId`	long	Идентификатор группы объявлений. Возвращается в случае успешного выполнения операции (если был указан в запросе).
`Type`	BidModifierTypeEnum	Тип корректировок, которые были включены или выключены.
`Warnings`	array of ExceptionNotification	Предупреждения, возникшие при выполнении операции.
`Errors`	array of ExceptionNotification	Ошибки, возникшие при выполнении операции.

Примеры

Пример выключения корректировок по полу и возрасту на уровне кампании

    {
      "method": "toggle",
      "params": {
        "BidModifierToggleItems": [
          {
            "CampaignId": 10001,
            "Type": "DEMOGRAPHICS_ADJUSTMENT",
            "Enabled": "NO"
          }
        ]
      }
    }

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

set

Campaigns: управление кампаниями