Outbrain DSP API

Acquire a new authentication token ¶

Accounts ¶

Account Targeting Settings ¶

Account Credit ¶

After your Insertion Order for media spend has been executed Outbrain DSP’s Customer Success team will assign a credit line to your account. With credit added to your account you have the ability to create budget items and associate them with the campaigns you’re planning.

Pixels DEPRECATED ¶

Note: the use of img pixels has been deprecated - please use measurement services instead.

Outbrain DSP’s pixels allow you to report conversions, build audiences and get insights about how people use your website. Pixels need to be properly placed in order to measure goals effectively. We recommend placing your pixel on the confirmation page which is shown to a person after the desired action is performed.

Audiences DEPRECATED ¶

Note: this way of using audiences has been deprecated - please use measurement audiences instead.

Custom audiences allow you to target your ads to a specific set of people with whom you have already established a relationship. Audiences can be defined by a combination of rules used to identify users who took specific actions on your website.

Audience Rules ¶

Choose how you want to add people to your audience. Include all of your website visitors or create rules that only add people visiting specific parts of your website. Audience can have multiple rules set. CONTAINS and STARTS_WITH rules can match multiple values separated by a comma. STARTS_WITH values need to be valid URLs.

Campaigns ¶

A Campaign is a collection of Ad Groups. It holds common settings for all Ad Groups and also has budgets and goals associated.

Tracking Settings ¶

Postclick tracking integration can be set up for Google Analytics and Adobe Analytics.
Please note Google Analytics 4 is replacing Google Analytics Universal on July 1, 2023. Switch your account connection to GA4 to ensure we can continue to ingest your analytics data. Learn more here. If you are using Google Analytics 360, no change is required.

Campaign Targeting Settings ¶

Campaign Budgets ¶

Each budget item is part of a Credit Item and allows a campaign to spend a portion of the credit.

A campaign needs at least one active budget associated with it before its Ad Groups can be started.

More info available here.

Campaign goals ¶

Campaign goals give Outbrain DSP’s intelligent campaign automation feature Autopilot data to help optimize your campaign for optimal results.

A campaign needs at least one goal associated with it before any of its Ad Groups can be started.

Conversion Goals ¶

Ad Groups ¶

An Ad Group is a collection of Ads that has specific targeting settings.

Before any Ad Groups in the campaign can be activated, a campaign must have at least one active Budget and at least one Goal associated.

Ad Group Targeting Settings ¶

Operating System Targeting Settings ¶

Video Targeting Settings ¶

Dayparting ¶

Dayparting structure is defined as a dictionary of days which point to a list of hours that are enabled in that day, eg. “monday” -> [0, 1, 2, 5]. This means that on monday bidding is enabled from 00:00 to 02:59 and from 5:00 to 5:59. The other value is “timezone” that defines in which timezone the hours are evaluated, eg. “timezone” -> “America/New_York”. This value must be formatted according to the tz database (see https://en.wikipedia.org/wiki/Tz_database). If timezone isn’t specified then user’s timezone is used to resolve the hours.

Audience Targeting ¶

An Audience Targeting expression is an object containing a single property. The name of the property represents the operator, while its value is an array representing the subexpression(s). A subexpression can be either a nested Audience Targeting expression or a Category object.

Valid operators are AND, OR and NOT. NOT has to have exactly one nested subexpression in the child array.

Example Audience Targeting expression:

{
    "AND": [
        {
            "OR": [
                {
                    "category": "ob-eyeota:839868"
                },
                {
                    "category": "ob-eyeota:763921"
                }
            ]
        },
        {
            "NOT": [
                {
                    "category": "ob-eyeota:839918"
                }
            ]
        }
    ]
}

Audience Targeting Category ¶

Audience targeting subexpressions can either be a nested audience targeting expressions or a leaf category node.

Currently the supported providers are obi,obd,ob-sentiments,ob-eyeota and ob-nielsen. See DMP Categories API for a list of all available categories. The categoryId field is the internal Zementa’s representation and needs to be used in the targeting expressions.

Outbrain DSP Autopilot Settings ¶

Get more information about Outbrain DSP Autopilot in our knowledge base.

Browser Targeting Settings ¶

Channel Targeting Settings ¶

Ad Group Sources ¶

Each Ad Group has specific configurable settings for each media source. You can control whether the ad group is promoted on a given source, the CPC you are willing to pay on that source and the daily budget you wish to spend on that source.

Connect creatives to Ad Groups ¶

After successfully created creatives via Creative Management you can start connecting them to existing Ad Groups. A creative connection to an Ad Group is called an Ad.

Manage ads ¶

Upload Ads in batch ¶

Ads are uploaded in batches. First, you create an upload batch with the Ads you want to upload. Then, you pull the status of the batch and the validation status of the individual Ads. If any of the Ads in the batch fail the validation process, none of the Ads in the batch will be accepted into the system.

If and when all the Ads in the batch pass the validation process, they are accepted into the system.

Ad ¶

Upload Batch ¶