The Yield Optimization Volume Cap API V4 allows you to perform a series of interactive operations on the Inventory Prioritization type of Yield Optimization rules.
Note
Yield Optimization Inventory Prioritization API V4 functionality is only available for Marketplace users.
You can use the Yield Optimization Inventory Prioritization API V4 to:
- Create a new Yield Optimization Inventory Prioritization rule;
- Update an existing Yield Optimization Inventory Prioritization rule, including the activation and deactivation;
- Retrieve a list of Yield Optimization Inventory Prioritization 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 Prioritization rule;
GENERAL RESOURCE URIS
| Type | URI |
|---|---|
| Production Instance | https://api.freewheel.tv/services/v4/yield_optimization/prioritizations?{param1}={query1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/yield_optimization/prioritizations?{param1}={query1}&... |
BASIC ATTRIBUTES
| Name | Type | Description | Get Only? | Notes |
|---|---|---|---|---|
| id | FW_ID | The ID of the yield optimization inventory prioritization rule. | Yes | |
| network_id | FW_ID | The ID of the network which the yield optimization prioritization belongs to. | Yes | |
| name | String | The name of the yield optimization prioritization rule. | The maximum length of characters is 255 | |
| description | String | The description of the yield optimization prioritization rule. | The maximum length of characters is 500. | |
| status | Enum | The status of the yield optimization prioritization rule. Valid values: - ACTIVE - INACTIVE -NOT_START -EXPIRED | ||
| risk_level | Enum | The risk level of yield optimization prioritization rule. Valid values: - SAFE - LIGHT_RISK - MEDIUM_RISK - HEAVY_RISK - IGNORE_GOAL | ||
| prioritization_tiering | Set | The prioritization tiering of each inventory source type including both parent and child tiering. | At least two supply source tiers (parent/child) of a certain prioritization rule. | |
| application_scope | Enum | The demand application scope of a yield optimization prioritization 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 prioritization rule. | |
| demand_type | Enum | The demand type that the prioritization 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 prioritization rule apply to. | Yes | It will return empty if application_scope = GLOBAL |
| start_time | Time | The start time of the yield optimization distribution rule. | No | The value must be later than current time. |
| end_time | Time | The end time of the yield optimization distribution rule. | No | The value must be later than start time and current time It would return empty when end_time is ongoing. |
Prioritization Tiering - Child Attributes
| Name | Type | Description | Notes |
|---|---|---|---|
| parent_level_tiering | Array of sub-parent_level_tiering | The parent level tiering allows to apply the prioritization tiering to the supply source categories level. | |
| child_level_tiering | Array of set sub-child_level_tiering | The child level tiering allows to apply the prioritization tiering to the individual supply object level. |
Sub Parent Level Tiering - Child Attributes
| Name | Type | Description | Notes |
|---|---|---|---|
| supply_type | Enum | The supply source category of parent-level supply. Valid values are: OWNED_AND_OPERATED, MRM_RULE, INVENTORY_ORDER, and INVENTORY_SPLIT_ORDER. | INVENTORY_ORDER and INVENTORY_SPLIT_ORDER are only valid for Marketplace buyers. |
| priority | Integer | The priority/tier of the corresponding supply_type. | The value must be between 1 and 120. |
Sub Child Level Tiering - Child Attributes
| Name | Type | Description | Get Only? | Notes |
|---|---|---|---|---|
| supply_type | Enum | The supply source category of child-level supply items. Valid values are: INVENTORY_ORDER, INVENTORY_SPLIT_ORDER, and INVENTORY_PACKAGE. | INVENTORY_ORDER, INVENTORY_SPLIT_ORDER are only valid for Marketplace buyers. INVENTORY_PACKAGE Is only valid for Marketplace customers. | |
| supply_id | FW_ID | The FW ID of the child-level supply item for tiering. | ||
| supply_name | String | The name of the child-level supply item for tiering. | Yes | |
| priority | Integer | The priority/tier of the child-level supply item for tiering. | The value must be between 1 and 120. |
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 |