get
Returns the parameters of smart banner targeting filters.
Restrictions
The method returns a maximum of 10,000 objects.
Request
Request structure in JSON format:
{
"method": "get",
"params": { /* params */
"SelectionCriteria" : { /* SmartAdTargetsSelectionCriteria */
"Ids": [(long), ... ],
"AdGroupIds": [(long), ... ],
"CampaignIds": [(long), ... ],
"States" : [( "ON" | "OFF" | "SUSPENDED" | "DELETED" ), ... ]
}, /* required */
"FieldNames" : [( "Id" | "AdGroupId" | "CampaignId" | "Name" | "AverageCpc" | "AverageCpa" | "StrategyPriority" | "Conditions" | "ConditionType" | "State" | "Audience" | "AvailableItemsOnly" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / GetRequest (for SOAP) | |||
---|---|---|---|
SelectionCriteria | SmartAdTargetsSelectionCriteria | Criteria for selecting filters. | Yes |
FieldNames | array of SmartAdTargetFieldEnum | The names of parameters to get. | Yes |
Page | LimitOffset | Structure that defines the page for paginated selection of data. | No |
SmartAdTargetsSelectionCriteria structure | |||
Ids | array of long | Selects filters with the specified IDs. Maximum of 10,000 items in the array. | At least one of the parameters Ids, AdGroupIds, or CampaignIds (or all may be present) |
AdGroupIds | array of long | Selects filters for the specified groups. Maximum of 1000 items in the array. | |
CampaignIds | array of long | Selects filters for the specified campaigns. Maximum of 2 items in the array. | |
States | array of SmartAdTargetStateSelectionEnum | Selects filters with the specified states. For a description of the states, see Filter status. Restriction.
| No |
Parameter | Type | Description | Required |
Params structure (for JSON) / GetRequest (for SOAP) | |||
---|---|---|---|
SelectionCriteria | SmartAdTargetsSelectionCriteria | Criteria for selecting filters. | Yes |
FieldNames | array of SmartAdTargetFieldEnum | The names of parameters to get. | Yes |
Page | LimitOffset | Structure that defines the page for paginated selection of data. | No |
SmartAdTargetsSelectionCriteria structure | |||
Ids | array of long | Selects filters with the specified IDs. Maximum of 10,000 items in the array. | At least one of the parameters Ids, AdGroupIds, or CampaignIds (or all may be present) |
AdGroupIds | array of long | Selects filters for the specified groups. Maximum of 1000 items in the array. | |
CampaignIds | array of long | Selects filters for the specified campaigns. Maximum of 2 items in the array. | |
States | array of SmartAdTargetStateSelectionEnum | Selects filters with the specified states. For a description of the states, see Filter status. Restriction.
| No |
Response
Response structure in JSON format:
{
"result": { /* result */
"SmartAdTargets": [{ /* SmartAdTargetGetItem */
"Id": (long),
"AdGroupId": (long),
"CampaignId": (long),
"Name": (string),
"AverageCpc": (long), /* nillable */
"AverageCpa": (long), /* nillable */
"StrategyPriority": ( "LOW" | "NORMAL" | "HIGH"), /* nillable */
"State": ( "OFF" | "ON" | "SUSPENDED" | "DELETED" | "UNKNOWN" ),
"Audience": ( "INTERESTED_IN_SIMILAR_PRODUCTS" | "VISITED_PRODUCT_PAGE" | "ALL_SEGMENTS"),
"Conditions": { /* ConditionsArray */
"Items": [{ /* ConditionsItem */
"Operand": (string), /* required */
"Operator": ( "GREATER_THAN" | "LESS_THAN" | "IN_RANGE" | "EXISTS" | "EQUALS_ANY" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */
"Arguments" : [ (string) ] /* required */
}, ... ]
}, /* nillable */
"ConditionType": ( "ITEMS_ALL" | "ITEMS_SUBSET" ),
"AvailableItemsOnly": ( "YES" | "NO" ) /* nillable */
}, ... ],
"LimitedBy": (long)
}
}
Parameter | Type | Description |
Result structure (for JSON) / GetResponse (for SOAP) | ||
---|---|---|
SmartAdTargets | array of SmartAdTargetGetItem | Filters. |
LimitedBy | long | Sequential 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. |
SmartAdTargetGetItem structure | ||
Id | long | The ID of the filter. |
AdGroupId | long | ID of the ad group that the filter belongs to. |
CampaignId | long | ID of the campaign that the filter belongs to. |
Name | string | The name of the filter. |
AverageCpc | long, nillable | Average CPC multiplied by 1,000,000. Integer. |
AverageCpa | long, nillable | Average CPC multiplied by 1,000,000. Integer. |
StrategyPriority | PriorityEnum, nillable | Priority: LOW, NORMAL or HIGH. |
State | StateEnum | Filter state. For a description of the states, see Filter status. |
Audience | AudienceEnum | Target audience:
|
Conditions | ConditionsArray, nillable | Rules for selecting product offers. A product offer is selected for display if it meets all the selection rules at the same time. If this parameter is omitted, the filter selects all product offers from the feed (ITEMS_ALL selection type). |
ConditionType | ConditionTypeEnum | Type of product offer selection. For a description, see Type of product offer selection. |
AvailableItemsOnly | YesNoEnum | Select only products in stock. The default value is NO. It can only be used in feeds with the Yandex Market type and will be ignored in other feeds. |
ConditionsArray structure | ||
Items | array of ConditionsItem | Selection rules. Maximum of 10 items in the array. |
ConditionsItem structure | ||
Operand | string | Feed parameter. For a description of fields for each type of feed, see Configuring filters in the Help for Yandex Direct. |
Operator | StringConditionOperatorEnum | Comparison operator. For information on the compatibility of feed fields and operators, as well as restrictions on values, see Selection rule. |
Arguments | string | An array of strings to compare the operand to. |
Parameter | Type | Description |
Result structure (for JSON) / GetResponse (for SOAP) | ||
---|---|---|
SmartAdTargets | array of SmartAdTargetGetItem | Filters. |
LimitedBy | long | Sequential 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. |
SmartAdTargetGetItem structure | ||
Id | long | The ID of the filter. |
AdGroupId | long | ID of the ad group that the filter belongs to. |
CampaignId | long | ID of the campaign that the filter belongs to. |
Name | string | The name of the filter. |
AverageCpc | long, nillable | Average CPC multiplied by 1,000,000. Integer. |
AverageCpa | long, nillable | Average CPC multiplied by 1,000,000. Integer. |
StrategyPriority | PriorityEnum, nillable | Priority: LOW, NORMAL or HIGH. |
State | StateEnum | Filter state. For a description of the states, see Filter status. |
Audience | AudienceEnum | Target audience:
|
Conditions | ConditionsArray, nillable | Rules for selecting product offers. A product offer is selected for display if it meets all the selection rules at the same time. If this parameter is omitted, the filter selects all product offers from the feed (ITEMS_ALL selection type). |
ConditionType | ConditionTypeEnum | Type of product offer selection. For a description, see Type of product offer selection. |
AvailableItemsOnly | YesNoEnum | Select only products in stock. The default value is NO. It can only be used in feeds with the Yandex Market type and will be ignored in other feeds. |
ConditionsArray structure | ||
Items | array of ConditionsItem | Selection rules. Maximum of 10 items in the array. |
ConditionsItem structure | ||
Operand | string | Feed parameter. For a description of fields for each type of feed, see Configuring filters in the Help for Yandex Direct. |
Operator | StringConditionOperatorEnum | Comparison operator. For information on the compatibility of feed fields and operators, as well as restrictions on values, see Selection rule. |
Arguments | string | An array of strings to compare the operand to. |