--- title: "POST /v1/{+parent}/pretargetingConfigs" method: POST path: "/v1/{+parent}/pretargetingConfigs" tags: ["bidders"] --- # POST /v1/{+parent}/pretargetingConfigs `POST /v1/{+parent}/pretargetingConfigs` Creates 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. ## Path parameters - `parent` string, required ## Request body - PretargetingConfig — Pretargeting config: 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. - `includedFormats` string[] — Creative formats included by this config. 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. - `includedUserIdTypes` string[] — User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. - `name` string — Output only. Name of the pretargeting config that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}` - `invalidGeoIds` string[] — Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. - `includedMobileOperatingSystemIds` string[] — The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv - `includedPlatforms` string[] — The platforms included by this config. 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. - `webTargeting` StringTargetingDimension — Generic targeting with string values used in app, website and publisher targeting. - `targetingMode` 'TARGETING_MODE_UNSPECIFIED' | 'INCLUSIVE' | 'EXCLUSIVE' — How the items in this list should be targeted. - `values` string[] — The values specified. - `appTargeting` AppTargeting — A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. - `mobileAppTargeting` StringTargetingDimension — Generic targeting with string values used in app, website and publisher targeting. - `targetingMode` 'TARGETING_MODE_UNSPECIFIED' | 'INCLUSIVE' | 'EXCLUSIVE' — How the items in this list should be targeted. - `values` string[] — The values specified. - `mobileAppCategoryTargeting` 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. - `includedIds` string[] — The IDs included in a config. - `excludedIds` string[] — The IDs excluded in a config. - `billingId` string, int64 — Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids. - `allowedUserTargetingModes` string[] — Targeting modes included by this config. 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. - `publisherTargeting` StringTargetingDimension — Generic targeting with string values used in app, website and publisher targeting. - `targetingMode` 'TARGETING_MODE_UNSPECIFIED' | 'INCLUSIVE' | 'EXCLUSIVE' — How the items in this list should be targeted. - `values` string[] — The values specified. - `geoTargeting` 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. - `includedIds` string[] — The IDs included in a config. - `excludedIds` string[] — The IDs excluded in a config. - `verticalTargeting` 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. - `includedIds` string[] — The IDs included in a config. - `excludedIds` string[] — The IDs excluded in a config. - `excludedContentLabelIds` string[] — The sensitive content category label IDs excluded in this config. 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. - `includedEnvironments` string[] — 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. - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'SUSPENDED' — Output only. The state of this pretargeting config. - `maximumQps` string, int64 — The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide - `displayName` string — The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. - `includedCreativeDimensions` CreativeDimensions[] — Creative dimensions included by this config. 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. - `width` string, int64 — The width of the creative in pixels. - `height` string, int64 — The height of the creative in pixels. - `interstitialTargeting` 'INTERSTITIAL_TARGETING_UNSPECIFIED' | 'ONLY_INTERSTITIAL_REQUESTS' | 'ONLY_NON_INTERSTITIAL_REQUESTS' — The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. - `userListTargeting` 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. - `includedIds` string[] — The IDs included in a config. - `excludedIds` string[] — The IDs excluded in a config. - `includedLanguages` string[] — The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. - `minimumViewabilityDecile` integer — The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config 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. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/realtimebidding.md) · [All operations](https://skmtc.net/google/apis/realtimebidding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/realtimebidding/versions/da99d215fb25/schema)