Create and Manage Campaigns

Greta
Greta
  • Updated

Create Campaigns With API

A campaign is a collection of ads aimed at promoting and selling your services or products. It defines settings such as schedule, budget, and brand controls that Adform uses to deliver, optimize, and report on ads.

Tip

For more information about campaign settings, see Create Campaigns.

After you've created an advertiser, you need to create a campaign. Once you have a campaign, you'll be able to create orders and different types of line items, and then place your ads under them. Campaigns are where you define your advertising goal, for example, sales, website traffic, or brand awareness.

With Campaigns Management API, you can create a new campaign, define and update specific campaign settings, and retrieve information about the status of a specific campaign. You can also retrieve the list of all campaigns that you have access to.

Authentication

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 campaign, Adform DSP and Ad Server user account must have these permissions assigned by the business account admin:

  • Manage Campaigns & Orders

  • Manage Advertisers

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.classifiers.readonly: Grants access to Advertisers Classifiers API.

  • https://api.adform.com/scope/buyer.campaigns.api: Grants access to Campaigns Management API.

Tip

If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.

Prerequisites

To create a campaign with API, use the following IDs in your requests:

ID

Used To

Retrieve From

advertiserId

Specify the advertiser to which the campaign belongs

Advertisers Management API

campaignId

Specify the campaign to check its status

Provided as part of response body after creating a campaign (see step 1 in Workflow)

Note

Additional IDs might be used, but the listed ones are required to pass a request.

Workflow

After you've created an advertiser, you can continue with creating a campaign.

Tip

To learn how to use Adform APIs, read the Guide to Using Adform APIs.

To create a campaign with API, use these endpoints:

  1. (Optional) GET endpoints in Advertisers Classifiers API: To retrieve a list of managers and available time zones for campaign setup.

  2. POST endpoint in Campaigns Management API: To create a campaign.

  3. GET endpoint in Campaigns Management API: To check the campaign creation status.

After you've created a campaign, you can continue with creating an order.

Endpoints

[{"api":"Advertisers Classifiers","titles":"Managers, Time Zones"}]

Create Orders With API

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.

Authentication

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.

Prerequisites

To create an order with API, you must use the following IDs in your requests:

ID

Used For

Retrieve From

campaignId

Specify the campaign to which the order belongs

Campaigns Management API

Note

Additional IDs might be used, but the listed ones are required to pass a request.

Workflow

After you've created a campaign, you can continue with creating an order.

Tip

To learn how to use Adform APIs, read the Guide to Using Adform APIs.

To create an order with API, use this endpoint:

  1. 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.

Endpoints

Was this article helpful?

/
How can we make it better?

Thank you for your feedback!