get
Возвращает условия ретаргетинга и подбора аудитории.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* RetargetingListSelectionCriteria */
"Ids": [(long), ... ],
"Types": [( RETARGETING | AUDIENCE ), ... ]
},
"FieldNames": [( "Type" | "Id" | "Name" | "Description" | "Rules" | "IsAvailable" | "Scope" | "AvailableForTargetsInAdGroupTypes" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | RetargetingListSelectionCriteria | Критерий отбора условий ретаргетинга и подбора аудитории. Если не указан, будут получены все условия ретаргетинга и подбора аудитории, принадлежащие рекламодателю. | Нет |
FieldNames | array of RetargetingListFieldEnum | Имена параметров верхнего уровня, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура RetargetingListSelectionCriteria | |||
Ids | array of long | Отбирать условия ретаргетинга и подбора аудитории с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Нет |
Types | array of RetargetingListTypeEnum | Отбирать условия ретаргетинга и подбора аудитории с указанными типами. См. раздел Тип условия ретаргетинга и подбора аудитории. | Нет |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | RetargetingListSelectionCriteria | Критерий отбора условий ретаргетинга и подбора аудитории. Если не указан, будут получены все условия ретаргетинга и подбора аудитории, принадлежащие рекламодателю. | Нет |
FieldNames | array of RetargetingListFieldEnum | Имена параметров верхнего уровня, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура RetargetingListSelectionCriteria | |||
Ids | array of long | Отбирать условия ретаргетинга и подбора аудитории с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Нет |
Types | array of RetargetingListTypeEnum | Отбирать условия ретаргетинга и подбора аудитории с указанными типами. См. раздел Тип условия ретаргетинга и подбора аудитории. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"RetargetingLists": [{ /* RetargetingListGetItem */
"Type": ( RETARGETING | AUDIENCE ),
"Id": (long),
"IsAvailable": ( "YES" | "NO" ),
"Name": (string),
"Description": (string),
"Rules": [{ /* RetargetingListRuleItem */
"Arguments": [{ /* RetargetingListRuleArgumentItem */
"MembershipLifeSpan": (int), /* required */
"ExternalId": (long) /* required */
}, ... ], /* required */
"Operator": ( "ALL" | "ANY" | "NONE" ) /* required */
}, ... ],
"Scope": ( "FOR_TARGETS_AND_ADJUSTMENTS" | "FOR_ADJUSTMENTS_ONLY" | "FOR_TARGETS_ONLY" ),
"AvailableForTargetsInAdGroupTypes": { /* AvailableForTargetsInAdGroupTypesArray */
"Items": [( "TEXT_AD_GROUP" | "MOBILE_APP_AD_GROUP" | "DYNAMIC_TEXT_AD_GROUP"
| "CPM_BANNER_AD_GROUP" | "CPM_VIDEO_AD_GROUP" | "CONTENT_PROMOTION_AD_GROUP"
| "SMART_AD_GROUP" ), ... ]
} /* nillable */
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
RetargetingLists | array of RetargetingListGetItem | Условия ретаргетинга и подбора аудитории. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура RetargetingListGetItem | ||
Type | RetargetingListTypeEnum | Тип условия ретаргетинга и подбора аудитории. См. раздел Тип условия ретаргетинга и подбора аудитории. |
Id | long | Идентификатор условия ретаргетинга и подбора аудитории. |
Name | string | Название условия ретаргетинга и подбора аудитории (не более 250 символов). |
Description | string | Текстовое примечание к условию ретаргетинга и подбора аудитории (не более 4096 символов). |
IsAvailable | YesNoEnum | YES — все цели и сегменты в условии ретаргетинга и подбора аудитории доступны; NO — в условии есть недоступная цель или сегмент, показ объявлений и корректировки ставок по данному условию не осуществляются. Цель или сегмент становятся недоступными в случае удаления или в случае, если доступ отменен владельцем (см. раздел Управление доступом к счетчику помощи Яндекс Метрики). |
Rules | array of RetargetingListRuleItem | Правила отбора посетителей сайта. Посетитель удовлетворяет условию ретаргетинга и подбора аудитории, если для него выполнены одновременно все правила. Ограничения на правила отбора и примеры структуры приведены в разделе Правила отбора пользователей. |
Scope | RetargetingListScopeEnum | Область применения условия ретаргетинга и подбора аудитории: в условиях нацеливания на аудиторию, в корректировках ставок или везде. См. раздел Область применения. |
AvailableForTargetsInAdGroupTypes | AvailableForTargetsInAdGroupTypesArray | Область применения условия ретаргетинга и подбора аудитории: типы групп, в которые можно добавить условие нацеливания на аудиторию по данному условию ретаргетинга. null (nil) — условие ретаргетинга может применяться только в корректировках ставок. |
Структура RetargetingListRuleItem | ||
Arguments | array of RetargetingListRuleArgumentItem | Цели и сегменты. См. раздел Цели и сегменты. |
Operator | RetargetingListRuleOperatorEnum | Логический оператор правила отбора:
|
Структура RetargetingListRuleArgumentItem | ||
MembershipLifeSpan | int | Количество дней (от 1 до 540), за которое проверяется выполнение цели. Для сегментов Яндекс Метрики и сегментов Яндекс Аудиторий параметр не используется. |
ExternalId | long | Идентификатор цели или сегмента. Для сегментов по интересам пользователя необходимо перед идентификатором указать тип интереса с помощью префикса:
Например, идентификатору сегмента |
Структура AvailableForTargetsInAdGroupTypesArray | ||
Items | array of AdGroupTypesEnum | Типы групп, в которые можно добавлять условие нацеливания на аудиторию по данному условию ретаргетинга и подбора аудитории. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
RetargetingLists | array of RetargetingListGetItem | Условия ретаргетинга и подбора аудитории. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура RetargetingListGetItem | ||
Type | RetargetingListTypeEnum | Тип условия ретаргетинга и подбора аудитории. См. раздел Тип условия ретаргетинга и подбора аудитории. |
Id | long | Идентификатор условия ретаргетинга и подбора аудитории. |
Name | string | Название условия ретаргетинга и подбора аудитории (не более 250 символов). |
Description | string | Текстовое примечание к условию ретаргетинга и подбора аудитории (не более 4096 символов). |
IsAvailable | YesNoEnum | YES — все цели и сегменты в условии ретаргетинга и подбора аудитории доступны; NO — в условии есть недоступная цель или сегмент, показ объявлений и корректировки ставок по данному условию не осуществляются. Цель или сегмент становятся недоступными в случае удаления или в случае, если доступ отменен владельцем (см. раздел Управление доступом к счетчику помощи Яндекс Метрики). |
Rules | array of RetargetingListRuleItem | Правила отбора посетителей сайта. Посетитель удовлетворяет условию ретаргетинга и подбора аудитории, если для него выполнены одновременно все правила. Ограничения на правила отбора и примеры структуры приведены в разделе Правила отбора пользователей. |
Scope | RetargetingListScopeEnum | Область применения условия ретаргетинга и подбора аудитории: в условиях нацеливания на аудиторию, в корректировках ставок или везде. См. раздел Область применения. |
AvailableForTargetsInAdGroupTypes | AvailableForTargetsInAdGroupTypesArray | Область применения условия ретаргетинга и подбора аудитории: типы групп, в которые можно добавить условие нацеливания на аудиторию по данному условию ретаргетинга. null (nil) — условие ретаргетинга может применяться только в корректировках ставок. |
Структура RetargetingListRuleItem | ||
Arguments | array of RetargetingListRuleArgumentItem | Цели и сегменты. См. раздел Цели и сегменты. |
Operator | RetargetingListRuleOperatorEnum | Логический оператор правила отбора:
|
Структура RetargetingListRuleArgumentItem | ||
MembershipLifeSpan | int | Количество дней (от 1 до 540), за которое проверяется выполнение цели. Для сегментов Яндекс Метрики и сегментов Яндекс Аудиторий параметр не используется. |
ExternalId | long | Идентификатор цели или сегмента. Для сегментов по интересам пользователя необходимо перед идентификатором указать тип интереса с помощью префикса:
Например, идентификатору сегмента |
Структура AvailableForTargetsInAdGroupTypesArray | ||
Items | array of AdGroupTypesEnum | Типы групп, в которые можно добавлять условие нацеливания на аудиторию по данному условию ретаргетинга и подбора аудитории. |