update
Changes the parameters of retargeting lists.
Restrictions
Maximum of 1000 retargeting lists per method call.
- If you modify a retargeting list that contains at least one rule with the ALL or ANY operator, it still must contain at least one rule with the ALL or ANY operator after your changes.
- If you modify a retargeting list that consists exclusively of rules with the NONE operator, it must still contain only rules with the NONE operator after your changes.
- If a retargeting list with the AUDIENCE type contains only short-term interests and is used to target an audience in a Text & Image Ad group, it must still contain only short-term interests after editing.
Request
Request structure in JSON format:
{
"method": "update",
"params": { /* params */
"RetargetingLists": [{ /* RetargetingListUpdateItem */
"Id": (long), /* required */
"Name": (string),
"Description": (string),
"Rules": [{ /* RetargetingListRuleItem */
"Arguments": [{ /* RetargetingListRuleArgumentItem */
"MembershipLifeSpan": (int),
"ExternalId": (long) /* required */
}, ... ], /* required */
"Operator": ( "ALL" | "ANY" | "NONE" ) /* required */
}, ... ]
}, ... ] /* required */
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / UpdateRequest structure (for SOAP) | |||
---|---|---|---|
RetargetingLists | array of RetargetingListUpdateItem | Retargeting lists to modify. | Yes |
RetargetingListUpdateItem structure | |||
Id | long | ID of the retargeting list. | Yes |
Name | string | Name of the retargeting list (maximum of 250 characters). | No |
Description | string | Text note for the retargeting list (maximum of 4096 characters). | No |
Rules | array of RetargetingListRuleItem | Rules 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. | No |
RetargetingListRuleItem structure | |||
Arguments | array of RetargetingListRuleArgumentItem | Goals and segments. See the section Goals and segments. | Yes |
Operator | RetargetingListRuleOperatorEnum | Logical operator for the retargeting list:
| Yes |
RetargetingListRuleArgumentItem structure | |||
MembershipLifeSpan | int | The number of days (from 1 to 540) for checking for a goal conversion. For Yandex Metrica and Yandex Audience segments, this parameter is not used and the passed value is ignored. | For Yandex Metrica goals |
ExternalId | long | ID of the goal or segment. For segments by user interests, use identifier prefixes to specify interest types:
For example, the segment ID | Yes |
Parameter | Type | Description | Required |
Params structure (for JSON) / UpdateRequest structure (for SOAP) | |||
---|---|---|---|
RetargetingLists | array of RetargetingListUpdateItem | Retargeting lists to modify. | Yes |
RetargetingListUpdateItem structure | |||
Id | long | ID of the retargeting list. | Yes |
Name | string | Name of the retargeting list (maximum of 250 characters). | No |
Description | string | Text note for the retargeting list (maximum of 4096 characters). | No |
Rules | array of RetargetingListRuleItem | Rules 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. | No |
RetargetingListRuleItem structure | |||
Arguments | array of RetargetingListRuleArgumentItem | Goals and segments. See the section Goals and segments. | Yes |
Operator | RetargetingListRuleOperatorEnum | Logical operator for the retargeting list:
| Yes |
RetargetingListRuleArgumentItem structure | |||
MembershipLifeSpan | int | The number of days (from 1 to 540) for checking for a goal conversion. For Yandex Metrica and Yandex Audience segments, this parameter is not used and the passed value is ignored. | For Yandex Metrica goals |
ExternalId | long | ID of the goal or segment. For segments by user interests, use identifier prefixes to specify interest types:
For example, the segment ID | Yes |
Response
Response structure in JSON format:
{
"result": { /* result */
"UpdateResults": [{ /* ActionResult */
"Id": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
]
}, ... ] /* required */
}
}
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Results of changing parameters for retargeting lists. |
ActionResult structure | ||
Id | long | ID of the retargeting list. Returned if there aren't any errors. See the section Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Results of changing parameters for retargeting lists. |
ActionResult structure | ||
Id | long | ID of the retargeting list. Returned if there aren't any errors. See the section Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |