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. View values
|
||||||||||||||||||||||||||||||
advertiserId |
ID of advertiser. |
Long |
Optional |
GET https://adapi.sizmek.com/sas/brands?from=0&max=250
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the brands' details filtered by data ownership.
{ "result": [ { "type": "Brand", "id": 1073751100, "relationsBag": { "parents": { "account": { "id": 1073746500, "name": "Testing Account", "internal": true }, "advertiser": { "id": 1073747300, "name": "Advertiser110" }, "brand": null, "campaign": null, "site": null }, "children": { "advertisers": { "count": 0 }, "brands": { "count": 0 }, "campaigns": { "count": 4 }, "users": { "count": 0 } }, "creativeAccountContact": false }, "version": 1545746566196166700, "createdBy": 1073741800, "createdByName": "User", "createdByAccount": 1073741800, "createdByAccountName": "Account", "createdOn": 1499779870595, "lastUpdatedBy": 1073741800, "lastUpdatedByName": "User", "lastUpdatedByAccount": 1073741800, "lastUpdatedByAccountName": "Account", "lastUpdateOn": 1499779870595, "name": "Advertiser110", "advertiserId": 1073747300, "vertical": "Apparel", "status": "Enabled", "adminSettings": { "type": "AdminSettings", "regionalSettings": { "type": "RegionalSettings", "defaultTimeZone": "GMT_Plus_12", "market": null, "geoVendor": "DigitalElement" }, "defaultContacts": { "type": "DefaultContacts", "relationsBag": null, "sizmekContacts": [ { "type": "DefaultSizmekContact", "id": 16739089973200, "clientRefId": "ad21d99f-bffd-9329-7118-463e2768e911", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "ClientServicesManager" }, { "type": "DefaultSizmekContact", "id": 16739089973200, "clientRefId": "5cc95754-46b3-87df-e286-f7e97a3c14bc", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "SalesManager" } ], "campaignManagerContacts": [], "creativeManagerContacts": [], "creativeAccounts": [], "siteContacts": [] }, "thirdPartyTracking": "CustomParameters", "servingSettings": { "type": "ServingSettings", "collectBelowTheFold": true, "dfCollectionID": -1218887573, "pathLength": 0, "visibilityMinimumSurface": 2114154122, "visibilityMinimumDuration": -1574293070, "agencyVisibilityMinimumDuration": -1869715209, "agencyVisibilityMinimumSurface": 631413290, "adChoicesCertificationProgramID": 368396905, "adChoicesClickthroughURL": "zy59PinJvq", "disableCookie": true, "saveAdCookie": true, "retargetingCookieWindow": -435353679, "deviceIntelligenceTypeId": 1679125328 }, "campaignSettings": { "type": "CampaignSettings", "hardStopMethod": "KEEP_SERVING_AS_USUAL", "creativeManagerAccess": true, "traffickingMode": "AdvancedMode", "targetAudiencePriorityPolicy": "Server" }, "privacy": { "type": "Privacy", "adMarker": { "includeInAllAds": false, "regulationProgram": "IAB_EU", "markerClickthroughURL": null }, "disableCookies": false }, "video": { "type": "Video", "autoTranscode": true } }, "customFields": null, "accessLevel": "Full" }, { "type": "Brand", "id": 1083771200, "relationsBag": { "parents": { "account": { "id": 1073746500, "name": "Testing Account", "internal": true }, "advertiser": { "id": 1073747300, "name": "Advertiser110" }, "brand": null, "campaign": null, "site": null }, "children": { "advertisers": { "count": 0 }, "brands": { "count": 0 }, "campaigns": { "count": 0 }, "users": { "count": 0 } }, "creativeAccountContact": false }, "version": 1550563426984788000, "createdBy": 1073741800, "createdByName": "User", "createdByAccount": 1073741800, "createdByAccountName": "Account", "createdOn": 1550563426984, "lastUpdatedBy": 1073741800, "lastUpdatedByName": "User", "lastUpdatedByAccount": 1073741800, "lastUpdatedByAccountName": "Account", "lastUpdateOn": 1550563426984, "name": "L-Test", "advertiserId": 1073747300, "vertical": "Apparel", "status": "Enabled", "adminSettings": { "type": "AdminSettings", "regionalSettings": { "type": "RegionalSettings", "defaultTimeZone": "GMT_Plus_12", "market": null, "geoVendor": "DigitalElement" }, "defaultContacts": { "type": "DefaultContacts", "relationsBag": null, "sizmekContacts": [ { "type": "DefaultSizmekContact", "id": 16739089973200, "clientRefId": "ad21d99f-bffd-9329-7118-463e2768e911", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "ClientServicesManager" }, { "type": "DefaultSizmekContact", "id": 16739089973200, "clientRefId": "5cc95754-46b3-87df-e286-f7e97a3c14bc", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "SalesManager" } ], "campaignManagerContacts": [], "creativeManagerContacts": [], "creativeAccounts": [], "siteContacts": [] }, "thirdPartyTracking": "CustomParameters", "servingSettings": { "type": "ServingSettings", "collectBelowTheFold": true, "dfCollectionID": -1218887573, "pathLength": 0, "visibilityMinimumSurface": 2114154122, "visibilityMinimumDuration": -1574293070, "agencyVisibilityMinimumDuration": -1869715209, "agencyVisibilityMinimumSurface": 631413290, "adChoicesCertificationProgramID": 368396905, "adChoicesClickthroughURL": "zy59PinJvq", "disableCookie": true, "saveAdCookie": true, "retargetingCookieWindow": -435353679, "deviceIntelligenceTypeId": 1679125328 }, "campaignSettings": { "type": "CampaignSettings", "hardStopMethod": "KEEP_SERVING_AS_USUAL", "creativeManagerAccess": true, "traffickingMode": "AdvancedMode", "targetAudiencePriorityPolicy": "Server" }, "privacy": { "type": "Privacy", "adMarker": { "includeInAllAds": false, "regulationProgram": "IAB_EU", "markerClickthroughURL": null }, "disableCookies": false }, "video": { "type": "Video", "autoTranscode": true } }, "customFields": null, "accessLevel": "Full" } ] }
Retrieves a specific brand.
Name |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
id |
ID of the requested brand |
Integer |
Required |
A successful request returns the HTTP 200 OK status code and a JSON response body that shows the brand details filtered by data ownership. If there is no brand or data ownership, the request returns an empty response.
{ "result": { "type": "Brand", "id": 1083756700, "relationsBag": { "parents": { "account": { "id": 312, "name": "Analytics Training", "internal": false }, "advertiser": { "id": 37721, "name": "#[2_LL_advp911" }, "brand": null, "campaign": null, "site": null }, "children": { "advertisers": { "count": 0 }, "brands": { "count": 0 }, "campaigns": { "count": 0 }, "users": { "count": 0 } }, "creativeAccountContact": false }, "version": 1536845374212866000, "createdBy": 1073741800, "createdByName": "User", "createdByAccount": 1073741800, "createdByAccountName": "Account", "createdOn": 1536844470767, "lastUpdatedBy": 1073741800, "lastUpdatedByName": "User", "lastUpdatedByAccount": 1073741800, "lastUpdatedByAccountName": "Account", "lastUpdateOn": 1536845374209, "name": "Brand-1", "advertiserId": 37721, "vertical": "Gaming", "status": "Enabled", "adminSettings": { "type": "AdminSettings", "regionalSettings": { "type": "RegionalSettings", "defaultTimeZone": "GMT_Plus_02", "market": null }, "defaultContacts": { "type": "DefaultContacts", "relationsBag": null, "sizmekContacts": [ { "type": "DefaultSizmekContact", "id": 41016402804700, "clientRefId": "4f23194a-87e2-5fed-0c57-f25e6e8c7c24", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "ClientServicesManager" }, { "type": "DefaultSizmekContact", "id": 41016402804700, "clientRefId": "783e6026-793b-4469-3259-fc3394475b4f", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "SalesManager" } ], "campaignManagerContacts": [], "creativeManagerContacts": [], "creativeAccounts": [], "siteContacts": [] }, "thirdPartyTracking": null, "servingSettings": { "type": "ServingSettings", "collectBelowTheFold": false, "dfCollectionID": null, "pathLength": null, "visibilityMinimumSurface": 0, "visibilityMinimumDuration": 0, "agencyVisibilityMinimumDuration": 0, "agencyVisibilityMinimumSurface": 0, "adChoicesCertificationProgramID": 0, "adChoicesClickthroughURL": "", "disableCookie": false, "saveAdCookie": true, "retargetingCookieWindow": 0, "deviceIntelligenceTypeId": 0 }, "campaignSettings": { "type": "CampaignSettings", "hardStopMethod": "KEEP_SERVING_AS_USUAL", "creativeManagerAccess": true, "traffickingMode": "AdvancedMode", "targetAudiencePriorityPolicy": "Server" }, "privacy": { "type": "Privacy", "adMarker": { "includeInAllAds": false, "regulationProgram": "IAB_EU", "markerClickthroughURL": null }, "disableCookies": false }, "video": { "type": "Video", "autoTranscode": true } }, "customFields": null, "accessLevel": "Full" } }{ "result": { "type": "Brand", "id": 1083756700, "relationsBag": { "parents": { "account": { "id": 312, "name": "Analytics Training", "internal": false }, "advertiser": { "id": 37721, "name": "#[2_LL_advp911" }, "brand": null, "campaign": null, "site": null }, "children": { "advertisers": { "count": 0 }, "brands": { "count": 0 }, "campaigns": { "count": 0 }, "users": { "count": 0 } }, "creativeAccountContact": false }, "version": 1536845374212866048, "createdBy": 1073741800, "createdByName": "User", "createdByAccount": 1073741800, "createdByAccountName": "Account", "createdOn": 1536844470767, "lastUpdatedBy": 1073741800, "lastUpdatedByName": "User", "lastUpdatedByAccount": 1073741800, "lastUpdatedByAccountName": "Account", "lastUpdateOn": 1536845374209, "name": "Brand-1", "advertiserId": 37721, "vertical": "Gaming", "status": "Enabled", "adminSettings": { "type": "AdminSettings", "regionalSettings": { "type": "RegionalSettings", "defaultTimeZone": "GMT_Plus_02", "market": null }, "defaultContacts": { "type": "DefaultContacts", "relationsBag": null, "sizmekContacts": [{ "type": "DefaultSizmekContact", "id": 41016402804742, "clientRefId": "4f23194a-87e2-5fed-0c57-f25e6e8c7c24", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "ClientServicesManager" }, { "type": "DefaultSizmekContact", "id": 41016402804743, "clientRefId": "783e6026-793b-4469-3259-fc3394475b4f", "relationsBag": null, "contactId": 1073741800, "name": "FirstSizmekUser", "campaignRole": "SalesManager" }], "campaignManagerContacts": [], "creativeManagerContacts": [], "creativeAccounts": [], "siteContacts": [] }, "thirdPartyTracking": null, "servingSettings": { "type": "ServingSettings", "collectBelowTheFold": false, "dfCollectionID": null, "pathLength": null, "visibilityMinimumSurface": 0, "visibilityMinimumDuration": 0, "agencyVisibilityMinimumDuration": 0, "agencyVisibilityMinimumSurface": 0, "adChoicesCertificationProgramID": 0, "adChoicesClickthroughURL": "", "disableCookie": false, "saveAdCookie": true, "retargetingCookieWindow": 0, "deviceIntelligenceTypeId": 0 }, "campaignSettings": { "type": "CampaignSettings", "hardStopMethod": "KEEP_SERVING_AS_USUAL", "creativeManagerAccess": true, "traffickingMode": "AdvancedMode", "targetAudiencePriorityPolicy": "Server" }, "privacy": { "type": "Privacy", "adMarker": { "includeInAllAds": false, "regulationProgram": "IAB_EU", "markerClickthroughURL": null }, "disableCookies": false }, "video": { "type": "Video", "autoTranscode": true } }, "customFields": null, "accessLevel": "Full" } }
Adds a new brand.
Name |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
Body |
Request containing brand body to create. |
JSON |
Required |
POST https://adapi.sizmek.com/sas/brands
{ "entities": [ { "type": "Brand", "name": "TestBrand", "vertical": "Apparel", "status": "Enabled", "advertiserId": 1073747300, "clientRefId": null, "relationsBag": { "creativeAccountContact": false, "parents": { "account": { "id": 1073746500, "name": null }, "advertiser": { "id": "1073747300", "name": "!!!eidanAdvertiser11072017" } }, "children": { "campaigns": { "count": 0 } } }, "adminSettings": { "type": "AdminSettings", "regionalSettings": { "type": "RegionalSettings", "defaultTimeZone": "GMT_Plus_12", "market": null, "geoVendor": "DigitalElement", "reqParams": null, "fromServer": true, "parentResource": null, "restangularCollection": false }, "defaultContacts": { "type": "DefaultContacts", "relationsBag": null, "sizmekContacts": [ { "type": "DefaultSizmekContact", "id": 16739089973200, "clientRefId": "ad21d99f-bffd-9329-7118-463e2768e911", "relationsBag": null, "contactId": 1073741800, "campaignRole": "ClientServicesManager" }, { "type": "DefaultSizmekContact", "id": 16739089973200, "clientRefId": "5cc95754-46b3-87df-e286-f7e97a3c14bc", "relationsBag": null, "contactId": 1073741800, "campaignRole": "SalesManager" } ], "campaignManagerContacts": [], "creativeManagerContacts": [], "creativeAccounts": [], "siteContacts": [], "reqParams": null, "fromServer": true, "parentResource": null, "restangularCollection": false }, "thirdPartyTracking": "CustomParameters", "servingSettings": { "type": "ServingSettings", "collectBelowTheFold": true, "dfCollectionID": -1218887573, "pathLength": 0, "visibilityMinimumSurface": 2114154122, "visibilityMinimumDuration": -1574293070, "agencyVisibilityMinimumDuration": -1869715209, "agencyVisibilityMinimumSurface": 631413290, "adChoicesCertificationProgramID": 368396905, "adChoicesClickthroughURL": "zy59PinJvq", "disableCookie": true, "saveAdCookie": true, "retargetingCookieWindow": -435353679, "deviceIntelligenceTypeId": 1679125328, "reqParams": null, "fromServer": true, "parentResource": null, "restangularCollection": false }, "campaignSettings": { "type": "CampaignSettings", "hardStopMethod": "KEEP_SERVING_AS_USUAL", "creativeManagerAccess": true, "traffickingMode": "AdvancedMode", "targetAudiencePriorityPolicy": "Server", "reqParams": null, "fromServer": true, "parentResource": null, "restangularCollection": false }, "privacy": { "type": "Privacy", "adMarker": { "includeInAllAds": false, "regulationProgram": "IAB_EU", "markerClickthroughURL": null }, "disableCookies": false, "reqParams": null, "fromServer": true, "parentResource": null, "restangularCollection": false } }, "customFields": { "type": "CustomFields" } } ] }
For information about Brand status codes and errors, see Advertiser Resource.
Comments