HTTP METHOD |
URI |
DESCRIPTION |
---|---|---|
tagManagers/activityRule/ |
Retrieves multiple activity rules. |
|
tagManagers/activityRule/{RuleID} |
Retrieves a single activity rule. |
|
tagManagers/activityRule |
Creates a single activity rule. |
|
tagManagers/activityRule/saveActivityRules/{TagManagerID} |
Creates and saves multiple activity rules. |
|
tagManagers/activityRule/{RuleID} |
Updates a single activity rule. |
|
tagManagers/activityRule/{TagManagerID} |
Updates multiple activity rules. |
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 activity rules. Can be filtered according to query parameters.
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
from |
Starting index by which to fetch new advertisers (for paging purposes). |
Long |
Required |
Getting multiple entities requires using from and max query parameters. |
max |
Maximum number of advertisers to fetch (for each page). |
Long |
Required |
|
q |
Filtering options for the request (see here). |
String |
Optional |
Example of query string: q={"1":{"RECENT":["1519203216427-1526889216427"]},"2":{"NAME":["smith"]}} NoteNote: The date is according to the Unix epoch timestamp. |
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 |
GET https://adapi.sizmek.com/sas/tagManagers/activityRule?from=0&max=250&order=asc&sort=name&tagManagerId=1083759370
Retrieves a specific activity rule.
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
ID |
ID of activity rule to fetch. |
Long |
Required |
Creates a new activity rule.
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
Body |
Request containing activity rule body to create. |
JSON |
Required |
Creates and saves multiple activity rules.
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
Body |
Request containing multiple activity rules to create. |
JSON |
Required |
POST https://adapi.sizmek.com/sas/tagManagers/activityRule/saveActivityRules/{TagManagerID}
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
ID |
ID of the activity rule. |
Long |
Required |
|
Body |
Request containing activity rule body to update. |
JSON |
Required |
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
ID |
ID of the activity rule. |
Long |
Required |
|
Body |
Request containing activity rule body to update. |
JSON |
Required |
PUT https://adapi.sizmek.com/sas/tagManagers/activityRule/updateActivityRules/{TagManagerID}
Comments