Overview
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
Uniform Resource Identifiers (URI)
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v3/advertisers/{advertiser_id}/brands |
| Staging | https://api.stg.freewheel.tv/services/v3/advertisers/{advertiser_id}/brands |
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. For an interactive example, see Create a Brand.
| Name | Type | Description | Mandatory? | Updatable? |
|---|---|---|---|---|
| name | string | Brand name. Name must be unique in the network | Required | Yes |
| status | string | Brand status. These values must be provided in ALL CAPITAL letters. Valid values include: - ACTIVE - INACTIVE | Yes | Yes |
| metadata | string | Brand metadata (MRM) | Yes | Yes |
| external_id | string | External ID | Yes | Yes |
| industry | array | Industry/Industry Group(s) of the brand | Yes | Yes |
Industry Array
| Name | Type | Description | Mandatory? | Updatable? |
|---|---|---|---|---|
| industry_id | int64 | The ID of the industry/industry group | Yes | Yes |