GAM setup with key values
Key-values
Pubstack adds prefixes to most key values to make them easier to understand. The following prefixes are commonly used:
- The
ad_
prefix to describe ad unit properties - The
bid_
prefix to describe header bidding opportunities - The
xp_
prefix to describe all A/B test properties
Pubstack creates the key values listed below. Since Google has limitations on the number of custom dimensions and values, Pubstack creates key values as "reportable". To use a specific key values as a custom dimension, the publisher must manually convert it with the assistance of a Pubstack account manager.
Key-Values | Usage | Value examples | Value type | Type of KV |
---|---|---|---|---|
adm | True if the ad request is managed by Pubstack, use for the reporting and billing | ‘1’ | dynamic | reportable |
adm_ab_test | Used for Poc A/B tests only - test populations of Poc-Override A/B tests | 'poc:A, poc:B' | predefined | custom dim |
adm_stack | Used for stack reporting and stack A/B test reporting | 'stackID_stackversion' | dynamic | reportable |
ad_index | The rank of the ad unit when the ad unit is present several on a page - used with dynamic ad units | '1,2,3 … 50' | predefined | reportable |
ad_refresh-rank | 1 means the second auction for the slot and so on, the key is not present on the 1st auction | '1,2,3 … 10' | predefined | reportable |
ad_floor-rule | Key uses for enabling a specific UPR, the value is computed dynamically by Pubstack | ‘0.05’, 0.10...6.00’ | predefined | reportable |
ad_fluidstyle | Values are "rectangle" | "banner". Used to determine which fluidstyle must serve. |
'banner', 'rectangle' |
predefined | reportable |
ad_safeframe | (beta) True means the Prebid bid will be served a safeframe, the key not present otherwise | ‘1’ | predefined | off |
ad_adunitname | (optional) Name of the ad unit name when we need to use it | dynamic | reportable | |
bid_nobid | true if no Prebid bid, use for debugging purpose, not present otherwise | ‘1’ | predefined | reportable |
bid_mediatype | Mediatype of the Prebid bid (alias of hb_format) | ‘banner’, ‘outstream’, ‘native’ | predefined | reportable |
bid_cpm | Prebid winning bid CPM, (alias of hb_pb) | ‘0.20’, ‘0.15’, ‘3.10’, … | predefined | reportable |
bid_bidder | Prebid bidder name (alias of hb_bidder) | ‘appnexus’, ‘improve’ | dynamic | reportable |
bid_id | Prebid creative and bid Id (alias of hb_adid) | ‘ad35e76’, ‘7e5413i’, … | dynamic | off |
bid_size | Prebid creative size (alias of hb_size) | '300x250, 300x600...' | predefined | reportable |
no_cmp | Only used if traffic outside EU - true if gdprApplies = false. Can be used for reporting purposes. | 'true' | predefined | reportable |
pbstck_ab_test | Used for analytics A/B tests only - test populations of Analytics A/B tests | predefined | reportable | |
pbstck_refresh | True if the ad request is not the 1st request, the key not present otherwise | '1' | predefined | custom dim |
xp_variant | (beta) Name of the variant for a specific ab test (source from the related meta ) |
'floor_optimization:true...' | dynamic | custom dim |
We choose to add a targeting: “ad_index” with a value of all the numbers found in the suffix of the divId. For example for a dyninfeed-1 we send 1 for dyninfeed_13 we send 13.
If no value is set for instance "dyninfeed", ad_index=""
Ex : css:[id^="nfb_2"], [id^="dfp_nfb_2"]
as "dynamic adunit"
If div id = dfp_nfb_3 it will not be targeted. However, it will target adunits starting with nfb_2
& dfp_nfb_2
. Will also work for dfp_nfb_23
Orders, Line Items, and creatives
Pubstack creates two orders to run the Prebid stack with 450 line items. The Prebid Bid Granularity is managed by Pubstack, so publishers don't need to worry about it. We double it for instream line-items.
Pubstack does not split the orders by Prebid Bidders, but publishers still have the ability to report revenue by Prebid bidder using the key values "bid_bidder"
The orders and their line items are used interchangeably for the banner, out-stream, and native media types. The line items are used to implement the granularity chosen by Pubstack.
Pubstack uses only two sizes (3x1 and out-of-page) to allow the line items to compete in the dynamic allocation and unified auction of Google Ad Manager.
- The size "3x1" is a generic size allowing the line items to compete whatever is the real size of the Prebid bid. Using this specific size allows more robustness and agility for customizing the sizes of your ad units and stacks. Go to further, please refer to Why Pubstack Uses 3x1 Size for Prebid?
- The size “out-of-page” is a special of GAM, used mostly for the interstitial format. To enable Prebid on the out-of-page slots, the line items required this second size in their definition.
By default, the line items target the inventory “Run-of-network”, meaning that they are enabled on the whole publisher’s inventory and the corresponding Prebid price bucket.
Finally, and as it’s recommended by Prebid, Pubstack creates a set of 12 creatives to finish the Prebid setup in GAM.