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.
With Campaigns API, you can create a new campaign, define, and update specific campaign settings, retrieve information about the status of a specific campaign, as well as receive the list of all campaigns that a certain user has access to.
To create a campaign, you must use a user ID and an advertiser ID in your requests. Use the advertiser ID to assign the new campaign to a specific advertiser in your account. Use user ID and timezone to specify the general and scheduling settings for your campaign.
Tip
To learn about Adform DSP and Ad Server API structure and use cases, see Learn About DSP and Ad Server APIs.
For more information about campaign settings, see Create Campaigns.
When you have a campaign created, to start delivering ads, you need to set up orders and line items.
To start working with Campaigns API, you need:
-
Adform DSP and Ad Server user account that has these permissions assigned:
-
Manage Campaigns & Orders
-
Manage Advertisers
-
-
The following scopes assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/buyer.campaigns.api: Grants full access to all endpoints of the Campaigns API.
-
https://api.adform.com/scope/buyer.campaigns.api.readonly: Grants read-only access to all endpoints of the Campaigns 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.
Note
Campaigns API has two versions — V1 and V2:
-
Use Campaign API V1 for all campaign creation and management actions.
-
Use Campaigns API V2 to define brand safety settings of your campaign. To get brand safety provider IDs and segments IDs, you need to use Adform FLOW for now. For support, reach out to Adform Support (technical@adform.com).