Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/mobile/gam-native-adops.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1><a target="_blank" href="hb_native_linkurl" class="pb-click">hb_native_title
<div class="attribution">hb_native_brand</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/native-trk.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/native-trk.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.uuid = "%%PATTERN:hb_cache_id%%";
Expand Down
5 changes: 4 additions & 1 deletion adops/adops-general-sbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ If your ad server supports targeting creatives within the line item, it could co

You’ve now added all fields required for targeting Prebid line items. You can add any other line item options you would normally use, such as additional targeting for geography. When you’ve filled in all the appropriate fields, save your line item.

<a id="create-creatives" ></a>

## Create Your Creatives

The process of creating your creatives will differ based on the type of creative.
Expand All @@ -131,7 +133,7 @@ We recommend using the [Prebid Universal Creative](/overview/prebid-universal-cr
If you’re working with banner or in-renderer creatives, the HTML you’ll enter in the creatives will be similar to the following (utilizing whatever macro format is supported by your ad server):

```html
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN:hb_format%%.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/%%PATTERN:hb_format%%.js"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = "";
Expand All @@ -157,6 +159,7 @@ If you’re working with banner or in-renderer creatives, the HTML you’ll ente
* Replace `%%MACRO%%` with the appropriate macro for your ad server. (Refer to your ad server’s documentation or consult with a representative for specific details regarding the proper macros and how to use them.)
* Replace BIDDERCODE with the appropriate code for the bidder your line item is targeting. For example, if you’re targeting BidderA, the macro variable for adId might look like `ucTagData.adId = "%%PATTERN:hb_adid_BidderA%%";`.
* If you're hosting your own Prebid Universal Creative, make sure it's version 1.15 or later, or replace `%%PATTERN:hb_format%%.js` with `creative.js`.
* The `hb_ver` targeting key, used above to construct the Prebid Universal Creative CDN URL, requires Prebid.js 10.11.0 or later. If that's not available, substitute `%%PATTERN:hb_ver%%` with a particular PUC version.

The example above uses the jsdelvr CDN as the domain from which the creative will serve. However, you may obtain the creative from a managed service or host it yourself. You might need to edit the creative and make adjustments to your creative settings depending on the CDN you're using.

Expand Down
6 changes: 3 additions & 3 deletions adops/creative-considerations.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ the actual PUC.

If you choose to use the Prebid Universal Creative, you'll need to decide where to load it from:

1. Prebid hosts an always-up-to-date copy of the PUC code at `https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/*`. The upside of this location is that it's automatically updated so it contains new features automatically. The potential downside is that Prebid controls when it's upgrades.
1. You can host the PUC at your own location. The upside of this option is that you can control when upgrades happen.
1. Prebid hosts each PUC version at `https://cdn.jsdelivr.net/npm/prebid-universal-creative@${VERSION}/dist/*` - substitute `${VERSION}` with a version number. Using Prebid.js 10.11.0 or later, you may also use the `hb_ver` targeting key; see [create your creatives](/adops/adops-general-sbs.html#create-your-creatives).
1. You can host the PUC at your own location. The upside of this option is more control over when upgrades happen.
1. You can copy the body of the PUC into your ad server creative directly. This eliminates a browser fetch, but could make upgrades more difficult.

### Prebid.js 'dynamic creatives'
Expand Down Expand Up @@ -115,7 +115,7 @@ VAST URL required. See the [GAM Prebid Mobile Rendering Ad Ops](/adops/mobile-re
{: .table .table-bordered }
| :memo: Use Cases |
|:---------------------------|
| - Prbeid.js Native |
| - Prebid.js Native |

Native ads require close collaboration between web designers, engineering, and ad ops. The primary decision to be made that affects ad ops is where to store the rendering template. The options are:

Expand Down
18 changes: 14 additions & 4 deletions adops/gam-creative-banner-sbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,18 @@ These instructions assume you're using the Prebid Universal Creative (PUC) after
{: .alert.alert-warning :}
Be sure to replace BIDDERCODE with the appropriate bidder. For example, if the bidder code is `PBbidder`, the `adid` would be `%%PATTERN:hb_adid_PBbidder%%`.

Also, replace "PUCFILE" with:
Replace "PUCFILE" with:

- Prebid.js: "%%PATTERN:hb_format%%.js"
- Prebid Mobile: "creative.js"

Replace "VERSION" with:

- Prebid.js 10.11.0 or later: "%%PATTERN:hb_ver%%"
- Otherwise, a specific PUC version.

```html
<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/PUCFILE"></script>
<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@VERSION/dist/PUCFILE"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = "";
Expand Down Expand Up @@ -99,13 +104,18 @@ Warning: Be sure none of the attribute names are longer than 20 characters. See

In top-price mode, you can make use of the GAM `TARGETINGMAP` feature instead of listing out each attribute.

Be sure to replace "PUCFILE" with:
Replace "PUCFILE" with:

- Prebid.js: "%%PATTERN:hb_format%%.js"
- Prebid Mobile: "creative.js"

Replace "VERSION" with:

- Prebid.js 10.11.0 or later: "%%PATTERN:hb_ver%%"
- Otherwise, a specific PUC version.

```html
<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/PUCFILE"></script>
<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@VERSION/dist/PUCFILE"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = "";
Expand Down
2 changes: 1 addition & 1 deletion adops/gam-native.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Example creative HTML:
<div class="attribution">##hb_native_brand##</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN:hb_format%%.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/%%PATTERN:hb_format%%.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%";
Expand Down
2 changes: 1 addition & 1 deletion adops/setting-up-prebid-with-the-appnexus-ad-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Follow the banner creative setup instructions in [Add Creatives](https://docs.xa
* Self-Audit the creative and confirm compliance.

```html
<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/#{HB_FORMAT}.js"></script>
<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@#{HB_VER}/dist/#{HB_FORMAT}.js"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = window.location.host;
Expand Down
26 changes: 26 additions & 0 deletions dev-docs/publisher-api-reference/setConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -713,6 +713,7 @@ The `targetingControls` object passed to `pbjs.setConfig` provides some options
| allBidsCustomTargeting | Boolean | Set to true to prevent custom targeting values from being set for non-winning bids |
| lock | Array of Strings | Targeting keys to lock |
| lockTimeout | Integer | Lock timeout in milliseconds |
| version | String | Value to set in the `hb_ver` targeting key |

{: .alert.alert-info :}
Note that this feature overlaps and can be used in conjunction with [sendBidsControl.bidLimit](#setConfig-Send-Bids-Control).
Expand Down Expand Up @@ -937,6 +938,31 @@ If using standard targeting `hb_adid` is unique for each bid, so this would have

<a name="setConfig-Configure-Responsive-Ads"></a>

#### Details on the version setting
{: .no_toc }

Since version 10.11.0, Prebid populates the `hb_ver` targeting key with a recommended version of Prebid Universal Creative. This should be used in ad server creatives to fetch that particular version of PUC (see for example [general prebid ad server setup](/adops/adops-general-sbs.html#create-creatives)).

You may set a different value for `hb_ver` using `version`:

```javascript
pbjs.setConfig({
targetingControls: {
version: '1.17.2'
}
})
```

Or disable it by setting `false`: {

```javascript
pbjs.setConfig({
targetingControls: {
version: false
}
})
```

### Configure Responsive Ads

See the [size mapping](/dev-docs/modules/sizeMapping.html) or [advanced size mapping](/dev-docs/modules/sizeMappingV2.html) modules.
Expand Down
4 changes: 3 additions & 1 deletion overview/prebid-universal-creative.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ Note that as of PUC v1.15, the recommended way of loading the creative
in the ad server involves using the `hb_format` ad server key-value. Before 1.15, the ad server needed to load creative.js which covered banner and in-renderer video, or native-render.js for native. 1.15 simplifies this
by allowing the ad server creative to load banner.js, video.js, or native.js, which can be done programmatically using ad server macros. e.g.

Since version 10.11.0, Prebid.js populates the `hb_ver` ad server key-value which is recommended for selecting a specific PUC version.

```html
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN:hb_format%%.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/%%PATTERN:hb_format%%.js"></script>
```

This loads the PUC from the Prebid-maintained location. Your managed
Expand Down
6 changes: 3 additions & 3 deletions prebid/native-implementation-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ Example creative HTML:
<div class="attribution">##hb_native_brand##</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/native-render.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/native-render.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%"; // GAM specific
Expand Down Expand Up @@ -335,7 +335,7 @@ Even though the body of the native creative is defined in the AdUnit, an AdServe
Example Creative HTML

```html
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/native-render.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/native-render.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%"; // GAM specific
Expand Down Expand Up @@ -399,7 +399,7 @@ Even though the body of the native creative is defined in the external JavaScrip
Example creative HTML:

```html
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/native-render.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/native-render.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%"; // GAM specific
Expand Down
6 changes: 3 additions & 3 deletions prebid/native-implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ Example creative HTML:
<div class="attribution">##hb_native_asset_id_3##</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN:hb_format%%.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist/%%PATTERN:hb_format%%.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%"; // GAM specific
Expand Down Expand Up @@ -436,7 +436,7 @@ Even though the body of the native creative is defined in the AdUnit, an AdServe
Example Creative HTML

```html
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist//%%PATTERN:hb_format%%.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist//%%PATTERN:hb_format%%.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%"; // GAM specific
Expand Down Expand Up @@ -526,7 +526,7 @@ Even though the body of the native creative is defined in the external JavaScrip
Example creative HTML:

```html
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist//%%PATTERN:hb_format%%.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@%%PATTERN:hb_ver%%/dist//%%PATTERN:hb_format%%.js"></script>
<script>
var pbNativeTagData = {};
pbNativeTagData.pubUrl = "%%PATTERN:url%%"; // GAM specific
Expand Down