get

Возвращает параметры корректировок, отвечающих заданным критериям.

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

Ограничения

Метод возвращает не более 10 000 объектов.

Сумма значений параметров Limit и Offset не должна превышать 120 000 (если Limit не указан, значение Offset не должно превышать 110 000).

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* BidModifiersSelectionCriteria */
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "Ids": [(long), ... ],
      "Types": [( "MOBILE_ADJUSTMENT" | "TABLET_ADJUSTMENT" | "DESKTOP_ADJUSTMENT" | "DESKTOP_ONLY_ADJUSTMENT" | "DEMOGRAPHICS_ADJUSTMENT" | "RETARGETING_ADJUSTMENT" | "REGIONAL_ADJUSTMENT" | "VIDEO_ADJUSTMENT" | "SMART_AD_ADJUSTMENT" | "SERP_LAYOUT_ADJUSTMENT" | "INCOME_GRADE_ADJUSTMENT" | "AD_GROUP_ADJUSTMENT" ), ... ],
      "Levels": [( "CAMPAIGN" | "AD_GROUP" ), ... ] /* required */
    }, /* required */
    "FieldNames": [( "Id" | "CampaignId" | "AdGroupId" | "Level" | "Type" ), ... ], /* required */
    "MobileAdjustmentFieldNames": [( "BidModifier" | "OperatingSystemType" ), ... ],
    "TabletAdjustmentFieldNames": [( "BidModifier" | "OperatingSystemType" ), ... ],
    "DesktopAdjustmentFieldNames": [( "BidModifier" )],
    "DesktopOnlyAdjustmentFieldNames": [( "BidModifier" )],
    "DemographicsAdjustmentFieldNames": [( "Gender" | "Age" | "BidModifier" | "Enabled" ), ... ],
    "RetargetingAdjustmentFieldNames": [( "RetargetingConditionId" | "BidModifier" | "Accessible" | "Enabled" ), ... ],
    "RegionalAdjustmentFieldNames": [( "RegionId" | "BidModifier" | "Enabled" ), ... ],
    "VideoAdjustmentFieldNames": [( "BidModifier" )],
    "SmartAdAdjustmentFieldNames": [( "BidModifier" )],
    "SerpLayoutAdjustmentFieldNames": [( "SerpLayout" | "BidModifier" | "Enabled" ), ... ],
    "IncomeGradeAdjustmentFieldNames": [( "Grade" | "BidModifier" | "Enabled" ), ... ],
    "AdGroupAdjustmentFieldNames" : [ ("BidModifier") ],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Параметр

Тип

Описание

Обязательный

Структура params (для JSON) / GetRequest (для SOAP)

SelectionCriteria

BidModifiersSelectionCriteria

Критерий отбора корректировок.

Да

FieldNames

array of BidModifierFieldEnum

Имена параметров верхнего уровня, которые требуется получить.

Да

MobileAdjustmentFieldNames

array of MobileAdjustmentFieldEnum

Имена параметров корректировок на мобильных, которые требуется получить.

Нет

TabletAdjustmentFieldNames

array of TabletAdjustmentFieldEnum

Имена параметров корректировок на планшетах, которые требуется получить.

Нет

DesktopAdjustmentFieldNames

array of DesktopAdjustmentFieldEnum

Имена параметров корректировок на компьютерах, Smart TV, которые требуется получить.

Нет

DesktopOnlyAdjustmentFieldNames

array of DesktopOnlyAdjustmentFieldEnum

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

Нет

DemographicsAdjustmentFieldNames

array of DemographicsAdjustmentFieldEnum

Имена параметров корректировок по полу и возрасту, которые требуется получить.

Нет

RetargetingAdjustmentFieldNames

array of RetargetingAdjustmentFieldEnum

Имена параметров корректировок для целевой аудитории, которые требуется получить.

Нет

RegionalAdjustmentFieldNames

array of RegionalAdjustmentFieldEnum

Имена параметров корректировок по региону показа, которые требуется получить.

Нет

VideoAdjustmentFieldNames

array of VideoAdjustmentFieldEnum

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

Нет

SmartAdAdjustmentFieldNames

array of SmartAdAdjustmentFieldEnum

Имена параметров корректировок для смарт-объявлений, которые требуется получить.

Нет

SerpLayoutAdjustmentFieldNames

array of SerpLayoutAdjustmentFieldEnum

Имена параметров корректировок на эксклюзивное размещение, которые требуется получить.

Нет

IncomeGradeAdjustmentFieldNames

array of IncomeGradeAdjustmentFieldEnum

Имена параметров корректировок на платежеспособность, которые требуется получить.

Нет

AdGroupAdjustmentFieldNames

array of AdGroupAdjustmentFieldEnum

Имена параметров корректировок на группу, которые требуется получить.

Нет

Page

LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет

Структура BidModifiersSelectionCriteria

CampaignIds

array of long

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

От 1 до 10 элементов в массиве.

Хотя бы один из параметров CampaignIds, AdGroupIds и Ids

AdGroupIds

array of long

Отбирать корректировки, заданные для указанных групп.

От 1 до 1000 элементов в массиве.

Ids

array of long

Отбирать корректировки с указанными идентификаторами. От 1 до 10 000 элементов в массиве.

Types

array of BidModifierTypeEnum

Отбирать корректировки указанных типов. См. Типы корректировок.

Нет

Levels

array of BidModifierLevelEnum

Отбирать корректировки указанных уровней:

  • CAMPAIGN — корректировки, заданные для кампаний;
  • AD_GROUP — корректировки, заданные для групп объявлений.

Да

Ответ

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

{
  "result": { /* result */
    "BidModifiers": [{  /* BidModifierGetItem */
      "CampaignId": (long),
      "AdGroupId": (long), /* nillable */
      "Id": (long),
      "Level": ( "CAMPAIGN" | "AD_GROUP" ),
      "Type": ( "MOBILE_ADJUSTMENT" | "TABLET_ADJUSTMENT" | "DESKTOP_ADJUSTMENT" | "DESKTOP_ONLY_ADJUSTMENT" | "DEMOGRAPHICS_ADJUSTMENT" | "RETARGETING_ADJUSTMENT" | "REGIONAL_ADJUSTMENT" | "VIDEO_ADJUSTMENT" | "SMART_AD_ADJUSTMENT" | "SERP_LAYOUT_ADJUSTMENT" | "INCOME_GRADE_ADJUSTMENT" | "AD_GROUP_ADJUSTMENT" ),
      "MobileAdjustment": {  /* MobileAdjustmentGet */
        "BidModifier": (int),
        "OperatingSystemType": ( "IOS" | "ANDROID" )
      },
      "TabletAdjustment": {  /* MobileAdjustmentGet */
        "BidModifier": (int), /* required */
        "OperatingSystemType": ( "IOS" | "ANDROID" )
      },
      "DesktopAdjustment": {  /* DesktopAdjustmentGet */
        "BidModifier": (int)
      },
      "DesktopOnlyAdjustment": {  /* DesktopAdjustmentGet */
        "BidModifier": (int) /* required */
      },
      "DemographicsAdjustment": {  /* DemographicsAdjustmentGet */
        "Gender": ( "GENDER_MALE" | "GENDER_FEMALE" ), /* nillable */
        "Age": ( "AGE_0_17" | "AGE_18_24" | "AGE_25_34" | "AGE_35_44" | "AGE_45" | "AGE_45_54" | "AGE_55" ), /* nillable */
        "BidModifier": (int),
        "Enabled": ( "YES" | "NO" )
      },
      "RetargetingAdjustment": {  /* RetargetingAdjustmentGet */
        "RetargetingConditionId": (long),
        "BidModifier": (int),
        "Accessible": ( "YES" | "NO" ),
        "Enabled": ( "YES" | "NO" )
      },
      "RegionalAdjustment": {  /* RegionalAdjustmentGet */
        "RegionId": (long),
        "BidModifier": (int),
        "Enabled": ("YES"|"NO")
      },
      "VideoAdjustment": {  /* VideoAdjustmentGet */
        "BidModifier": (int)
      },
      "SmartAdAdjustment" : { /* SmartAdAdjustmentGet */
        "BidModifier": (int)
      },
      "SerpLayoutAdjustment": {  /* SerpLayoutAdjustmentGet */
        "SerpLayout": ( "ALONE" | "SUGGEST" ),
        "BidModifier": (int),
        "Enabled": ( "YES" | "NO" )
      },
      "IncomeGradeAdjustment": {  /* IncomeGradeAdjustmentGet */
        "Grade": ( "VERY_HIGH" | "HIGH" | "ABOVE_AVERAGE" ),
        "BidModifier": (int),
        "Enabled": ( "YES" | "NO" )
      },
      "AdGroupAdjustment" : {
        "BidModifier" : (integer)
      }
    }, ... ],
    "LimitedBy": (long)
  }
}

Параметр

Тип

Описание

Структура result (для JSON) / GetResponse (для SOAP)

BidModifiers

array of BidModifierGetItem

Корректировки ставок.

LimitedBy

long

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

Структура BidModifierGetItem

CampaignId

long

Идентификатор кампании, для которой задана корректировка, или идентификатор кампании, которой принадлежит группа объявлений, для которой задана корректировка.

AdGroupId

long, nillable

Идентификатор группы объявлений, для которой задана корректировка.

Id

long

Идентификатор корректировки.

Level

BidModifierLevelEnum

Уровень корректировки: задана для кампании или для группы.

Type

BidModifierTypeEnum

Тип корректировки.

MobileAdjustment

MobileAdjustmentGet

Параметры корректировки на мобильных.

TabletAdjustment

TabletAdjustmentGet

Параметры корректировки на планшетах.

DesktopAdjustment

DesktopAdjustmentGet

Параметры корректировки на компьютерах, Smart TV.

DesktopOnlyAdjustment

DesktopOnlyAdjustmentGet

Параметры корректировки только на компьютерах.

VideoAdjustment

VideoAdjustmentGet

Параметры корректировки для видеодополнений.

DemographicsAdjustment

DemographicsAdjustmentGet

Параметры корректировки ставок по полу и возрасту.

RetargetingAdjustment

RetargetingAdjustmentGet

Параметры корректировки ставок для целевой аудитории.

RegionalAdjustment

RegionalAdjustmentGet

Параметры корректировки ставок по региону показа.

SmartAdAdjustment

SmartAdAdjustmentGet

Параметры корректировки ставок для смарт-баннеров.

IncomeGradeAdjustment

IncomeGradeAdjustmentGet

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

SerpLayoutAdjustment

SerpLayoutAdjustmentGet

Параметры корректировки на эксклюзивное размещение.

AdGroupAdjustment

AdGroupAdjustmentGet

Параметры корректировки на группу.

Структура MobileAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа объявлений на мобильных телефонах.

Указывается в процентах:

  • От 0 до 1300 — для корректировок во всех типах кампаний и групп.

Ставка умножается на значение BidModifier/100.

OperatingSystemType

OperatingSystemTypeEnum

Тип операционной системы.

Если параметр не указан, подразумевается любая операционная система.

Структура TabletAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа объявлений на планшетах.

Указывается в процентах:

  • От 0 до 1300 — для корректировок во всех типах кампаний и групп.

Ставка умножается на значение BidModifier/100.

OperatingSystemType

OperatingSystemTypeEnum

Тип операционной системы.

Если параметр не указан, подразумевается любая операционная система.

Структура DesktopAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа объявлений на компьютерах, Smart TV.

Указывается в процентах:

  • От 0 до 1300 — для корректировок во всех типах кампаний и групп.

Ставка умножается на значение BidModifier/100.

В одной группе объявлений коэффициент для показа на мобильных без указания операционной системы и коэффициент для показа на компьютерах, планшетах, Smart TV не допускается устанавливать одновременно равными 0.

Структура DesktopOnlyAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа объявлений только на компьютерах.

Указывается в процентах:

  • От 0 до 1300 — для корректировок во всех типах кампаний и групп.

Ставка умножается на значение BidModifier/100.

В одной группе объявлений коэффициент для показа на мобильных без указания операционной системы и коэффициент для показа только на компьютерах не допускается устанавливать одновременно равными 0.

Структура DemographicsAdjustmentGet

Gender

GenderEnum, nillable

Пол пользователя: GENDER_MALE или GENDER_FEMALE.

Если параметр не указан, подразумевается любой пол.

Age

AgeRangeEnum, nillable

Возрастная группа пользователя: одно из значений AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45_54 или AGE_55.

Значение AGE_45 устарело, рекомендуется создать отдельные корректировки для возрастных групп AGE_45_54 и AGE_55.

Если параметр не указан, подразумевается любой возраст.

BidModifier

int

Значение коэффициента к ставке для показа объявлений пользователям указанного пола и/или возрастной группы.

Указывается в процентах от 0 до 1300. Ставка умножается на значение BidModifier/100.

Enabled

YesNoEnum

Включен или отключен набор корректировок по полу и возрасту.

Структура RetargetingAdjustmentGet

RetargetingConditionId

long

Идентификатор условия ретаргетинга и подбора аудитории. Допускается только условие с типом RETARGETING. См. раздел Условие ретаргетинга и подбора аудитории (RetargetingList).

BidModifier

int

Значение коэффициента к ставке для показа объявлений пользователям, отвечающим условию ретаргетинга и подбора аудитории.

Указывается в процентах от 0 до 1300. Ставка умножается на значение BidModifier/100.

Accessible

YesNoEnum

Признак того, что все цели и сегменты в условии ретаргетинга и подбора аудитории доступны рекламодателю. Значение NO — одна или несколько целей или один или несколько сегментов недоступны.

Enabled

YesNoEnum

Включен или отключен набор корректировок для целевой аудитории.

Структура RegionalAdjustmentGet

RegionId

long

Идентификатор региона из справочника регионов.

Справочник регионов можно получить с помощью метода Dictionaries.get.

BidModifier

int

Значение коэффициента к ставке для показа объявлений в указанном регионе.

Указывается в процентах от 10 до 1300. Ставка умножается на значение BidModifier/100.

Enabled

YesNoEnum

Включен или отключен набор корректировок по региону показа.

Структура VideoAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа объявлений с видеодополнением.

Указывается в процентах от 50 до 1300. Ставка умножается на значение BidModifier/100.

Структура SmartAdAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа смарт-объявления с одним товарным предложением.

Указывается в процентах от 20 до 1300. Ставка умножается на значение BidModifier/100.

Структура SerpLayoutAdjustmentGet

SerpLayout

SerpLayoutEnum

Блок показа объявления:

  • ALONE — Эксклюзивное размещение.
  • SUGGEST — Реклама в саджесте.

BidModifier

int

Значение коэффициента к ставке для показа объявлений в указанной позиции.

Указывается в процентах от 1 до 1300. Ставка умножается на значение BidModifier/100.

Enabled

YesNoEnum

Включен или отключен набор корректировок на эксклюзивное размещение.

Структура IncomeGradeAdjustmentGet

Grade

IncomeGradeEnum

Уровень платежеспособности:

  • VERY_HIGH
  • HIGH
  • ABOVE_AVERAGE

BidModifier

int

Значение коэффициента к ставке для показа объявлений пользователям с определенным уровнем платежеспособности.

Указывается в процентах от 1 до 1300. Ставка умножается на значение BidModifier/100.

Enabled

YesNoEnum

Включен или отключен набор корректировок на платежеспособность.

Структура AdGroupAdjustmentGet

BidModifier

int

Значение коэффициента к ставке для показа объявлений из определенной группы.

Указывается в процентах от 1 до 1300. Ставка умножается на значение BidModifier/100.
Предыдущая
delete
Следующая
set