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.
Standard Attributes API V4 identifies two Uniform Resource Identifiers (URIs):
Environment URI Production https://api.freewheel.tv/services/v4/standard_attributes
Staging https://api.stg.freewheel.tv/services/v4/standard_attributes
The following attributes are used in GET requests only.
Name Type Description programmers Set List of FreeWheel Marketplace programmer IDs and names brands Set List of FreeWheel-Marketplace-defined brand IDs, names, and parent programmer IDs channels Set List of FreeWheel-Marketplace-defined Channel IDs, names and parent Brand IDs tv_ratings Set List of FreeWheel Marketplace defined TV rating IDs and names genres Set List 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. languages Set List of FreeWheel Marketplace defined language IDs and names content_durations Set List of FreeWheel Marketplace defined content duration IDs and names content_dayparts Set List of FreeWheel Marketplace defined Content Daypart IDs and names. stream_types Set List of FreeWheel Marketplace defined Stream Type IDs and names. device_types Set List 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. os Set List of FreeWheel Marketplace defined operating system IDs and names environments Set List of FreeWheel Marketplace defined environment IDs and names endpoint_name Set List of FreeWheel Marketplace defined Endpoint Name IDs, names and parent Endpoint Owner IDs endpoint_owner Set List of FreeWheel Marketplace defined Endpoint Owner IDs and names subscription_model Set List of FreeWheel Marketplace defined Subscription Model IDs and names content_territory Set List of FreeWheel Marketplace defined Content Territory IDs and names series Set List of FreeWheel Marketplace defined Series IDs and names. content_credential_status Set List 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.
The following attributes are used in GET requests only.
Name Type Description id FW_ID The ID of a particular programmer name String The name of a particular programmer
Name Type Description id FW_ID The ID of a particular brand name String The name of a particular brand parent_programmer_id FW_ID The ID of the parent programmer of the brand
Name Type Description id FW_ID The ID of a particular channel name String The name of a particular channel parent_brand_id FW_ID The ID of the parent brand of the channel
Name Type Description id FW_ID The ID of a particular TV rating name String The name of a particular TV rating
Name Type Description id FW_ID The ID of a particular genre name String The name of a particular genre parent_genre_id FW_ID The ID of the parent genre
Name Type Description id FW_ID The ID of a particular language name String The name of a particular language
Name Type Description id FW_ID The ID of a particular content duration name String The name of a particular content duration
Name Type Description id FW_ID The ID of a certain content daypart name String The Name of a certain content daypart
Name Type Description id FW_ID The ID of a certain stream type name String The Name of a certain stream type
Name Type Description id FW_ID The ID of a particular device type name String The name of a particular device type parent_device_type_id FW_ID The ID of the parent device type
Name Type Description id FW_ID The ID of a particular operating system name String The name of a particular operating system
Name Type Description id FW_ID The ID of a particular environment name String The name of a particular environment
Name Type Description Get Only? id FW_ID The ID of a certain endpoint owner Yes name String The name of a certain endpoint owner Yes
Name Type Description Get only? id FW_ID The ID of a certain endpoint name Yes name String The text string providing a certain endpoint name Yes parent_endpoint_owner_id FW_ID The ID of the parent endpoint owner of the endpoint name Yes
Name Type Description Get Only? id FW_ID The ID of a certain subscription model Yes name String The name of a certain subscription model Yes
Name Type Description Get Only? id FW_ID The ID of a certain content territory Yes country_name String The name of a certain content territory Yes
Name Type Description Get only? id FW_ID The ID of a particular series Yes name String The name of a particular series Yes
Name Type Description Get only? id FW_ID The ID of a particular content credential status Yes name String The name of a particular content credential status Yes