get

Returns retargeting lists.

  1. Restrictions
  2. Request
  3. Response

Restrictions

The method returns a maximum of 10,000 objects.

Request

Request structure in JSON format:

{
  "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)
    }
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaRetargetingListSelectionCriteria

Criteria for selecting retargeting lists. If omitted, all retargeting lists that belong to the advertiser are returned.

No
FieldNamesarray of RetargetingListFieldEnumNames of top-level parameters to get.Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
RetargetingListSelectionCriteria structure
Idsarray of longSelects the retargeting lists with the specified IDs. From 1 to 10,000 items in the array.No
Typesarray of RetargetingListTypeEnumSelects the retargeting lists with the specified types. See the section Type of retargeting lists.No

Response

Response structure in JSON format:

{
  "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)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
RetargetingListsarray of RetargetingListGetItemRetargeting lists.
LimitedBylongSequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
RetargetingListGetItem structure
TypeRetargetingListTypeEnumType of retargeting list. See the section Type of retargeting lists.
IdlongID of the retargeting list.
NamestringName of the retargeting list (maximum of 250 characters).
DescriptionstringText note for the retargeting list (maximum of 4096 characters).
IsAvailableYesNoEnum

YES — All the goals and segments in the retargeting list are available; NO — The retargeting list has a goal or segment that is unavailable, so ad displays and bid adjustments aren't possible for this retargeting list.

A goal or segment becomes unavailable if it is deleted, or if the owner revokes access (see Managing tag access in the Help for Yandex.Metrica).

Rulesarray of RetargetingListRuleItemRules for selecting site users. In order for the retargeting list to apply, the user must meet all the rules at once.

For restrictions on user selection rules and examples of the structure, see the section Rules for user selection.

ScopeRetargetingListScopeEnum

Scope of the retargeting list. See the section Scope.

RetargetingListRuleItem structure
Argumentsarray of RetargetingListRuleArgumentItem

Goals and segments.

See the section Goals and segments.

OperatorRetargetingListRuleOperatorEnum

Logical operator for the retargeting list:

  • ALL — The rule is met if the user completed all the goals and is included in all the segments.

  • ANY — The rule is met if the user completed at least one of the goals or the user's session is included in at least one of the segments.

  • NONE — The rule is met if the user didn't complete any of the goals and the user's session isn't included in any of the segments.

RetargetingListRuleArgumentItem structure
MembershipLifeSpanintNumber of days (from 1 to 90) for checking whether goals are completed or segments are matched.
ExternalIdlong

ID of the goal or segment.