Orders are an additional level between a campaign and its line items. If you run extensive, long-term campaigns, orders can help you manage your line items more efficiently. For example, you can set up an order per language used in your campaign, per buying strategy, channel, ad type, or budget goal used in your campaign.
Tip
For more information about order settings, see Create Orders.
After you've created an advertiser and a campaign, you need to create an order. Orders are where you define the settings that'll apply to their line items, depending on the line item type:
-
For programmatic line items, you can set campaign goals (KPIs), budget, schedule, and frequency capping details.
-
For direct line items, you can set a budget and schedule.
With Orders API, you can create a new order, update specific settings, and activate or deactivate orders. You can also retrieve a specific order or a list of all orders under a campaign.
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 an order, Adform DSP and Ad Server user account must have this permission assigned by the business account admin:
-
Manage Campaigns & Orders
You also need the following scope assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/buyer.orders: Grants access to Orders 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 an order with API, you must use the following IDs in your requests:
|
ID |
Used For |
Retrieve From |
|---|---|---|
|
|
Specify the campaign to which the order belongs |
Note
Additional IDs might be used, but the listed ones are required to pass a request.
After you've created a campaign, you can continue with creating an order.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To create an order with API, use this endpoint:
-
POST endpoint in Orders API: To create an order.
After you've created an order, you can continue with creating a programmatic line item or a direct line item.