retargeting.group.lists.get
Get retargeting lists in groups by list IDs with attributes.
Retargeting lists are ordered by ID
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
lists ( |
|
| struct |
{ |
|
| int |
listId |
Id of retargeting list
|
|
} |
|
|
|
) |
|
|
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 |
lists ( |
list of Retargeting list
|
| struct |
{ |
|
| int |
listId |
Id of retargeting list
|
| string |
name |
Name of retargeting list
|
| string |
status |
Status of retargeting list in group:
-
active:
active list
-
suspend:
suspended list
|
| bool |
deleted |
Whether list was deleted
|
| bool |
deletedGlobally |
Whether list was deleted (globally)
|
| int |
cpc |
List maximal cost per click (in halers)
|
| int |
cpt |
List maximal cost per thousand impressions (in halers)
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK
206: Partially OK
301: User is serviced
400: Bad arguments
401: Invalid session
403: Access Denied
404: Not found
406: Bad values of attributes
413: Too many items requested.
429: Too many requests. Has to wait.
500: Server Error.
409: Conflict
Diagnostics:
List of all possible diagnostics:
group_access_denied
retargeting_list_in_group_not_found
retargeting_list_not_exist
retargeting_list_not_found
user_access_denied