Get
Returns retargeting parameters.
Disabled method. Use version 5 of the API.
For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.
Input data
The input data structure in JSON is shown below.
{
"method": "Retargeting",
"param": {
/* RetargetingRequest */
"Action": (string),
"Login": (string),
"SelectionCriteria": {
/* RetargetingSelectionCriteria */
"RetargetingConditionIDS": [
(int)
...
],
"RetargetingIDS": [
(int)
...
],
"AdIDS": [
(long)
...
]
},
"Options": {
"Currency": (string)
}
}
}
Parameters are described below.
Parameter | Description | Required |
RetargetingRequest object | ||
---|---|---|
Action | Action: Get. | Yes |
Login | The username of the client to get the retargeting for. For advertisers, this parameter is ignored. | For agencies |
SelectionCriteria | The RetargetingSelectionCriteria object, which sets criteria for selecting retargetings. | Yes |
Options | The RetargetingRequestOptions object, which sets response parameters. | Yes |
RetargetingSelectionCriteria object | ||
RetargetingConditionIDS | Array of IDs of retargeting conditions to perform the operation for. Maximum of 1000 items in the array. | One of the parameters RetargetingConditionIDS, RetargetingIDS or AdIDS |
RetargetingIDS | Array of retargeting IDs to perform the operation for. Maximum of 1000 items in the array. | |
AdIDS | Array of ad IDs to perform the operation for. Maximum of 1000 items in the array. | |
RetargetingRequestOptions object | ||
Currency | The currency to use for bids in the response. Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. The value must match the campaign currency; otherwise, an error is returned with code 245. | Yes |
Notes | ||
If the SelectionCriteria structure has more than one criterion set, the operation will be performed for those retargetings that simultaneously match all the criteria. For example, if the parameters RetargetingConditionIDS and AdIDS are set, the operation will be made for retargetings that have a condition ID that is in the RetargetingConditionIDS array, and an ad ID that is in the AdIDS array. |
Parameter | Description | Required |
RetargetingRequest object | ||
---|---|---|
Action | Action: Get. | Yes |
Login | The username of the client to get the retargeting for. For advertisers, this parameter is ignored. | For agencies |
SelectionCriteria | The RetargetingSelectionCriteria object, which sets criteria for selecting retargetings. | Yes |
Options | The RetargetingRequestOptions object, which sets response parameters. | Yes |
RetargetingSelectionCriteria object | ||
RetargetingConditionIDS | Array of IDs of retargeting conditions to perform the operation for. Maximum of 1000 items in the array. | One of the parameters RetargetingConditionIDS, RetargetingIDS or AdIDS |
RetargetingIDS | Array of retargeting IDs to perform the operation for. Maximum of 1000 items in the array. | |
AdIDS | Array of ad IDs to perform the operation for. Maximum of 1000 items in the array. | |
RetargetingRequestOptions object | ||
Currency | The currency to use for bids in the response. Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. The value must match the campaign currency; otherwise, an error is returned with code 245. | Yes |
Notes | ||
If the SelectionCriteria structure has more than one criterion set, the operation will be performed for those retargetings that simultaneously match all the criteria. For example, if the parameters RetargetingConditionIDS and AdIDS are set, the operation will be made for retargetings that have a condition ID that is in the RetargetingConditionIDS array, and an ad ID that is in the AdIDS array. |
Output data
The output data structure in JSON is shown below.
{
"data": {
/* RetargetingResponse */
"Retargetings": [
{ /* Retargeting */
"RetargetingID": (int),
"AdID": (long),
"AdGroupID": (long),
"RetargetingConditionID": (int),
"ContextPrice": (float),
"Currency": (string),
"AutoBudgetPriority": (string),
"StatusPaused": (string)
}
...
]
}
}
Parameters are described below.
Parameter | Description |
RetargetingResponse object | |
---|---|
Retargetings | Array of Retargeting objects. |
Retargeting object | |
RetargetingID | ID of the retargeting. |
AdGroupID | ID of the ad group. |
AdID | The ad ID. |
RetargetingConditionID | ID of the retargeting condition. |
ContextPrice | Bid for the Yandex Advertising Network when using the MaximumCoverage and Default strategies (in the currency specified in the Currency parameter). |
Currency | The currency the bid is shown in. Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
AutoBudgetPriority | Priority of the retargeting when using automatic strategies. Possible values:
|
StatusPaused | Retargeting is temporarily disabled (not used for displaying ads) — Yes/No. The predefined value is No. |
Parameter | Description |
RetargetingResponse object | |
---|---|
Retargetings | Array of Retargeting objects. |
Retargeting object | |
RetargetingID | ID of the retargeting. |
AdGroupID | ID of the ad group. |
AdID | The ad ID. |
RetargetingConditionID | ID of the retargeting condition. |
ContextPrice | Bid for the Yandex Advertising Network when using the MaximumCoverage and Default strategies (in the currency specified in the Currency parameter). |
Currency | The currency the bid is shown in. Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
AutoBudgetPriority | Priority of the retargeting when using automatic strategies. Possible values:
|
StatusPaused | Retargeting is temporarily disabled (not used for displaying ads) — Yes/No. The predefined value is No. |
Examples of input data
Python
{
'Action': 'Get',
'SelectionCriteria': {
'AdIDS': [2571703, 2571705, 2571707]
}
}
PHP
array(
'Action' => 'Get',
'SelectionCriteria' => array(
'AdIDS' => array(2571703, 2571705, 2571707)
)
)
Perl
{
'Action' => 'Get',
'SelectionCriteria' => {
'AdIDS' => [2571703, 2571705, 2571707]
}
}