When you create a programmatic line item, you can use forecasting tools to evaluate its effectiveness. Forecasting shows how many impressions and cookies are available based on your current programmatic line item setup, assuming that the line item bids on every request. Overview of past traffic gives you access to historical information about the ad traffic for specific inventories.
You can use both forecasting and past traffic tools to examine the expected performance of your programmatic line item and adjust its settings to better reach your goals.
Tip
For more information about forecasting capabilities for programmatic line items, see Learn About Forecasting and Bid Landscape.
With RTB Line Items v2 Forecasting API, you can get the following information about your programmatic line item:
-
Forecasting: Retrieve the estimated number of impressions and cookies available based on current line item settings. You can group this data by audience, geography, device, or by specific websites, apps, inventory sources, or deals.
-
Past Traffic: Retrieve historical number of impressions and cookies that were available for a specific line item.
To authenticate and use Adform APIs, your user account must have the necessary permissions and your OAuth client must have the required scopes assigned to it.
To use forecasting for your programmatic line item, Adform DSP and Ad Server user account must have these permissions assigned by the business account admin:
-
Manage Campaigns & Orders
-
Manage Programmatic Line Items
Depending on your objectives and workflow, you'll need some or all of the following scopes assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/buyer.rtb.lineitem: Grants access to RTB Line Items Setup API. -
https://api.adform.com/scope/buyer.marketplace.inventories.readonly: Grants access to Inventory Marketplace API. -
https://api.adform.com/scope/buyer.rtb.targetinglists: Grants access to RTB Targeting Lists API. -
https://api.adform.com/scope/integrations.classifiers.readonly: Grants access to Classifiers API. -
https://api.adform.com/scope/buyer.campaigns.api.readonly: Grants access to Campaigns API. -
https://api.adform.com/scope/dmp.segments.readonly: Grants access to the Segments section of the Data Management Platform API.
Tip
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.
To use forecasting for a programmatic line item with API, use the following IDs in your requests:
|
ID |
Used To |
Retrieve From |
|---|---|---|
|
|
Specify the order to which the line item that you want to use forecasting for belongs |
Note
Additional IDs might be used, but the listed ones are required to pass a request.
To evaluate the effectiveness of your programmatic line item, we recommend using Adform forecasting tools before creating the line item.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To get forecasting data for your programmatic line item with API, use these endpoints:
-
POST endpoints in Inventory Marketplace API: To create lists of ad exchanges, deals, apps, and domains for inventory targeting setup.
-
(Optional) GET endpoints in Segments section of Data Management Platform API: To retrieve lists of audience IDs for audience targeting setup.
-
(Optional) POST endpoint of the DeviceAndCookieIdLists section of RTB Line Items Setup v3 API: To upload a list of device and cookie IDs for technical targeting setup.
-
(Optional) POST endpoint of the IpRangeLists section of RTB Line Items Setup v3 API: To upload a list of IP ranges for technical targeting setup.
-
(Optional) GET endpoints in Classifiers API: To retrieve criteria for technology and geography targeting setups.
-
(Optional) GET endpoints in AdsOverview section in Standard Banners API: If you already have ads created, use these endpoints to retrieve a list of ads to assign to your line item.
-
POST endpoints in the RTB Line Items v2 Forecasting API of RTB Line Items Setup v3 API: To enter all programmatic line item settings and retrieve the forecasting information for it.
Once you've checked the forecasting for the line item, you can reuse the setup to create the programmatic line item.