Create and Manage Advertisers

Greta
Greta
  • Updated

Create Advertisers With API

To start setting up your campaigns, the first step is to create an advertiser. The advertiser is the highest entity for managing all your campaign-related activities. To efficiently manage your campaigns, you can create separate advertisers for each client, brand, or market.

Tip

For more information about different advertiser types and setup considerations, see Create and Manage Advertisers.

When creating an advertiser, you can define the settings that'll be associated with the campaigns that you'll create for that advertiser. For example, you can define the industry vertical, the site tracking type to use, or the campaign labels to apply.

Note

When you create an advertiser, you need to decide on the site-tracking strategy and set it up, as you won't be able to edit it later.

With Advertisers Management API, you can create, edit, and activate advertisers. You can also retrieve information about existing advertisers.

To define additional advertiser settings, you need to use other APIs to retrieve the necessary criteria. Certain settings, such as append rules or third-party ad verification can only be set up in the advertiser setup in Adform FLOW, or with the help of Adform Support (technical@adform.com).

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

  • 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.advertisers: Grants access to Advertisers Management API.

  • https://api.adform.com/scope/buyer.classifiers.readonly: Grants access to Advertisers Classifiers API.

  • https://api.adform.com/scope/ndw.addresses: Grants access to Advertisers Addresses API.

  • https://api.adform.com/scope/agencies.readonly: Grants access to Agencies 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 set up advertiser settings with API, use the following IDs in your requests:

ID

Used To

Retrieve From

advertiserId

Specify the advertiser to assign certain settings, for example, labels or ads settings

Provided as part of response body after creating an advertiser (see step 4 in Workflow)

addressId

Specify the advertiser's address, for example, for invoicing purposes

Provided as part of response body after setting up an address (see step 3 in Workflow)

Note

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

Workflow

Tip

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

To create an advertiser with API, use these endpoints:

  1. GET endpoints in Advertisers Classifiers API: To retrieve settings for advertiser setup.

  2. (Optional) GET endpoints in Agencies API: To retrieve a list of agencies that can be associated with the advertiser.

  3. (Optional) POST endpoint in Advertisers Addresses: To define an advertiser's address.

  4. POST endpoint in Advertisers Management API: To create an advertiser.

  5. (Optional) POST endpoint in DefaultBannerAttributes API: To define default settings, which you can use when creating ads under this advertiser.

  6. (Optional) PUT endpoint in Advertisers Management API: To set up labels, which you can use when creating campaigns under this advertiser.

Note

To set up append rules, third-party ad verification, or site tracking for the advertiser, you need to contact Adform Support (technical@adform.com). You can also define these settings in the advertiser setup in Adform FLOW.

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

Endpoints

[{"api":"Agencies","titles":"Agencies, AgencyAttributes"}]

Create Domain Templates With API

To effectively manage domain targeting for your campaigns, you can create templates that specify which domains to include or exclude. Templates help you control which domains are allowed or blocked for your advertisers. You can reuse the same templates across multiple campaigns, saving time and making the targeting process more efficient.

Tip

For more information on when to use domain templates, see Use Domain Templates for RTB.

Once you create a domain template, you can proceed to set up inventory targeting for the programmatic line item by assigning the template to the line item.

With Templates API, you can create, update, and retrieve domain templates. To retrieve a list of domains to include in a template, you need to use an additional API.

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 domain template with API, Adform DSP and Ad Server user account must have this permission assigned by the business account admin:

  • Manage Templates Library

You also need the following scopes assigned to your OAuth client by Adform Support (technical@adform.com):

  • https://api.adform.com/scope/templates.domains: Grants access to Domains section of the Templates API.

  • https://api.adform.com/scope/buyer.marketplace.inventories.readonly: Grants access to Inventory Marketplace API.

Tip

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

Workflow

Tip

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

To create a domain template with API, use these endpoints:

  1. POST endpoint of InventoryMarketplace API: To retrieve a list of domains, which you can then add to a domain template.

  2. POST endpoint of Domains section of Templates API: To create a domain template.

After you've created a domain template, you can assign it to a programmatic line item.

Endpoints

[{"api":"Templates","titles":"Domains"}]

Was this article helpful?

/
How can we make it better?

Thank you for your feedback!