REST Resource: bidders.pretargetingConfigs

Resource: PretargetingConfig

Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.

JSON representation
{
  "name": string,
  "displayName": string,
  "billingId": string,
  "state": enum (State),
  "includedFormats": [
    enum (CreativeFormat)
  ],
  "maximumQps": string,
  "geoTargeting": {
    object (NumericTargetingDimension)
  },
  "invalidGeoIds": [
    string
  ],
  "userListTargeting": {
    object (NumericTargetingDimension)
  },
  "interstitialTargeting": enum (InterstitialTargeting),
  "allowedUserTargetingModes": [
    enum (UserTargetingMode)
  ],
  "excludedContentLabelIds": [
    string
  ],
  "includedUserIdTypes": [
    enum (UserIdType)
  ],
  "includedLanguages": [
    string
  ],
  "includedMobileOperatingSystemIds": [
    string
  ],
  "verticalTargeting": {
    object (NumericTargetingDimension)
  },
  "includedPlatforms": [
    enum (Platform)
  ],
  "includedCreativeDimensions": [
    {
      object (CreativeDimensions)
    }
  ],
  "includedEnvironments": [
    enum (Environment)
  ],
  "webTargeting": {
    object (StringTargetingDimension)
  },
  "appTargeting": {
    object (AppTargeting)
  },
  "publisherTargeting": {
    object (StringTargetingDimension)
  },
  "minimumViewabilityDecile": integer
}
Fields
name

string

Output only. Name of the pretargeting configuration that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_id}

displayName

string

The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.

billingId

string (int64 format)

Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billingId to attribute each of their bids.

state

enum (State)

Output only. The state of this pretargeting configuration.

includedFormats[]

enum (CreativeFormat)

Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent.

An unset value will allow all bid requests to be sent, regardless of format.

maximumQps

string (int64 format)

The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide

geoTargeting

object (NumericTargetingDimension)

The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv

invalidGeoIds[]

string (int64 format)

Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

userListTargeting

object (NumericTargetingDimension)

The remarketing lists included or excluded in this configuration as defined in UserList.

interstitialTargeting

enum (InterstitialTargeting)

The interstitial targeting specified for this configuration.

The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.

allowedUserTargetingModes[]

enum (UserTargetingMode)

Targeting modes included by this configuration. A bid request must allow all the specified targeting modes.

An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.

excludedContentLabelIds[]

string (int64 format)

The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.

includedUserIdTypes[]

enum (UserIdType)

User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.

includedLanguages[]

string

The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

includedMobileOperatingSystemIds[]

string (int64 format)

The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

verticalTargeting

object (NumericTargetingDimension)

The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals

includedPlatforms[]

enum (Platform)

The platforms included by this configration. Bid requests for devices with the specified platform types will be sent.

An unset value allows all bid requests to be sent, regardless of platform.

includedCreativeDimensions[]

object (CreativeDimensions)

Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent.

An unset value allows all bid requests to be sent, regardless of creative dimension.

includedEnvironments[]

enum (Environment)

Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory.

An unset value includes all environments.

webTargeting

object (StringTargetingDimension)

Targeting on a subset of site inventory.

If WEB is listed in includedEnvironments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent.

Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).

appTargeting

object (AppTargeting)

Targeting on a subset of app inventory.

If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent.

Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).

publisherTargeting

object (StringTargetingDimension)

Targeting on a subset of publisher inventory.

Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted.

Publisher IDs are found in ads.txt / app-ads.txt and in bid requests in the BidRequest.publisher_id field on the Google RTB protocol or the BidRequest.site.publisher.id / BidRequest.app.publisher.id field on the OpenRTB protocol.

minimumViewabilityDecile

integer

The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10.

An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.

State

Pretargeting configuration states.

Enums
STATE_UNSPECIFIED Placeholder for undefined state.
ACTIVE This pretargeting configuration is actively being used to filter bid requests.
SUSPENDED This pretargeting configuration is suspended and not used in serving.

CreativeFormat

Creative formats.

Enums
CREATIVE_FORMAT_UNSPECIFIED Placeholder for undefined creative format. This value should not be used.
HTML HTML and AMPHTML creatives.
VAST VAST video or audio creative.
NATIVE Native creative, including standard and video native ads.

NumericTargetingDimension

Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting.

JSON representation
{
  "includedIds": [
    string
  ],
  "excludedIds": [
    string
  ]
}
Fields
includedIds[]

string (int64 format)

The IDs included in a configuration.

excludedIds[]

string (int64 format)

The IDs excluded in a configuration.

InterstitialTargeting

The different ways interstitial inventory can be targeted.

Enums
INTERSTITIAL_TARGETING_UNSPECIFIED Unspecified interstitial targeting. Represents an interstitial-agnostic selection.
ONLY_INTERSTITIAL_REQUESTS Only bid requests for interstitial inventory should be sent.
ONLY_NON_INTERSTITIAL_REQUESTS Only bid requests for non-interstitial inventory should be sent.

UserTargetingMode

User targeting modes that are allowed to be used for a bid request.

Enums
USER_TARGETING_MODE_UNSPECIFIED Placeholder for undefined user targeting mode.
REMARKETING_ADS Remarketing ads are allowed to serve.
INTEREST_BASED_TARGETING Ads based on user interest category targeting are allowed to serve.

UserIdType

User identifier types that may be present in the bid request.

Enums
USER_ID_TYPE_UNSPECIFIED Placeholder for unspecified user identifier.
HOSTED_MATCH_DATA Hosted match data, referring to hosted_match_data in the bid request.
DEVICE_ID Mobile device advertising ID.

Platform

Supported platforms.

Enums
PLATFORM_UNSPECIFIED Placeholder for an undefined platform. This value should not be used.
PERSONAL_COMPUTER The personal computer platform.
PHONE The mobile platform.
TABLET The tablet platform.
CONNECTED_TV The connected TV platform.

CreativeDimensions

The dimensions of a creative. This applies to only HTML and Native creatives.

JSON representation
{
  "width": string,
  "height": string
}
Fields
width

string (int64 format)

The width of the creative in pixels.

height

string (int64 format)

The height of the creative in pixels.

Environment

Environments that can be targeted.

Enums
ENVIRONMENT_UNSPECIFIED Placeholder for unspecified environment. This value should not be used.
APP App environment.
WEB Web environment.

StringTargetingDimension

Generic targeting with string values used in app, website and publisher targeting.

JSON representation
{
  "targetingMode": enum (TargetingMode),
  "values": [
    string
  ]
}
Fields
targetingMode

enum (TargetingMode)

How the items in this list should be targeted.

values[]

string

The values specified.

TargetingMode

Ways that lists of app and website inventories can be targeted.

Enums
TARGETING_MODE_UNSPECIFIED Placeholder for undefined targeting mode.
INCLUSIVE The inclusive list type. Inventory must match an item in this list to be targeted.
EXCLUSIVE The exclusive list type. Inventory must not match any item in this list to be targeted.

AppTargeting

A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent.

JSON representation
{
  "mobileAppTargeting": {
    object (StringTargetingDimension)
  },
  "mobileAppCategoryTargeting": {
    object (NumericTargetingDimension)
  }
}
Fields
mobileAppTargeting

object (StringTargetingDimension)

Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.

mobileAppCategoryTargeting

object (NumericTargetingDimension)

Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.

Methods

activate

Activates a pretargeting configuration.

addTargetedApps

Adds targeted apps to the pretargeting configuration.

addTargetedPublishers

Adds targeted publishers to the pretargeting config.

addTargetedSites

Adds targeted sites to the pretargeting configuration.

create

Creates a pretargeting configuration.

delete

Deletes a pretargeting configuration.

get

Gets a pretargeting configuration.

list

Lists all pretargeting configurations for a single bidder.

patch

Updates a pretargeting configuration.

removeTargetedApps

Removes targeted apps from the pretargeting configuration.

removeTargetedPublishers

Removes targeted publishers from the pretargeting config.

removeTargetedSites

Removes targeted sites from the pretargeting configuration.

suspend

Suspends a pretargeting configuration.