Reference Objects

These objects have endpoints describing their options and are used to configure Segments, Budgets and Campaigns.

Live Status

A Live Status object describes the state of a campaign at an instant in time with the following attributes:

Live Status objects are correct only for the instant they are returned. That is, a campaign that is on-air when the request is made may be off-air 10 minutes later.

Marketer Extra Fields

Marketer extra fields allows you to focus on the marketer fields that interest you. In order to use this notion, pass the request parameter 'extraFields' with any of the following values:

Campaign Extra Fields

Campaign extra fields allows you to focus on the campaign fields that interest you. In order to use this notion, pass the request parameter 'extraFields' with any of the following values:

Promoted Link Extra Fields

PromotedLink extra fields allows you to focus on the promoted link fields that interest you. In order to use this notion, pass the request parameter 'extraFields' with any of the following values:

Targeting Object

The Targeting object is simply a container for many Platform targeting objects. This is the object that is set on a campaign to apply targeting. This container has the following attributes:

If you wish to remove all current locations from a campaign, simply pass an empty array to the locations property.

Custom Audience Object

The Custom Audience Object is simply a container for segment ids. This container has the following attributes:

audienceIntelSegments Targeting Object

The same structure as Interest Targeting Object Interest Targeting, The tag is "audienceIntelSegments" instead of "interests" and the values are the 3rd party segments ids instead of the interest ids.

• Example

  "customAudience": { "audienceIntelSegments": { "op": "And", "terms": [ { "op": "Or", "ids": [ "008e954c0fdcdc89e8ec778c51480abd56", "008ede139cfc00fa93de16fdb7cce82757" ] }, { "op": "Or", "ids": [ "002f0efce4ef0b68bbcc04371afd5e9051", "0051f5b968a62736eb952c4c23956161a0", "0064ecd019e3144ad76bd00ac80a229a70" ] } ] } }

Operation Status

The Operation Status object represent the response's status. It has the following attributes:

Marketer Blocked Sites

Contains the blocked Publishers and / or Sections which the Marketer defined. It has the following attributes:

Campaign Blocked Sites

Contains the blocked publishers / sections which the Campaign and his marketer defined. It has the following attributes:

Blocked Publisher

Represents a blocked Publisher by Marketer / Campaign.

Blocked Section

Represents a Section by Marketer / Campaign.

Order Value

Represents the Conversion Event's order value.

Pixel Type Rules

Represents a collection of rule groups.

Rule Group

Represents a collection of rules defining membership to a PIXEL type segment.

Rule

Represents a rule defining membership to a PIXEL type segment.

Segment's Conversion

Represents the conversion that the segment is based on. For Value Based Converters segment represents also the rule defining membership to Value Based Converters segment

Value Based Converters Rule

Represents a rule defining membership to Value Based Converters segment

Targeting Campaigns Response

Represents a collection of targeting campaigns.

Targeting Campaign

Represents a mapping from segment id to its targeting campaigns.

Campaign

A minimal representation of campaign.

Bids

Bids objects give you the option to adjust your campaign’s CPC by different aspects.

The Bids object has the following attributes:

Volume Control

The Volume Control object allows you to provide feedback on individual section performance for your CBS Auto mode campaigns (tROAS, tCPA, Max Conversion) to increase or decrease traffic volume.

Note: Adjustments can only be applied if the campaign is eligible. Eligibility is determined by the campaign having over 300 clicks and being a CBS Auto mode campaign.

The Volume Control object has the following attributes:

Volume Control Adjustment

The Volume Control Adjustment object has the following attributes:

Campaign Optimization

Campaign Optimization object defines the optimization policy of a campaign

The Campaign Optimization object has the following attributes:

CPC by Section

CPC by section allows you to maximize your exposure on specific publisher sections.

• Calculation details and a general explanation about CPC Adjustment can be found here

• This feature works best when focusing on the sections that are converting well and bringing in engaged traffic.

The CPC By Section object has the following attributes:

CPC Adjustments

CPC Adjustments allows you to maximize your exposure on specific entities (e.g - publisher sections, promoted links etc.).

With custom CPC adjustments you choose a percentage higher or lower than the fixed campaign CPC based on the entity's performance.

The cpc adjustment calculation is: < cpc > + [< cpc > * < cpc adjustment >]

For example when the campaign's cpc is 0.4 and the cpc adjustment is 0.5, the cpc for the selected entity will be 0.4 + (0.4 * 0.5) = 0.6 and when passing -0.5 0.4 + (0.4 * (-0.5)) = 0.2

In case a cpcAdjustment of an entity is applied together with another entity's cpcAdjustment, The cpc adjustment calculation is: < Campaign’s cpc > + [< cpc > * < entity 1 cpc adjustment > * < entity 2 cpc adjustment > * < by hour cpc adjustment >] For example, in case a cpcAdjustment of a promotedLink is applied together with a section’s cpcAdjustment, The cpc adjustment calculation is: < Campaign’s cpc > + [< cpc > * < promotedLink cpc adjustment > * < section cpc adjustment >

• CPC adjustments will override any Optimization done on the entity except for day and hour bid adjustment.

• CPC adjustments are supported only for campaign with optimizationType of CPC and Traffic In case the optimizationType is MAX_CONVERSION_FULLY_AUTOMATED, 'TARGET_ROAS_FULLY_AUTOMATED' or 'TARGET_CPA_FULLY_AUTOMATED', setting or adjusting CPC adjustments will result in an error.

• Bid adjustments are kept when switching between optimizationType of type CPC or TRAFFIC to MAX_CONVERSION_FULLY_AUTOMATED or 'TARGET_CPA_FULLY_AUTOMATED'. E.g - in case optimizationType is CPC or TRAFFIC, switching to MAX_CONVERSION_FULLY_AUTOMATED, 'TARGET_ROAS_FULLY_AUTOMATED' or 'TARGET_CPA_FULLY_AUTOMATED' will result in not returning the adjustments on a GET call. If the optimizationType is then switched back to CPC, the previous adjustments will return on the GET call.

• The adjusted cpc can only be between the campaign's min and max cpc (when bidding below the campaign's min cpc the cpc will be the campaign's min cpc and the same goes when bidding above the max cpc)

• It is not recommended to reduce the CPC too significantly. Setting it 5-10% lower than the fixed CPC will ensure attention is driven to the highest performers.

Campaign Scheduling Rules

• In order for the campaign scheduling rules to take effect, the onAirType should be set to "Scheduled".
• While defining more than a single rule of the same type (cpc/on air), they can't overlap each other's timeline.

On Air Rules

The object defines a scheduling configuration which allows the campaign to be on-air on future timeline during the week.

• In case the campaign's onAirType is configured to "Scheduled" and there are no on-air rules defined, it means that the campaign should be constantly on-air.

Cpc Rules

The object defines a scheduling configuration which allows adjusting the cpc on future timeline during the week.

Calculation details and a general explanation about CPC Adjustment can be found here.

Campaign On Air Scheduling Rules

Campaign Cpc Scheduling Rules

Cpc Rules Examples

The following rule will change the campaign's cpc according to the cpcAdjustment between Sunday at 03:00 until Tuesday at 01:00

• Schema

  "scheduling": { "cpc": [ { "startDay": "Sunday", "endDay: : "Tuesday", "startHour": 3, "endHour": 1, "cpcAdjustment": 0.1 }] }

On Air Rules Examples

• Please note that the campaign will be on-air unless other condition made the campaign become off-air. (i.e, campaign is disabled, budget was depleted, etc')

The following rule means that the campaign should be on-air between Sunday at 02:00 until Sunday at 06:00.

• Schema

  "scheduling": { "onAir": [ { "startDay": "Sunday", "endDay: : "Sunday", "startHour": 2, "endHour": 6 }] }

The following rule means that the campaigns should be on-air between Sunday at 10:00 until the next Sunday (in the week after) at 02:00.

• Schema

  "scheduling": { "onAir": [ { "startDay": "Sunday", "endDay: : "Sunday", "startHour": 10, "endHour": 2 }] }

The following rule means that the campaigns should be on-air between Tuesday at 02:00 until the next Sunday (in the week after) at 06:00.

• Schema

  "scheduling": { "onAir": [ { "startDay": "Tuesday", "endDay: : "Sunday", "startHour": 2, "endHour": 6 }] }

Seed Sub Segment

Seed Sub Segment object is a combination of country code and platform of your seed segment's users

The Seed Sub Segment object has the following attributes:

Lookalike Sub Segment

Lookalike Sub Segment object is a combination of country and platform for your Lookalike audience.

The Lookalike Sub Segment object has the following attributes:

Sub Segments Metadata

Sub Segments Metadata object contains an array of all available Seed Sub Segment in your seed audience.

The Sub Segments Metadata object has the following attributes:

Seed Segment

Seed Segment is a segment for which the Lookalike segment includes similar users from. The Seed Segment object has the following attributes:

Lookalike Settings

Our Lookalike model searches our premium publisher network to find new people likely to be interested in a marketer’s business because they resemble existing customers.

Lookalike Settings object describes the settings of a LOOK_A_LIKES segment. The Lookalike Settings object has the following attributes:

Create Lookalike Metadata

Create Lookalike Metadata object contains settings of a new Lookalike segment. Create Lookalike Metadata object has the following attributes:

Update Lookalike Settings

Update Lookalike Settings object contains updatable settings of a Lookalike segment. Update Lookalike Settings object has the following attributes:

Sub Segment

Sub Segment object is a combination of country code and platform of your subseed audience, that will be targeted in the Lookalike segment. The Sub Segment object has the following attributes:

DMP Info

DMP Info object contains info about the DMP segment. The DMP Info object has the following attributes:

Interest Targeting

Interest Targeting gives you the abillity to select your preferred interests categories in your campaign setup. Then, using our powerful interest insights and predictive technology, we’ll match you with audiences we know are interested in your desired categories and will surface your content to the people who are most likely to take action.

Interest Targeting Object

The interests property gives you the abillity to configure your desired interests using logical operations:

Basic Interest Term Configuration:

A Basic Term has the following properties:

Advanced Interest Term Configuration:

An Advanced Term has the following properties:

Interests usage example:

• Basic Interest Term

  "interests": { "op":"Or", "ids":["007a3a7bcac3d8414f5e22e5f6512bac62", "002f4e9538befa0a97db5cf3bddb0fc2cd"] }

• Advanced Interest Term ( And of Or's )

  "interests": { "op":"And", "terms":[ { "op":"Or", "ids":["007a3a7bcac3d8414f5e22e5f6512bac62"] },{ "op":"Or", "ids":["002f4e9538befa0a97db5cf3bddb0fc2cd"] } ] }

• Advanced Interest Term ( Not usage )

  "interests": { "op":"Not", "terms":[ { "op":"Or", "ids":["007a3a7bcac3d8414f5e22e5f6512bac62"] } ] }

IABCategories Targeting

IABCategories Targeting gives you the abillity to select your preferred IAB categories in your campaign setup.

IABCategories Targeting Object

The same structure as Interest Targeting Object Interest Targeting, The tag is "iabCategories" instead of "interests" and the values are the IAB category ids instead of the interest ids.

IABCategories usage example:

• IABCategories Term

  "iabCategories": { "op": "And", "terms": [ { "op": "Not", "terms": [ { "op": "Or", "ids": ["IAB12-1"] } ] }, { "op": "Or", "ids": ["IAB12-3"] } ] }

Network

Used to Target MSN publishers only.

Network Object

A network has the following properties:

To target MSN publishers only, use the json below:

"network": {

"type":"PublisherList",

"selection":["005989514658fab332ace27125dc90eb0c"]

}

To stop targeting MSN publishers only, use the json below:

"network": {

"type":"PublisherList",

"selection":[]

}

Segment Availability

Segment Availability object contains info about the availability of the segment.

Publisher

Represents a Publisher.

Section

Represents a Section.

Sections Collection Response

Represents a collection of sections.

Dynamic Retargeting

Represents Dynamic Retargeting settings

Account

Represents Marketer's Account details