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
10 changes: 5 additions & 5 deletions adops/setting-up-prebid-video-in-dfp.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For complete instructions on setting up Prebid line items in Google Ad Manager,
{: .alert.alert-info :}
For engineering setup instructions, see [Show Video Ads with a Google Ad Manager Video Tag](/dev-docs/show-video-with-a-dfp-video-tag.html).

Each VAST creative contains a URL that points to the cached VAST XML. (This is because most video players can only work with a URL that returns VAST XML.) When setting up video creatives, it's important to understand where the VAST XML is stored for each of your bidders. The most common place to store VAST XML is the AppNexus cache, but some bidders (such as RubiconProject and SpotX) use their own cache services. To support such bidders, see [Multiple Cache Locations](#multiple-cache-locations) below.
Each VAST creative contains a URL that points to the cached VAST XML. (This is because most video players can only work with a URL that returns VAST XML.) When setting up video creatives, it's important to understand where the VAST XML is stored for each of your bidders. Prebid.js supports server-side, client-side, and local caching as outlined in [pbjs.setConfig documentation](/dev-docs/publisher-api-reference/setConfig.html#client-side-caching-of-vast-xml). See [Multiple Cache Locations](#multiple-cache-locations) below for details on bidder-specific cache locations.

## Single Cache Location

Expand All @@ -55,15 +55,15 @@ Google Ad Manager will show you a warning stating that fetching VAST from the cr

If you’re using a Send Top Price Bid configuration, then the VAST URL will be the same for each bidder:

`https://prebid.adnxs.com/pbc/v1/cache?uuid=%%PATTERN:hb_uuid%%`
`https://my-pbs.example.com/cache?uuid=%%PATTERN:hb_uuid%%`

or

`[other bidder cache location]`

If you’re using Send All Bids, the VAST URL will include the bidder-specific targeting variable. Be sure to replace `BIDDERCODE` with the actual bidder code for your bidders:

`https://prebid.adnxs.com/pbc/v1/cache?uuid=%%PATTERN:hb_uuid_BIDDERCODE%%`
`https://my-pbs.example.com/cache?uuid=%%PATTERN:hb_uuid_BIDDERCODE%%`

or

Expand All @@ -73,11 +73,11 @@ or

If your creative is for long-form (OTT) video, you must include a prefix in your VAST URL. For example (Send Top Price Bid):

`https://prebid.adnxs.com/pbc/v1/cache?uuid=50.00_news_30s_%%PATTERN:hb_cache_id%%`
`https://my-pbs.example.com/cache?uuid=50.00_news_30s_%%PATTERN:hb_cache_id%%`

or (Send All Bids):

`https://prebid.adnxs.com/pbc/v1/cache?uuid=50.00_news_30s_%%PATTERN:hb_cache_id_BIDDERCODE%%`
`https://my-pbs.example.com/cache?uuid=50.00_news_30s_%%PATTERN:hb_cache_id_BIDDERCODE%%`

In these examples, the `uuid` is set to the value of the `hb_pb_cat_dur` key you target in your line item. This value consists of the price bucket, label (for competitive exculsions), and video duration. In this example we've specified a price bucket of `50.00`, a label of `news`, and a duration of `30s`. See [GAM with Prebid Step by Step](/adops/step-by-step.html#targeting) for more information.

Expand Down
2 changes: 1 addition & 1 deletion dev-docs/examples/instream-banner-mix.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ pbjs.que.push(function() {
pbjs.setConfig({
debug: true,
cache: {
url: '<https://prebid.adnxs.com/pbc/v1/cache>'
url: '<https://my-pbs.example.com/cache>'
}
});
pbjs.requestBids({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ pbjs.que.push(function(){
pbjs.addAdUnits(videoAdUnit);
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
url: 'https://my-pbs.example.com/cache'
},
adpod: {
brandCategoryExclusion: true
Expand Down
8 changes: 4 additions & 4 deletions dev-docs/publisher-api-reference/setConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -1082,7 +1082,7 @@ Here's an example of basic client-side caching. Substitute your Prebid Cache URL
```javascript
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
url: 'https://my-pbs.example.com/cache'
}
});
```
Expand Down Expand Up @@ -1127,7 +1127,7 @@ Optionally, `batchSize` and `batchTimeout` can be utlilized as illustrated with
```javascript
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache',
url: 'https://my-pbs.example.com/cache',
batchSize: 4,
batchTimeout: 50
}
Expand All @@ -1151,7 +1151,7 @@ Consider the following Prebid configuration:
```javascript
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache',
url: 'https://my-pbs.example.com/cache',
useLocal: true
}
});
Expand All @@ -1160,7 +1160,7 @@ pbjs.setConfig({
When `useLocal` is set to true, the remote cache URL endpoint is never called. However, existing GAM creatives configured with a VAST ad tag URL, such as:

``
https://prebid.adnxs.com/pbc/v1/cache?uuid=%%PATTERN:hb_uuid%%
https://my-pbs.example.com/cache?uuid=%%PATTERN:hb_uuid%%
``

will continue to function correctly. `hb_uuid` is set to locally assigned blob UUID. If the bid wins the GAM auction and it's `videoCacheKey` (`hb_uuid`) is included in a GAM wrapper VAST XML, Prebid will update the VAST ad tag URL with the locally cached blob URL after receiving a response from Google Ad Manager.
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/show-long-form-video-with-gam.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ pbjs.que.push(function(){
pbjs.addAdUnits(videoAdUnit);
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
url: 'https://my-pbs.example.com/cache'
},
adpod: {
brandCategoryExclusion: true
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/show-video-with-a-dfp-video-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ pbjs.que.push(function() {
pbjs.setConfig({
/* Or whatever your preferred video cache URL is */
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
url: 'https://my-pbs.example.com/cache'
}
});

Expand Down
Binary file modified prebid-mobile/docs/Prebid_Mobile_3_0_0.pdf
Binary file not shown.
22 changes: 14 additions & 8 deletions prebid-server/features/pbs-caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,26 +49,32 @@ You can watch the caching take place with your browser developer tools.
From one of the [video instream examples](/examples/video/instream/jwplayer/pb-ve-jwplayer-platform.html):

The VAST XML is stored into Prebid Cache from Prebid.js with this call:
```
POST https://prebid.adnxs.com/pbc/v1/cache

```http
POST https://my-pbs.example.com/cache
<VAST XML BODY>
```

And the response from the /cache call is:
```

```json
{"responses":[{"uuid":"9b05c38c-709c-4fb5-8592-8fcacb1289f7"}]}
```

And when the video player is ready to display the video ad, this
call is seen go out:

```http
GET https://my-pbs.example.com/cache?uuid=9b05c38c-709c-4fb5-8592-8fcacb1289f7
```
GET https://prebid.adnxs.com/pbc/v1/cache?uuid=9b05c38c-709c-4fb5-8592-8fcacb1289f7
```

And the response is the VAST XML.

### AMP

Here's an example AMP response from Prebid Server:
```

```json
{
"targeting": {
"hb_cache_id": "14b468d0-3c58-4a5d-ae5d-ab9a47b6152c",
Expand All @@ -84,7 +90,7 @@ Here's an example AMP response from Prebid Server:
```

Then when the ad is chosen by the ad server, this fetch goes out from the browser:
```

```http
https://prebid-server.example.com/cache?uuid=14b468d0-3c58-4a5d-ae5d-ab9a47b6152c
```

2 changes: 1 addition & 1 deletion prebid-video/video-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ If you’re using another ad server:
Follow the instructions for your ad server to create line items for the in-player integration. The primary points to keep in mind as you set up your line items include:

- Line items must target Prebid key-values.
- The VAST creative URL must be in the format `https://prebid.adnxs.com/pbc/v1/cache?uuid={hb_cache_id}`, where `{hb_cache_id}` is the value passed to the ad server from Prebid.js.
- The VAST creative URL must be in the format `https://my-pbs.example.com/cache?uuid={hb_cache_id}`, where `{hb_cache_id}` is the value passed to the ad server from Prebid.js.

#### In-renderer Integration

Expand Down
2 changes: 1 addition & 1 deletion prebid-video/video-integrating-solo.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Configuring the video cache is done with [`setConfig`](/dev-docs/publisher-api-r
```javascript
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
url: 'https://my-pbs.example.com/cache'
/* Or whatever your preferred video cache URL is */
}
});
Expand Down
2 changes: 1 addition & 1 deletion tools/line-item-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ creative: # at least one of the following types is required {video, banner}
sizes: # list
- height: 480
width: 640
vast_xml_url: "https://prebid.adnxs.com/pbc/v1/cache?uuid=%%PATTERN:{{ hb_cache_id }}%%"
vast_xml_url: "https://my-pbs.example.com/cache?uuid=%%PATTERN:{{ hb_cache_id }}%%"
```

#### Order setup
Expand Down