Pretargeting configurations
Stay organized with collections
Save and categorize content based on your preferences.
Bidders can use the pretargetingConfigs
resource to receive only bid
requests for impressions that match their targeting criteria.You can have up to
10 pretargeting configurations at once.
Each pretargeting configuration distributes bid requests across all endpoints.
Bid requests aren't always distributed evenly across all endpoints. For example,
a pretargeting configuration for specific geographic IDs in a given region might
have fewer matches in trading
locations that are farther
from that region. Endpoints near those farther trading locations might receive
fewer bid requests.
Best practices
In order to receive bid requests, you must create at least one
pretargeting configuration. Here are some tips for managing your pretargeting
configurations:
- Scope
Pretargeting is like filtering. You should use pretargeting criteria to filter
bid requests to those that are relevant to your use case. If you don't set any
pretargeting criteria, you can receive bid requests for all impressions.
If you aren't receiving enough bid requests related to a given pretargeting
configuration, you might want to broaden your pretargeting criteria.
- Logic
Values in top-level targeting fields are processed with logical OR
. This
means you can receive bid requests that have at least one of the values you
specify in the top-level field. For example, if your pretargeting
configuration has languageCodes
values en
, de
, and sv
, you might receive
bid requests with en
, de
, or sv
as the detected language.
Different fields are processed with logical AND
. You only receive bid
requests that have a match for at least one value in every pretargeting field
you set. For example, if your configuration has languageCodes
values en
,
de
, and sv
, and includedPlatforms
value PERSONAL_COMPUTER
, you receive
only bid requests that have a detected language of en
, de
, or sv
and a
device type of PERSONAL_COMPUTER
.
Due to the logical AND
across pretargeting fields, you can't include
contradictory criteria. For example, including the same value in includedIds
and excludedIds
in a NumericTargetingDimensions
criteria results in an
error.
- Overlap
Bid requests can be eligible for multiple pretargeting configurations.
You can create up to 10 pretargeting configurations to target different
kinds of inventory. Pretargeting configurations can overlap, so a single bid
request might be eligible for multiple pretargeting configurations. In this
case, the bid request’s billing_id
field contains the billingId
of
each applicable configuration. If multiple billing IDs are found in the bid
request, you must specify which billing ID you're bidding on in the bid
response’s billing_id
field.
Geographic IDs
Some geographic IDs aren't targetable for policy reasons. For example, some
regions with small populations can't be targeted because it would violate our
privacy policy. Our policies are subject to change. If you specify
a geographic ID in your pretargeting configuration’s geoTargeting
that becomes
invalid at a later date, the ID appears under the invalidGeoIds
field at that
time. Geographic IDs under invalidGeoIds
have no impact on targeting. If a
goegraphic ID in invalidGeoIds
becomes valid, it's added to your pretargeting
configuration's geoTargeting
field.
The
geo-table.csv
file lists targetable geographic IDs, and is updated periodically as IDs are
added and removed.
Bid request count
You should configure the maximum QPS for your bidder endpoints,
and allow the Callout Quota System
to manage the traffic sent to your endpoints for each of your pretargeting
configurations.
Here are edge cases where managing maximum QPS at the
pretargeting configuration level with maximumQps
might be useful:
- Receiving too many requests
- If the Callout Quota System is sending an unusually large number of bid
requests to bidder endpoints for a given pretargeting configuration, you can
use
maximumQps
to manually adjust the number of requests.
- Testing a configuration for new inventory
- If you're trying to support new inventory, like a new creative format,
you can implement a pretargeting configuration targeting only that inventory
with a low
maximumQps
.
For inventory that's targeted by multiple pretargeting configurations,
bid requests are sent to the bidder's endpoints, including the billingId
for each configuration, as long as at least one of the configurations hasn't
reached its maximumQps
limit.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eUse pretargeting configurations to filter bid requests and receive only relevant impressions, with the ability to create up to 10 configurations.\u003c/p\u003e\n"],["\u003cp\u003ePretargeting criteria use logical \u003ccode\u003eOR\u003c/code\u003e within fields and logical \u003ccode\u003eAND\u003c/code\u003e across fields, allowing for flexible but specific targeting.\u003c/p\u003e\n"],["\u003cp\u003eBid requests can match multiple pretargeting configurations, requiring bidders to specify the desired billing ID in their bid response.\u003c/p\u003e\n"],["\u003cp\u003eSome geographic IDs may be untargetable for policy reasons, and the \u003ccode\u003egeo-table.csv\u003c/code\u003e file provides a list of valid targetable IDs.\u003c/p\u003e\n"],["\u003cp\u003eManage bid request traffic using the Callout Quota System and \u003ccode\u003emaximumQps\u003c/code\u003e for specific pretargeting configurations when necessary.\u003c/p\u003e\n"]]],["Bidders use `pretargetingConfigs` to filter bid requests, receiving only those matching their criteria; up to 10 configurations are allowed. These configurations filter requests using logical `OR` within fields and logical `AND` across fields. Bid requests can match multiple configurations, identified by `billingId` in the request. Geographic targeting may have restrictions and invalid IDs are listed under `invalidGeoIds`. You can set `maximumQps` per configuration to manage traffic volume. At least one configuration is required to receive bid requests.\n"],null,["# Pretargeting configurations\n\nBidders can use the `pretargetingConfigs` resource to receive only bid\nrequests for impressions that match their targeting criteria.You can have up to\n10 pretargeting configurations at once.\n\nEach pretargeting configuration distributes bid requests across all endpoints.\nBid requests aren't always distributed evenly across all endpoints. For example,\na pretargeting configuration for specific geographic IDs in a given region might\nhave fewer matches in [trading\nlocations](/authorized-buyers/rtb/peer-guide#trading-locations) that are farther\nfrom that region. Endpoints near those farther trading locations might receive\nfewer bid requests.\n\nBest practices\n--------------\n\nIn order to receive bid requests, you must create at least one\npretargeting configuration. Here are some tips for managing your pretargeting\nconfigurations:\n\nScope\n\n: Pretargeting is like filtering. You should use pretargeting criteria to filter\n bid requests to those that are relevant to your use case. If you don't set any\n pretargeting criteria, you can receive bid requests for all impressions.\n\n If you aren't receiving enough bid requests related to a given pretargeting\n configuration, you might want to broaden your pretargeting criteria.\n\nLogic\n\n: Values in top-level targeting fields are processed with logical `OR`. This\n means you can receive bid requests that have at least one of the values you\n specify in the top-level field. For example, if your pretargeting\n configuration has `languageCodes` values `en`, `de`, and `sv`, you might receive\n bid requests with `en`, `de`, or `sv` as the detected language.\n\n Different fields are processed with logical `AND`. You only receive bid\n requests that have a match for at least one value in every pretargeting field\n you set. For example, if your configuration has `languageCodes` values `en`,\n `de`, and `sv`, and `includedPlatforms` value `PERSONAL_COMPUTER`, you receive\n only bid requests that have a detected language of `en`, `de`, or `sv` and a\n device type of `PERSONAL_COMPUTER`.\n\n Due to the logical `AND` across pretargeting fields, you can't include\n contradictory criteria. For example, including the same value in `includedIds`\n and `excludedIds` in a `NumericTargetingDimensions` criteria results in an\n error.\n\nOverlap\n\n: Bid requests can be eligible for multiple pretargeting configurations.\n\n You can create up to 10 pretargeting configurations to target different\n kinds of inventory. Pretargeting configurations can overlap, so a single bid\n request might be eligible for multiple pretargeting configurations. In this\n case, the bid request's `billing_id` field contains the `billingId` of\n each applicable configuration. If multiple billing IDs are found in the bid\n request, you must specify which billing ID you're bidding on in the bid\n response's `billing_id` field.\n\nGeographic IDs\n--------------\n\nSome geographic IDs aren't targetable for policy reasons. For example, some\nregions with small populations can't be targeted because it would violate our\nprivacy policy. Our policies are subject to change. If you specify\na geographic ID in your pretargeting configuration's `geoTargeting` that becomes\ninvalid at a later date, the ID appears under the `invalidGeoIds` field at that\ntime. Geographic IDs under `invalidGeoIds` have no impact on targeting. If a\ngoegraphic ID in `invalidGeoIds` becomes valid, it's added to your pretargeting\nconfiguration's `geoTargeting` field.\n\nThe\n[geo-table.csv](//storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile lists targetable geographic IDs, and is updated periodically as IDs are\nadded and removed.\n\nBid request count\n-----------------\n\nYou should configure the maximum QPS for your bidder endpoints,\nand allow the [Callout Quota System](/authorized-buyers/rtb/callout-quota-system)\nto manage the traffic sent to your endpoints for each of your pretargeting\nconfigurations.\n\nHere are edge cases where managing maximum QPS at the\npretargeting configuration level with `maximumQps` might be useful:\n\nReceiving too many requests\n: If the Callout Quota System is sending an unusually large number of bid\n requests to bidder endpoints for a given pretargeting configuration, you can\n use `maximumQps` to manually adjust the number of requests.\n\nTesting a configuration for new inventory\n: If you're trying to support new inventory, like a new creative format,\n you can implement a pretargeting configuration targeting only that inventory\n with a low `maximumQps`.\n\nFor inventory that's targeted by multiple pretargeting configurations,\nbid requests are sent to the bidder's endpoints, including the `billingId`\nfor each configuration, as long as at least one of the configurations hasn't\nreached its `maximumQps` limit."]]