retargeting.combinations.get
Get retargeting combinations by list of IDs.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
combinationIds ( |
|
|
int
|
|
|
(optional) Id of retargeting combination
|
|
) |
|
|
Response
| struct |
{ |
|
| int |
status |
Status code (see below)
|
| string |
statusMessage |
Status code description
|
| struct |
diagnostics { |
(optional) Additional information about processed request (see below)
|
} |
|
|
| string |
session |
(optional) Refreshed session
|
| array |
combinations ( |
Array of combinations
|
| struct |
{ |
|
| int |
combinationId |
Id of retargeting combination
|
| struct |
attributes { |
Attributes of combination
|
| string |
name |
Name of retargeting combination.
|
| string |
description |
Description of retargeting combination.
|
| string |
status |
Status of retargeting combination:
-
active:
active
-
paused:
paused
|
| int |
users |
Number of users in combination
|
| datetime |
createDate |
Date of creating retargeting combination
|
| datetime |
suspendDate |
Date of suspend retargeting combination
|
| datetime |
deleteDate |
Date of deleting retargeting combination
|
| bool |
deleted |
Whether combination was deleted
|
|
} |
|
|
| array |
listGroups ( |
Array of groups of retargeting list IDs
|
| struct |
{ |
|
| int |
listGroupId |
Id of group of lists
|
| array |
listIds ( |
Array of retargeting list IDs
|
|
int
|
|
|
Id of retargeting list
|
|
) |
|
|
| string |
operator |
Type of operator:
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
retargeting_combination_not_existretargeting_combination_not_founduser_access_denied
