Standard Attributes API V4

The Standard Attributes API V4 enables FreeWheel (FW) Marketplace users to retrieve Standard Attribute values pre-defined in the FreeWheel Marketplace. Those values and their corresponding IDs are essential for further Marketplace Inventory trafficking through Placement API V3.

With the Standard Attributes API V4, you can:

  • List names and IDs of all Standard Attributes
  • List names and IDs of one or more selected Standard Attributes

You can retrieve values for the following Standard Attribute types:

  • Programmer
  • Brand
  • Channel
  • TV Rating
  • Genre
  • Language
  • Content Duration
  • Content Daypart
  • Stream Type
  • Device Type
  • Operating System (OS)
  • Environment
  • Endpoint Name
  • Endpoint Owner
  • Subscription Model
  • Content Territory
  • Series
  • Content Credential Status

📘

Info

The Standard Attributes API V4 is only valid for API users with the FW_MARKETPLACE_BUYER_PROFILE and FW_MARKETPLACE_SELLER_PROFILE network functions enabled.

Resources

URI(s)

Standard Attributes API V4 identifies two Uniform Resource Identifiers (URIs):

EnvironmentURI
Productionhttps://api.freewheel.tv/services/v4/standard_attributes
Staginghttps://api.stg.freewheel.tv/services/v4/standard_attributes

Attributes

The following attributes are used in GET requests only.

NameTypeDescription
programmersSetList of FreeWheel Marketplace programmer IDs and names
brandsSetList of FreeWheel-Marketplace-defined brand IDs, names, and parent programmer IDs
channelsSetList of FreeWheel-Marketplace-defined Channel IDs, names and parent Brand IDs
tv_ratingsSetList of FreeWheel Marketplace defined TV rating IDs and names
genresSetList of FreeWheel Marketplace defined genre IDs, names, and parent genre IDs

If a genre type doesn't have a parent, the parent_genre_id node is empty or null.
languagesSetList of FreeWheel Marketplace defined language IDs and names
content_durationsSetList of FreeWheel Marketplace defined content duration IDs and names
content_daypartsSetList of FreeWheel Marketplace defined Content Daypart IDs and names.
stream_typesSetList of FreeWheel Marketplace defined Stream Type IDs and names.
device_typesSetList of FreeWheel Marketplace defined device type IDs, names, parent devices, and type IDs

If a device type doesn't have a parent, the parent_device_type_id node is empty or null.
osSetList of FreeWheel Marketplace defined operating system IDs and names
environmentsSetList of FreeWheel Marketplace defined environment IDs and names
endpoint_nameSetList of FreeWheel Marketplace defined Endpoint Name IDs, names and parent Endpoint Owner IDs
endpoint_ownerSetList of FreeWheel Marketplace defined Endpoint Owner IDs and names
subscription_modelSetList of FreeWheel Marketplace defined Subscription Model IDs and names
content_territorySetList of FreeWheel Marketplace defined Content Territory IDs and names
seriesSetList of FreeWheel Marketplace defined Series IDs and names.
content_credential_statusSetList of FreeWheel Marketplace defined content credential status.

📘

Note

If a genre or device type doesn't have a parent, nodes parent_genre_id, parent_device_type_id are empty or null.

Child Attributes

The following attributes are used in GET requests only.

Programmers

NameTypeDescription
idFW_IDThe ID of a particular programmer
nameStringThe name of a particular programmer

Brands

NameTypeDescription
idFW_IDThe ID of a particular brand
nameStringThe name of a particular brand
parent_programmer_idFW_IDThe ID of the parent programmer of the brand

Channels

NameTypeDescription
idFW_IDThe ID of a particular channel
nameStringThe name of a particular channel
parent_brand_idFW_IDThe ID of the parent brand of the channel

TV Ratings

NameTypeDescription
idFW_IDThe ID of a particular TV rating
nameStringThe name of a particular TV rating

Genres

NameTypeDescription
idFW_IDThe ID of a particular genre
nameStringThe name of a particular genre
parent_genre_idFW_IDThe ID of the parent genre

Languages

NameTypeDescription
idFW_IDThe ID of a particular language
nameStringThe name of a particular language

Content Durations

NameTypeDescription
idFW_IDThe ID of a particular content duration
nameStringThe name of a particular content duration

Content Dayparts

NameTypeDescription
idFW_IDThe ID of a certain content daypart
nameStringThe Name of a certain content daypart

Stream Types

NameTypeDescription
idFW_IDThe ID of a certain stream type
nameStringThe Name of a certain stream type

Device Types

NameTypeDescription
idFW_IDThe ID of a particular device type
nameStringThe name of a particular device type
parent_device_type_idFW_IDThe ID of the parent device type

Operating Systems

NameTypeDescription
idFW_IDThe ID of a particular operating system
nameStringThe name of a particular operating system

Environments

NameTypeDescription
idFW_IDThe ID of a particular environment
nameStringThe name of a particular environment

Endpoint Owner

NameTypeDescriptionGet Only?
idFW_IDThe ID of a certain endpoint ownerYes
nameStringThe name of a certain endpoint ownerYes

Endpoint Name

NameTypeDescriptionGet only?
idFW_IDThe ID of a certain endpoint nameYes
nameStringThe text string providing a certain endpoint nameYes
parent_endpoint_owner_idFW_IDThe ID of the parent endpoint owner of the endpoint nameYes

Subscription Model

NameTypeDescriptionGet Only?
idFW_IDThe ID of a certain subscription modelYes
nameStringThe name of a certain subscription modelYes

Content Territory

NameTypeDescriptionGet Only?
idFW_IDThe ID of a certain content territoryYes
country_nameStringThe name of a certain content territoryYes

Series

NameTypeDescriptionGet only?
idFW_IDThe ID of a particular seriesYes
nameStringThe name of a particular seriesYes

Content Credential Status

NameTypeDescriptionGet only?
idFW_IDThe ID of a particular content credential statusYes
nameStringThe name of a particular content credential statusYes