Adform SSP APIs support publishers by streamlining the processes of setting up pricing rules, creating different types of deals, and reporting on the performance of the inventory. This article introduces the SSP APIs available in Adform and how they can help you sell your inventory.
With SSP APIs, you can:
-
Set up and update inventory pricing rules and deals with minimal manual effort.
-
Adjust pricing for inventories and deals in response to seasonality or a specific time of day.
-
Create and manage programmatic guaranteed and preferred deals to create predictable revenue streams.
-
Optimize deals by adjusting targeted inventory based on near real-time KPIs retrieved from Adform reporting.
-
Analyze and improve the performance of your inventory with the help of extensive reports.
Adform SSP APIs have the following structure:
-
Access rights: You can use advertiser access rules to create demand inclusion and exclusion lists, which allows you to control advertiser (Demand Partner) access to your inventory (Publishers/Apps and Placements). To learn how to create advertiser access rules, see Demand Inclusion and Exclusion Lists.
-
Inventory: Inventory consists of Publishers API and Placements API, with which you can retrieve a list of publishers and placements along with their IDs. You can then use the retrieved IDs to manage pricing rules, create deals for your inventory, and retrieve reports. Additionally, Placements API includes information about creative settings (Creatives).
-
Deals: You can use Seller Deals API to set up and update programmatic guaranteed, preferred, and private auction deals. For this, you will also need to use Seller Buyers API to retrieve lists of demand partners and agencies (Buyers) to target in your deals, as well as Placements API to retrieve placement IDs and their creative settings.
-
Pricing rules: You can use Pricing Rules API to manage the floor prices of your inventory, and Targeting Rules API to define when to apply those inventory pricing rules.
-
Reporting: Use Reporting Stats API to monitor the performance of your inventory.
To start working with any of the Adform SSPAPIs, you need:
-
An Adform SSP user account with the relevant permissions assigned that allow you to access certain features and functions in Adform.
-
OAuth client with the relevant scopes assigned by Adform Support (technical@adform.com) that give access to specific APIs. You can see the needed scopes next to each endpoint, or in the related Adform Help article.
-
Depending on the API you're using, you might need specific IDs to use in your requests. You can see the needed IDs in each endpoint, or in the related Adform Help article.
Note
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.
Some APIs require additional IDs to be sent with your requests. You can see the needed IDs in each endpoint, or listed in the Prerequisites section of the related Adform Help article.
List of all IDs that are relevant when working with SSP APIs:
|
ID |
Description |
Source |
|---|---|---|
|
|
Inventory source ID is your Adform SSP account ID and is sent after Adform creates your SSP account. |
To get the ID, contact Adform Publishers Support (publishers@adform.com). |
|
|
Publisher ID defines the publisher that was set up in Adform SSP (website, app, or other channel such as CTV or DOOH) and that hosts the advertising space that's available for sale. |
Use Publishers API to retrieve publisher IDs. |
|
|
Placement ID defines the advertising space that can be sold. |
Use Placements API to retrieve placement IDs. |
|
|
Creative settings ID defines the ads used in a placement. |
Use Placements API to retrieve creative settings IDs. |
|
|
Demand partner ID defines the DSP that can buy a publisher's inventory. |
Use Seller Buyers API to retrieve demand partner IDs. |
|
|
Agency ID defines the buyer within Adform DSP that can buy a publisher's inventory. |
Use Seller Buyers API to retrieve agency IDs. |
|
|
Deal ID defines the deal created by a publisher. |
Use Seller Deals API to create deals and retrieve deal IDs. |
|
|
Rule ID identifies the targeting setup for which the pricing rule should be applied. Targeting setup can include deals, placements, publishers, schedules, or a combination of these. |
Use Targeting Rules API to create rules and retrieve rule IDs. |
|
|
Pricing rule ID defines the pricing rule. Pricing rules can be set for deals, placements, publishers, schedules, or a combination of these. |
Use Pricing Rules API to create pricing rules and retrieve pricing rule IDs. |
|
|
Operation ID defines the report operation that generates a requested report. |
Use Reporting Stats API to generate and retrieve operation IDs. |
|
|
Data ID defines a requested report. |
Use Reporting Stats API to generate and retrieve data IDs. |
Adform has additional resources to help you get started and to provide guidance as you work with SSP APIs:
-
Request authentication credentials and see how to renew expired access tokens in Get Authentication Credentials to Authorize With Adform APIs article.
-
Authenticate With Adform APIs: Learn about the authentication credentials needed to access Adform APIs.
-
Learn About Basic API Concepts: Learn the basic API terms, request and response structures.
-
Learn About API Limits: See specific throttling rules and system limits.
-
Learn About API Errors: Recognize and troubleshoot API errors.
-
Group Requests With Batch API: Optimize your API usage by combining requests.
If you have API-related questions, contact Adform Support.