You can use the advertiser resource to retrieve an advertiser or a set of advertisers, create a new advertiser, update an existing advertiser, or delete an advertiser.
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 advertisers. 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. |
|
accountId |
ID of account from which to fetch all advertisers. |
Long |
Optional |
|
|
sort |
Sort by field name (see here). |
String |
Optional |
|
|
permissionNames |
Name of the permission to filter. |
String |
Optional |
|
|
enrichLocalAdvertiserWithAccess |
Enrich with local advertisers access. |
String |
Optional |
|
|
globalStatus |
Filter advertisers according to global status. |
String |
Optional |
Retrieves a specific advertiser.
Create a new advertiser.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
Body |
Request containing advertiser body to create. |
JSON |
Required |
Updates an existing advertiser.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
ID |
ID of advertiser |
Long |
Required |
|
|
Body |
Request containing advertiser body to update. |
JSON |
Required |
The following table lists the possible HTTP status codes in responses.
|
Code |
String |
Description |
|---|---|---|
|
200 OK |
Success |
Successful API execution |
|
500 |
Internal Error |
The following shows an example of an internal server error in a response body.
The following table lists the possible internal server errors for the advertiser resource.
|
internal code |
string |
Description |
|---|---|---|
|
60203 |
Field 'impressionValidUpTo' is required/not allowed for this model. |
|
|
60204 |
Fields 'resetOn' and 'customEventsNumber' is required/not allowed for this model. |
|
|
60205 |
Field 'resetOn' should be at the max 1 year/minimum 1 day from today based on the advertiser timezone. |
|
|
60206 |
Additional Conversion Attribution Settings is not allowed without default. |
Additional conversion attribution settings are not allowed without a default set of attribution settings. |
|
60207 |
Additional Conversion Attribution Settings allowed only {amount}. |
Only {amount} additional conversion attribution settings are allowed. |
|
60208 |
Additional Conversion Attribution Settings duplicate values are not allowed. |
Duplicate values for conversion attribution settings are not allowed. |
Comments