Beeswax

List of Targeting Modules and Keys

This document summarizes the targeting modules and keys available in the Buzz 2.0 API. See Targeting for details on how to programmatically retrieve and use this data.

When a targeting key is specified using an enumerated list of codes (e.g. metro areas or ads.txt codes) the available codes can be programmatically discovered using a Reference Resource.

📘

Migration Notes from 0.5 API

  • The ip_list and multi_list targeting keys are no longer supported.
  • Many targeting keys have been re-arranged into different modules

Module

Keys

Notes

app_site

app_bundle_list

AppBundle lists defined using Custom Lists object. Targeting app_list -1 matches any request with a blank or no app bundle

app_id_list

AppID lists defined using Custom Lists object. Targeting app_list -1 matches any request with a blank or no app ID

app_name

String, no validation

deal_id

Deal ID in the format <inventory_source>/<deal_id> for example if the deal_id is foo_bar and it is from the Inventory Source adx, the deal_id is adx/foo_bar. Note, there is no validation that this is a valid deal.

deal_id_list

List of deal IDs to include or exclude defined using custom_list object.

domain_list

Domain lists defined using custom_list object.

placement

ID in the form <inventory_source>/<placement_name>. Placement name is not validated but can be found in reporting or logs.

placement_list

List of placements to include or exclude

publisher_id

ID in the form <inventory_source>/<publisher_id>. Publisher ID is not validated but can be found in post-campaign reporting.

publisher_id_list

List of publisher IDs to include or exclude defined using custom_list object.

site

Site names in form <inventory_source>/<site_id>. IDs can be found in post-campaign reporting.

site_list

List of sites to include or exclude defined using custom_list object.

content

content_category

IAB categories from OpenRTB

content_rating

Content rating types according to OpenRTB 6.18

language

Language of site on which ad is shown. Lookup based on ISO 639-1.

environment

ad_position

Publisher declared ad position such as "above the fold". Note, these values are not validated and do not guarantee viewability.

ads_txt

Code representing the compliance with ads.txt.

environment_type

0=web, 1=in-app

interstitial

Boolean representing whether the impression is an interstitial. Only accepts the value true but can be included or excluded.

interstitial_type

Creative type expected in interstitial placement: BANNER, VIDEO or BANNER_AND_VIDEO

native_layout

The format of native creatives that are allowed in this ad slot.

rewarded

Whether the end user is incentivized to interact with the ad. Typically this would be for rewarded video ads in mobile environments. Only accepts the value true but can be included or excluded.

topframe

Whether the ad is being served in the top browser frame (true).

video_api

List of API frameworks defined in OpenRTB 5.6. e.g. VPAID, MRAID, etc.

exchange

auction_type

The type of auction as declared by the inventory source:
-1 - Unknown
1 - First Price
2 - Second Price

inventory_source

Two-or three-letter code for the inventory source (eg. "adx"=”Google AdX”)

geo

country

Validated against ISO 3166-1 alpha-3

city

IDs based on MaxMind database which is based on Geonames. The IDs can be found in the Cities reference.

lat_long_list

List of latitude and longitudes using the custom_list object. A value of -1 will match when no lat/long is available.

lat_long_present

Whether the user's latitude and longitude are present on the request. Note, this does not actually target the user's location, just filters impressions where the data is present. Only accepts the value true but can be included or excluded.

location_type

The type of location data available, as specified in OpenRTB 2.5. 1 - GPS, 2 - IP, 3 - Registration

region

Region in format <country_code>/<region_code> where country_code is ISO 3166-1 alpha-3 and regions are based on ISO_3166-2.

metro

Validated against DMA table, based on Google's metro codes, which are similar to Nielsen DMAs

zip

3 or more characters

zip_code_list

List of zip codes to include or exclude

platform

bandwidth

Validates against connectiontype field defined in OpenRTB 5.18. Note, "WIFI" is a valid value.

browser

Browser name as a string.

browser_version

Browser version to target, most typically to exclude. Most commonly, you will want to include a browser and exclude one or more browser_versions. If you exclude a browser, but include browser_versions, nothing will serve.

carrier

List of mobile carriers by name.

js_support???

Whether the device supports JavaScript, passed as a boolean.

device_type

Device type id as described in OpenRTB section 6.16.

device_make

Device make as a string.

device_model

Device model as a string, including version number. Note OpenRTB keeps the model and the version as separate fields.

device_screen_size

Device screen size. Valid values are "S", "M", "L", "XL", and "NA"

operating_system

Specific OS versions identified by strings such as Windows

operating_system_version

Specific version of OSes such as Windows 7 or OSX 10.8 in the format <OS>/<Version>

user

ip_address

Validates a range of IP addresses in the format [<start>,<end>]

segment

Segments keys defined using segment object.

user_id

Boolean indicating whether a user ID is present on the request. This does not target individual users. Only accepts the value true but can be included or excluded.

time

time_of_week

Count in minutes from Sunday at midnight (0) to Saturday at 11:59 (10079) in range format [<start>,<end>]. Calculation is against EST. See user_time_of_week below for relative time.

user_time_of_week

Count in minutes from Sunday at midnight (0) to Saturday at 11:59 (10079) in range format [<start>,<end>]. Calculation is against the user's timezone at the time the ad is served.

Note, when using user_time_of_week with pacing, the user_timezones field at theLine Item level must be utilized to assure paced delivery.

video

companion_required

Is a video companion ad required in order to serve. Only accepts the value true but can be included or excluded.

playback_method

Codes from 1-4 based on OpenRTB 6.6. Example 1= Auto-play with sound on.

player_size

Small, medium, or large.

start_delay

Codes from -2 to 0 based on OpenRTB 6.9. Buzz does not support an exact offset in seconds.

video_placement_type

Whether the video is in-banner (0), in-stream (1), in-article (2), in-feed (3), or interstitial/slider/floating (4)

Updated 6 months ago


What's Next

Targeting

List of Targeting Modules and Keys


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.