Skip to main content

pretargeting_configs

Overview

Namepretargeting_configs
TypeResource
Idgoogleads.realtimebidding.pretargeting_configs

Fields

NameDatatypeDescription
namestringOutput only. Name of the pretargeting configuration that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_id}
verticalTargetingobjectGeneric 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.
interstitialTargetingstringThe 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.
webTargetingobjectGeneric targeting with string values used in app, website and publisher targeting.
appTargetingobjectA subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent.
includedMobileOperatingSystemIdsarrayThe mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
billingIdstringOutput 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 billing_id to attribute each of their bids.
maximumQpsstringThe 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
displayNamestringThe diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
includedUserIdTypesarrayUser 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.
statestringOutput only. The state of this pretargeting configuration.
includedFormatsarrayCreative 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.
includedLanguagesarrayThe languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
includedEnvironmentsarrayEnvironments 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.
userListTargetingobjectGeneric 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.
publisherTargetingobjectGeneric targeting with string values used in app, website and publisher targeting.
includedCreativeDimensionsarrayCreative 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.
geoTargetingobjectGeneric 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.
includedPlatformsarrayThe 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.
minimumViewabilityDecileintegerThe 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.
invalidGeoIdsarrayOutput only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
allowedUserTargetingModesarrayTargeting 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.
excludedContentLabelIdsarrayThe 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.

Methods

NameAccessible byRequired ParamsDescription
bidders_pretargetingConfigs_getSELECTbiddersId, pretargetingConfigsIdGets a pretargeting configuration.
bidders_pretargetingConfigs_listSELECTbiddersIdLists all pretargeting configurations for a single bidder.
bidders_pretargetingConfigs_createINSERTbiddersIdCreates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.
bidders_pretargetingConfigs_deleteDELETEbiddersId, pretargetingConfigsIdDeletes a pretargeting configuration.
bidders_pretargetingConfigs_activateEXECbiddersId, pretargetingConfigsIdActivates a pretargeting configuration.
bidders_pretargetingConfigs_patchEXECbiddersId, pretargetingConfigsIdUpdates a pretargeting configuration.
bidders_pretargetingConfigs_suspendEXECbiddersId, pretargetingConfigsIdSuspends a pretargeting configuration.