A line item is an element of a campaign, grouped under an order. It has all the ad delivery details that a publisher needs to show your ad in a defined context. With programmatic line items, you can buy ad impressions programmatically through Supply-Side Platforms (SSPs) and ad exchanges in real time. Line items give flexibility for advertisers to test, optimize, and manage distinct segments of a campaign independently, making it easier to tailor strategies to different audiences or placements.
Tip
For more information about programmatic line items, see Create Programmatic Line Items and General Programmatic Line Item Settings.
After you've created a campaign and order, you need to create a line item to define your ad delivery settings, such as budget allocation, buying strategy, and targeting criteria.
With Line Items section of RTB Line Items Setup API, you can create, update, pause, and delete programmatic line items. You can also search for specific line items by their ID, and retrieve information about them. To define targeting criteria for the line item, you need to use other APIs to retrieve specific targeting settings and then assign them to the programmatic 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 create a 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/market.stats: Grants access to Inventory Marketplace Stats 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 create 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 belongs |
|
|
|
Specify the domain template to assign it to the line item |
|
|
|
Specify the line item to assign targeting settings |
Provided as part of response body after creating a line item (see step 6 in Workflow) |
Note
Additional IDs might be used, but the listed ones are required to pass a request.
After you've created an advertiser, campaign, and order, you can continue with creating a line item.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To create a programmatic line item with API, use these endpoints:
-
POST endpoints in Inventory Marketplace API: To create lists of ad exchanges, deals, deal groups, apps, and domains for inventory targeting setup.
Tip
You can use Inventory Marketplace Stats API to retrieve information about performance KPIs of the selected inventory sources, deals, websites, and apps.
-
(Optional) GET endpoint in Domains section of Templates API: To retrieve the created domain template ID 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 endpoint of LineItems section of RTB Line Items Setup v3 API: To create a line item with general settings and assign inventory, audience, technical, and geography targeting lists and criteria.
After you've created a line item, you can continue with creating ads.