You can use the brand resource to retrieve a set of brands, retrieve a specific brand, and create a brand.
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 Brands.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
advertiserId |
Retrieves all brands under the specific advertiser. |
Long |
Optional |
|
|
from |
Starting index by which to fetch new brands for paging purposes. |
Long |
Required |
Getting multiple entities requires using from and max query parameters. |
|
max |
Maximum number of brands to fetch for each page. |
Long |
Required |
|
|
accountId |
ID of account. |
Long |
Optional |
|
|
sort |
Sort by field name (see here). |
String |
Optional |
|
|
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. |
|
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. |
|
advertiserId |
ID of advertiser. |
Long |
Optional |
Retrieves a specific brand.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
id |
ID of the requested brand |
Integer |
Required |
Adds a new brand.
|
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
Body |
Request containing brand body to create. |
JSON |
Required |
For information about Brand status codes and errors, see Advertiser Resource.
Comments