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 their ad in a defined environment and on specific devices. With direct line items, you can serve your campaigns on pre-agreed inventory.
With Line Items section of Direct Line Items Management API, you can create and update direct line items, create and delete line item labels, as well as retrieve information about direct line items.
To create a direct line item, use an advertiser ID, a campaign ID, and an order ID in your requests. These IDs are necessary to assign the new direct line item to the relevant hierarchy — parent advertiser, campaign, and order. In addition, use the media UUID to assign the relevant media to your direct line item.
Tip
To learn about Adform DSP and Ad Server API structure and use cases, see Learn About DSP and Ad Server APIs.
To start working with Direct Line Items Management API, you need:
-
Adform Ad Server user account that has these permissions assigned:
-
Manage Direct Line Items
-
Manage Campaigns & Orders
-
-
The following scopes assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/buyer.direct.lineitems: Grants access to all endpoints of the Direct Line Items Management API.
-
https://api.adform.com/scope/buyer.direct.lineitems.readonly: Grants read-only access to some of the endpoints of the Direct Line Items Management 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.