Key-values can be used to target ads more granularly than ad units. Learn more about key-values.
For each ad request, you may pass one or more keys, each with one or more
associated values. These key-values will be evaluated against targeting options
configured at the line item-level in Ad Manager. For example, if
you pass a custom key-value of age=18-34, line items targeted to the age range
18-34 will be eligible to serve, assuming all other criteria matches.
Set targeting
You may specify key-values to configure targeting at both the slot- and page-level based on your network’s needs.
- Slot-level
Allows you to set key-values for individual ad slots on your page.
Slot-level targeting allows you to configure targeting on a per-slot basis. This is useful in cases where individual slots on the same page require different targeting, but can be inefficient in situations where the same key-values are applied to all slots. Use Slot.setTargeting() to utilize slot-level targeting, as in the following example.
- Page-level
Allows you to set key-values across all ad slots on your page.
Page-level targeting ensures that all ad slots have the same set of key-values. In some cases this may reduce the total amount of code needed to configure targeting. Use googletag.pubads().setTargeting() to utilize page-level targeting, as in the following example.
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="Use key-value targeting to control the ads eligible to serve to specific ad slots."
/>
<title>Key-value targeting</title>
<script
async
src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"
crossorigin="anonymous"
></script>
<script>
window.googletag = window.googletag || { cmd: [] };
// GPT slots
let adSlots = [];
googletag.cmd.push(() => {
// Configure slot-level targeting.
adSlots[0] = googletag
.defineSlot("/6355419/Travel/Asia", [728, 90], "banner-ad-1")
.addService(googletag.pubads())
.setTargeting("color", "red")
.setTargeting("position", "atf");
adSlots[1] = googletag
.defineSlot("/6355419/Travel/Asia", [728, 90], "banner-ad-2")
.addService(googletag.pubads())
.setTargeting("position", "btf");
// Configure page-level targeting.
googletag.pubads().setTargeting("interests", "basketball");
// Enable SRA and services.
googletag.pubads().enableSingleRequest();
googletag.enableServices();
});
</script>
</head>
In this example, two ad slots are defined which specify ad unit
/6355419/Travel/Asia and ad size 728x90. Then key-value targeting is
applied to further restrict and differentiate the ads which may serve in each
slot.
When both slot- and page-level targeting are used, the key-values are combined and only ads satisfying all criteria will be eligible to serve to a given slot. In this example, the effective tageting for each slot is:
| Ad slot | Effective targeting |
|---|---|
| 1 | color=red AND position=atf AND interests=basketball |
| 2 | position=btf AND interests=basketball |
Target multiple keys or values
In the preceding example, a combination of slot- and page-level targeting was used to define multiple targeting keys for a single ad slot. Here are some alternative approaches to achieve the same effective targeting:
Slot-level targeting only
In this example, shared key-values are repeated for each ad slot.
// Slot-level targeting with multiple keys.
adSlots[0] = googletag
.defineSlot('/6355419/Travel/Asia', [728, 90], 'banner-ad-1')
.addService(googletag.pubads())
.setTargeting('color', 'red')
.setTargeting('position', 'atf')
.setTargeting('interests', 'basketball');
adSlots[1] = googletag
.defineSlot('/6355419/Travel/Asia', [728, 90], 'banner-ad-2')
.addService(googletag.pubads())
.setTargeting('position', 'btf')
.setTargeting('interests', 'basketball');
Page-level default targeting
In this example, default targeting is set at the page-level and overridden at the slot-level as necessary.
// Page-level default targeting.
googletag.pubads().setTargeting('interests', 'basketball')
.setTargeting('position', 'btf');
// Slot-level targeting overrides.
adSlots[0] = googletag
.defineSlot('/6355419/Travel/Asia', [728, 90], 'banner-ad-1')
.addService(googletag.pubads())
.setTargeting('color', 'red')
.setTargeting('position', 'atf');
adSlots[1] = googletag
.defineSlot('/6355419/Travel/Asia', [728, 90], 'banner-ad-2')
.addService(googletag.pubads());
It's also possible to target multiple values for a single key by providing an
array of values when calling setTargeting():
// Page-level targeting with multiple values for a single key.
googletag.pubads().setTargeting('interests', ['baseball', 'basketball']);
Clear targeting
Once targeting has been set, the configured key-values will be sent with every
ad request for the life of the ad slot. In some circumstances, however, it may
be desirable for targeting to change over time. While setTargeting() can be
used to add and overwrite key-values, it's not possible to remove them this way.
To accomplish that, Slot.clearTargeting() or
googletag.pubads().clearTargeting() must be
used instead.
// Step 0, define slot- and page-level targeting.
adSlots[0] = googletag
.defineSlot("/6355419/Travel/Asia", [728, 90], "banner-ad-1")
.addService(googletag.pubads())
.setTargeting("color", "red")
.setTargeting("position", "atf");
googletag.pubads().setTargeting("interests", "basketball");
// Step 1, clear slot-level color targeting.
adSlots[0].clearTargeting("color");
// Step 2, clear all page-level targeting.
googletag.pubads().clearTargeting();
When clearTargeting() is called with a specific key (either at the
slot- or page- level), only that key is removed. When no key is specified, all
targeting at that level is removed.
In the preceding example, the effective targeting for the ad slot after each step is:
| Step | Effective targeting |
|---|---|
| 0 | color=red AND position=atf AND interests=basketball |
| 1 | position=atf AND interests=basketball |
| 2 | position=atf |