The following objects are used by this endpoint:
HTTP METHOD |
URI |
DESCRIPTION |
---|---|---|
/tagManagers/retargeting |
Retrieves all retargeting activities. |
|
/tagManagers/retargeting/{id} |
Retrieves a specific retargeting activity. |
|
/tagManagers/retargeting |
Creates a new retargeting activity. |
|
/tagManagers/retargeting/{id} |
Updates a retargeting activity. |
|
/tagManagers/retargeting/{id} |
Deletes a retargeting activity. |
|
/tagManagers/retargeting/delete |
Deletes all retargeting activities. |
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 retargeting activities. Can be filtered according to query parameters.
Name |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
from |
Starting index by which to fetch new retargeting activities for paging purposes. |
Long |
Required |
Getting multiple entities requires using from and max query parameters. |
max |
Maximum number of retargeting activities to fetch for each page. |
Long |
Required |
|
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. |
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 |
|
advertiserID |
Advertiser ID from which to retrieve retargeting activities. |
Long |
Optional |
|
activityType |
Type of the activity. |
String |
Required |
Retargeting |
enrichWithEntitiesCounts |
Determines whether to enrich the retargeting activity with related entities' counts. |
Boolean |
Optional |
Specify true if counts are required; otherwise, counts will be zero and performance is improved. |
Retrieves a retargeting activity.
Creates a new retargeting activity.
Updates an existing retargeting activity.
Deletes a single retargeting activity.
Note
Note: You can only delete a retargeting activity if it is not used in a tag manager.
NAME |
DESCRIPTION |
TYPE |
REQUIRED |
NOTES |
---|---|---|---|---|
id |
ID of retargeting activity to delete. |
Long |
Required |
Deletes all retargeting activities.
Note
Note: You can only delete all retargeting activities if they are not used in a tag manager.
Comments