You can use the brand resource to retrieve a set of brands, retrieve a specific brand, and create a brand.
Depending on the API user that was created for you, use one of the following URLs:
https://api.sizmek.com/rest/brandshttps://adapi.sizmek.com/sas/brands
Note
Note: Confirm with your customer success manager regarding the correct URL to use.
Important
Important:
-
For PUT calls, do the following:
We recommend that for any PUT method that updates an object, 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.
-
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 |
Depending on the API user that was created for you, use one of the following URLs:
GET https://api.sizmek.com/rest/brands?from=0&max=250GET https://adapi.sizmek.com/sas/brands?from=0&max=250
Retrieves a specific brand.
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
id |
ID of the requested brand |
Integer |
Required |
Depending on the API user that was created for you, use one of the following URLs:
GET https://api.sizmek.com/rest/brands/1073869571GET https://adapi.sizmek.com/sas/brands/1073869571
Adds a new brand.
Name |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
Body |
Request containing brand body to create. |
JSON |
Required |
Depending on the API user that was created for you, use one of the following URLs:
POST https://api.sizmek.com/rest/brandsPOST https://adapi.sizmek.com/sas/brands
For information about Brand status codes and errors, see Advertiser Resource.
Comments