Forecasting API Attributes
Attributes represent and describe data associated with an object, in this case the Forecasting object. Attributes are organized in sets. The attribute set determines the fields that are available during data entry, and the values that appear to the client. Use Forecasting API Attributes in conjunction with Forecasting API methods to accomplish your ad tech objectives.
Forecasting Attributes
Forecasting attributes describe fundamental properties of a forecast.
Forecasting Attribute Definitions
None of the attributes below are creatable, updatable, or searchable.
| Name | Type | Validation | Description |
|---|---|---|---|
| placement_id | Integer | ID of the forecasted placement | |
| tag | String (255) | A tag for tracking a forecasting process. Only for on-demand forecast result | |
| run_time | String | The time this forecasting finished | |
| on_schedule_indicator | Integer | >=0 | The % indication of how on schedule a placement is at this time in the flight dates of the placement. 100% = right on schedule. For example; If an ad was booked to run 10mm impressions in 10 days, it should run about 1mm per day. So if on Day 3, it had run 3mm impressions, it would have an OSI of 100%. Less than 100% means behind schedule, i.e. 80% means that placement is only 80% on schedule or 20% behind scheduled pace at that time. There is no on_schedule_indicator data for demand_result. |
| unconstrained_gross_available | Integer | Unconstrained Gross Available is the total number of impressions available, while ignoring most restrictions | |
| gross_available | Integer | Gross Available is the total number of impressions that meet the targeting criteria, taking into account restrictions (such as ratings restrictions, restrictions against repeating ads within ad slots and video plays, etc.) | |
| net_available | Integer | Net Available is the total number of impressions available to this placement and unreserved. It is based on the impresssions' priority, CPM, targeting factors, and competing ads already booked into your network. | |
| net_unreserved_available | Integer | Net Unreserved Available (NUA) is the total number of impressions unreserved and available to this placement. NUA is based on the impresssions' priority, CPM, targeting factors, and competing ads already booked into your network. NUA can be retrieved for nightly forecasts, for on-demand forecasts, and for on-demand results forecasts but is only available in Forecasting API v4 if the metric is activated for your system. | |
| budget_is_shared | Boolean | The flag indicates whether this placement shares currency or impression budget set for its parent insertion order. If true, exchange_currency / booked_budget / booked_impressions will be IO budget settings; If false, it will be its own's. | |
| exchange_currency | String(255) | The placement currency type | |
| budget | String(255) | This value varies based on placement's budget model and whether it shares IO budget. For example, if this placement is impression target, then it will show "[impressions] imps"; if this placement is currency target, then it will show "[currency number] currency". | |
| delivered_budget | Decimal(16,2) | Amount of budget spent so far | |
| delivered_impressions | Integer | >=0 | Current delivered impressions |
| forecast_to_be_delivered_budget | Decimal(16,2) | The amount of budget this campaign is expected to spend by the end of the placement’s flight | |
| forecast_to_be_delivered_impressions | Integer | >=0 | The amount of impressions this campaign is expected to deliver by the end of the placement’s flight |
| forecast_final_delivery_rate | Integer | >=0 | The percentage of the total budget that is expected to deliver by the end of the placement’s flight. There will be no forecast_final_delivery_rate when placement shares IO budget in on-demand result. |