Introduction
A brand is a name used to identify a product or service as separate from similar competitor products. Brands belong to advertisers who usually have multiple brands. For example, as an advertiser, Coca-Cola has brands such as Coke, Diet Coke, and Sprite.
The FreeWheel system mimics the advertiser-brand structure by allowing the creation of brands under an advertiser. Brands can be used as a stand-alone entity in conjunction with advertisers, meaning that a brand has its own attributes, relationships with other entities (e.g. Insertion Order, Upfront Plan and reporting capability.)
You can use this API to accomplish the following tasks for a specified advertiser:
- List brands
- Show brands
- Create brands
- Update brands
- Delete brands
Related Documentation
Refer to the following documentation for more information about FreeWheel products and APIs:
Resources
URI(s)
The Campaign API v3 identifies two Uniform Resource Identifiers (URIs), a List and an Instance as identified in the following table:
| Type of URI | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v3/advertisers/[FW_ID]/brands/[FW_ID].xml?[parameter1]=[query1]&... |
| Staging | https://api.stg.freewheel.tv/services/v3/advertisers/[FW_ID]/brands/[FW_ID].xml?[parameter1]=[query1]&... |
Brand API Attributes
Attributes represent and describe data associated with an object, in this case, the Brand object. Attributes are organized in sets. The attribute set determines the fields available during data entry, and the values that appear to the client.
Use Brand API Attributes in conjunction with Brand API methods to accomplish your ad tech objectives.
Basic Attributes
Basic attributes describe fundamental properties of a brand.
The following parameters are included in basic GET requests.
| Parameter | Description | Data Type(s) | Creatable? | Updateable? | Comments |
|---|---|---|---|---|---|
| id | Resource ID | FW_ID | No | No | Assigned automatically during POST |
| name | Brand name | String | Required | Yes | Name must be unique in the network. |
| status | Brand status |
| Yes | Yes | These values must be provided in ALL CAPITAL letters. |
| external_id | External ID | String | Yes | Yes | |
| metadata | Brand metadata (MRM) | String | Yes | Yes | |
| industry | Industry/Industry Group(s) of the brand | String | Yes | Yes | |
| created_at | Time created | Datetime ("yyyy-MM-dd'T'HH:mm:ssZ") | No | No | |
| updated_at | Last updated time | Datetime ("yyyy-MM-dd'T'HH:mm:ssZ") | No | No |
Industry Attributes
| Function/Node | Description | Data Type(s) | Creatable? | Updateable? |
|---|---|---|---|---|
| industry | The ID of the industry/industry group | Set<FW_ID> | Yes | Yes |
For Industry ID Mappings, see MRM to IAB mappings.xls attached to the Advertiser Industry Assignment page.