You can use the target audience endpoint to retrieve a specific target audience, create a new target audience, update an existing target audience, or delete an audience.
|
HTTP METHOD |
URI |
DESCRIPTION |
|---|---|---|
|
/strategies/targetAudiences/ |
Retrieves multiple target audiences. |
|
|
/strategies/targetAudiences/{ID} |
Retrieves a specific target audience. |
|
|
/strategies/targetAudiences/ |
Creates a new target audience. |
|
|
/strategies/targetAudiences/{ID} |
Updates an existing target audience. |
|
|
/strategies/targetAudiences/delete |
Deletes an existing target audience. |
Important
Important:
-
For PUT calls, do the following:
-
For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.
-
You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:
{ "result": { "type": "Advertiser", ... } }You should make the following modifications, including your specific modifications, to the json object that you submit for the request.
{ "entities": [{ "type": "Advertiser", ... }] }
-
-
For POST calls, do the following:
-
Include the fields marked as Required, as indicated in the corresponding Object article.
-
Format the JSON object as follows:
{ "entities": [{ "type": "Advertiser", ... }] }
-
Retrieves multiple target audiences.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
from |
Starting index by which to fetch new audiences for paging purposes. |
Long |
Required |
Getting multiple entities requires using from and max query parameters. |
|
max |
Maximum number of audiences to fetch for each page. |
Long |
Required |
|
|
order |
Sort order ASC or DESC, required if sort field name is specified (see here). |
String |
Optional NoteNote: Required if a sort field name is specified. |
By default, the API response is ascending. |
|
sort |
Sort by field name (see here). |
String |
Optional |
|
|
q |
Filtering options for the request (see here). |
String |
Optional |
Example of query string: q={"1":{"CREATEDBYNAME":["MonicaSmith"]},"2":{"ADVERTISERNAME":["autoads"]}} NoteNote: The date is according to the Unix epoch timestamp. |
|
ID |
ID of audiences to retrieve. |
Long |
Required |
GET https://adapi.sizmek.com/sas/strategies/targetAudiencesV2?from=0&max=250&order=desc&sort=id
Retrieve a specific target audience.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
ID |
ID of audience to retrieve. |
Long |
Required |
Creates a new target audience.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
Body |
Request containing target audience body. |
JSON |
Required |
Updates an existing target audience.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
ID |
ID of audience to retrieve. |
Long |
Required |
|
|
Body |
Request containing target audience to update. |
JSON |
Required |
Delete an existing target audience.
|
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
|---|---|---|---|---|
|
ID |
ID of audience to retrieve. |
Long |
Required |
Comments