get

Возвращает условия ретаргетинга и подбора аудитории.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

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

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* RetargetingListSelectionCriteria */
      "Ids": [(long), ... ],
      "Types": [( RETARGETING | AUDIENCE ), ... ]
    },
    "FieldNames": [( "Type" | "Id" | "Name" | "Description" | "Rules" | "IsAvailable" | "Scope" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
ПараметрТипОписаниеОбяза-тельный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteriaRetargetingListSelectionCriteria

Критерий отбора условий ретаргетинга и подбора аудитории. Если не указан, будут получены все условия ретаргетинга и подбора аудитории, принадлежащие рекламодателю.

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

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

Нет
Структура RetargetingListSelectionCriteria
Idsarray of longОтбирать условия ретаргетинга и подбора аудитории с указанными идентификаторами. От 1 до 10 000 элементов в массиве.Нет
Typesarray 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" )
    }, ... ],
    "LimitedBy": (long)
  }
}
ПараметрТипОписание
Структура result (для JSON) / GetResponse (для SOAP)
RetargetingListsarray of RetargetingListGetItemУсловия ретаргетинга и подбора аудитории.
LimitedBylongПорядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура RetargetingListGetItem
TypeRetargetingListTypeEnumТип условия ретаргетинга и подбора аудитории. См. раздел Тип условия ретаргетинга и подбора аудитории.
IdlongИдентификатор условия ретаргетинга и подбора аудитории.
NamestringНазвание условия ретаргетинга и подбора аудитории (не более 250 символов).
DescriptionstringТекстовое примечание к условию ретаргетинга и подбора аудитории (не более 4096 символов).
IsAvailableYesNoEnum

YES — все цели и сегменты в условии ретаргетинга и подбора аудитории доступны; NO — в условии есть недоступная цель или сегмент, показ объявлений и корректировки ставок по данному условию не осуществляются.

Цель или сегмент становятся недоступными в случае удаления или в случае, если доступ отменен владельцем (см. раздел Управление доступом к счетчику помощи Яндекс.Метрики).

Rulesarray of RetargetingListRuleItemПравила отбора посетителей сайта. Посетитель удовлетворяет условию ретаргетинга и подбора аудитории, если для него выполнены одновременно все правила.

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

ScopeRetargetingListScopeEnum

Область применения условия ретаргетинга и подбора аудитории. См. раздел Область применения.

Структура RetargetingListRuleItem
Argumentsarray of RetargetingListRuleArgumentItem

Цели и сегменты.

См. раздел Цели и сегменты.

OperatorRetargetingListRuleOperatorEnum

Логический оператор правила отбора:

  • ALL — правило выполнено, если пользователь выполнил все цели и входит во все сегменты;

  • ANY — правило выполнено, если пользователь выполнил хотя бы одну из целей или входит хотя бы в один из сегментов;

  • NONE — правило выполнено, если пользователь не выполнил ни одну из целей и не входит ни в один из сегментов.

Структура RetargetingListRuleArgumentItem
MembershipLifeSpanintКоличество дней (от 1 до 90), за которое проверяется выполнение цели или попадание в сегмент.
ExternalIdlong

Идентификатор цели или сегмента.