This page will help you get started with Yield Optimization Inventory Value Distribution API V4.
The Yield Optimization Inventory Value Distribution API V4 allows you to perform a series of interactive operations on the Distributions type of Yield Optimization rules.
Note
Yield Optimization Inventory Value Distribution API V4 functionality is only available for Marketplace users.
You can use the Yield Optimization Inventory Value Distribution API V4 to:
- Create a new Yield Optimization Inventory Value Distribution rule;
- Update an existing Yield Optimization Inventory Value Distribution rule, including the activation and deactivation;
- Retrieve a list of Yield Optimization Inventory Value Distribution rules of your current network with basic attributes returned and query the list by id, name, application_scope, demand_type, and status;
- Retrieve full attributes of an individual Yield Optimization Inventory Value Distribution rule;
GENERAL RESOURCE URIS
Type | URI |
---|---|
Production Instance | https://api.freewheel.tv/services/v4/yield_optimization/inventory_value_distributions?{param1}={query1}&... |
Staging Instance | https://api.stg.freewheel.tv/services/v4/yield_optimization/inventory_value_distributions?{param1}={query1}&... |
BASIC ATTRIBUTES
Name | Type | Description | Get Only? | Notes |
---|---|---|---|---|
id | FW_ID | The ID of the yield optimization inventory value distribution rule. | Yes | |
network_id | FW_ID | The id of network which the yield optimization inventory value distribution rule belongs to. | Yes | |
name | String | The name of the yield optimization inventory value distribution rule. | The maximum length of characters is 255 | |
description | String | The description of the yield optimization inventory value distribution rule. | The maximum length of characters is 500. | |
start_time | Time | The start time of the yield optimization inventory value distribution rule. | The value must be later than current time. | |
end_time | Time | The end time of the yield optimization inventory value distribution rule. | The value must be later than start time and current time It would return empty when end_time is ongoing. | |
status | Enum | The status of yield optimization inventory value distribution. Valid values: - ACTIVE - INACTIVE | ||
supplies_and_optimization_goals | Array of the set of supplies_and_optimization_goal | The supplies and optimization goals of a yield optimization inventory value distribution rule allow a flexible way to configure the supply scope in expressions composed of multiple dimensions. | The maximum number of supplies_and_optimization_goal sets is 20. | |
cpm_of_other_supplies | Decimal | The CPM of other supplies. | The value should be non-negative. | |
price_goal | Decimal | The price goal of yield optimization inventory value distribution. | The value should be non-negative or -2 (using placement price). | |
application_scope | Enum | The demand application scope of a yield optimization inventory value distribution rule. It determines whether the rule applies to a specific demand object or the whole network. Valid values: - GLOBAL - DEMAND_TYPE_SPECIFIC | Each network can only have one GLOBAL distribution rule. | |
demand_type | Enum | The demand type that yield optimization inventory value distribution rule takes effect on. Valid values: - PLACEMENT | ||
demands | Array of the set of demand | The demand details of selected demand_type of the yield optimization inventory value distribution rule apply to. | It will return empty if application_scope = GLOBAL |
Supplies and Optimization Goal - Child Attributes
Name | Type | Description | Notes |
---|---|---|---|
expression_and_goal_id | Integer | The supply and optimization goal id of an optimization goal. | The ID will be generated the first time push a new goal; If the user would like to update an existing optimization goal attribute, please ensure to pass the corresponding expression_and_goal_id in the request. Otherwise a new goal would be created. |
expression | Expression | The supply scope expressions are composed of multiple dimensions that the rule would apply to. | |
cpm | Decimal | The CPM of the current optimization goal. | The value must be non-negative |
label | String | The label of the current optimization goal. | The maximum length of this field is 255. |
Expression - Child Attributes
Name | Type | Description | Notes |
---|---|---|---|
relation_between_statements | Enum | The operator of an expression indicates the logical relationship across all relations/statements within the current optimization goal. Valid values: AND, OR | |
statements | Array of Statement | Each relation contains multiple sets composed of corresponding inclusive and exclusive items. |
Statements - Child Attributes
Name | Type | Description | Notes |
---|---|---|---|
relation_between_sets | Enum | The operator of a relation/statement indicates the logical relationship across all sets within the current relation. Valid values: AND, OR | |
sets | Array of Set | Each set has its own inclusive and exclusive items. |
Set - Child Attributes
Name | Type | Description | Notes |
---|---|---|---|
item_inclusion_exclusion_type | Enum | It indicates that the items below will be inclusive or exclusive items. If this field is true, it means EXCLUDE the items. If the field is false, it means INCLUDE the items | |
items | Array of Item | Inclusive or exclusive items of each individual set of an optimization goal. |
Item - Child Attributes
Name | Type | Description | Get Only? | Notes |
---|---|---|---|---|
type | Enum | The type of items to be selected into relation/statement sets. Valid values are ENDPOINT_OWNER, ENDPOINT_NAME,COUNTRY, STATE, DMA, POSTAL_CODE, STREAM_MODE, PROGRAMMER, BRAND, CHANNEL, DEVICE, ENVIRONMENT, OS, GENRE, LANGUAGE, TV_RATING, DURATION, DAYPART, INVENTORY_ORDER, INVENTORY_PACKAGE | INVENTORY_ORDER is only valid for Marketplace buyers. INVENTORY_PACKAGE Is only valid for Marketplace customers. | |
id | FW_ID | The id of the included/excluded item. |
Demand - Child Attributes
Name | Type | Description | Get Only? | Notes |
---|---|---|---|---|
demand_id | FW_ID | The ID of the demand object that the YO rule applied to. | Yes | |
demand_name | String | The name of the demand object that the YO rule applied to. | Yes | |
public_id | String | The external_deal_id of the programmatic deal that the YO rule applies to. | Yes | valid only when demand_type = PROGRAMMATIC_GUARANTEED_DEAL |