A line item is an element of a campaign, grouped under an order. It has all the ad delivery details an advertiser needs to show your ad in a defined environment and on specific devices. With programmatic line items, you can buy ad impressions programmatically through Supply-Side Platforms (SSPs) and ad exchanges in real time.
With Line Items section of RTB Line Items Setup API, you can create, update, pause, and delete programmatic line items, as well as search for specific line items by their ID, and retrieve information about them.
To create a programmatic line item, you must use an advertiser ID, a campaign ID, and an order ID in your requests. Use these IDs to assign the new programmatic line item to the relevant hierarchy — parent advertiser, campaign, and order.
Note
After you create a line item with RTB Line Items Setup API, you need to use other APIs specify the settings that define the inventory for the line item to run in, as well as to define the targeting settings.
Tip
To learn about Adform DSP and Ad Server API structure and use cases, see Learn About DSP and Ad Server APIs.
To learn more about the different settings of the programmatic line item, see General Programmatic Line Item Settings.
To start working with RTB Line Items Setup API, you need:
-
Adform DSP user account that has these permissions assigned:
-
Manage Campaigns & Orders
-
Manage Programmatic Line Items
-
-
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 all endpoints of the RTB Line Items Setup API.
-
https://api.adform.com/scope/buyer.rtb.lineitem.readonly: Grants read-only access to some of the endpoints of the RTB Line Items Setup API.
-
-
The following IDs to use in your requests:
Note
Additional IDs might be used, but the listed ones are required to pass a request.
Note
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.