Skip to content

Commit d4a4272

Browse files
authored
AppNexus Prebid Cache Deprecation (prebid#6170)
* apn-cache-deprecation * corrected-fenced-code-language * removed-blank-line * added-trailing-newline
1 parent 799e30a commit d4a4272

File tree

11 files changed

+30
-24
lines changed

11 files changed

+30
-24
lines changed

adops/setting-up-prebid-video-in-dfp.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For complete instructions on setting up Prebid line items in Google Ad Manager,
2929
{: .alert.alert-info :}
3030
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).
3131

32-
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.
32+
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.
3333

3434
## Single Cache Location
3535

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

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

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

6060
or
6161

6262
`[other bidder cache location]`
6363

6464
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:
6565

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

6868
or
6969

@@ -73,11 +73,11 @@ or
7373

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

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

7878
or (Send All Bids):
7979

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

8282
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.
8383

dev-docs/examples/instream-banner-mix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ pbjs.que.push(function() {
154154
pbjs.setConfig({
155155
debug: true,
156156
cache: {
157-
url: '<https://prebid.adnxs.com/pbc/v1/cache>'
157+
url: '<https://my-pbs.example.com/cache>'
158158
}
159159
});
160160
pbjs.requestBids({

dev-docs/publisher-api-reference/adServers.dfp.buildAdpodVideoUrl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ pbjs.que.push(function(){
3030
pbjs.addAdUnits(videoAdUnit);
3131
pbjs.setConfig({
3232
cache: {
33-
url: 'https://prebid.adnxs.com/pbc/v1/cache'
33+
url: 'https://my-pbs.example.com/cache'
3434
},
3535
adpod: {
3636
brandCategoryExclusion: true

dev-docs/publisher-api-reference/setConfig.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1082,7 +1082,7 @@ Here's an example of basic client-side caching. Substitute your Prebid Cache URL
10821082
```javascript
10831083
pbjs.setConfig({
10841084
cache: {
1085-
url: 'https://prebid.adnxs.com/pbc/v1/cache'
1085+
url: 'https://my-pbs.example.com/cache'
10861086
}
10871087
});
10881088
```
@@ -1127,7 +1127,7 @@ Optionally, `batchSize` and `batchTimeout` can be utlilized as illustrated with
11271127
```javascript
11281128
pbjs.setConfig({
11291129
cache: {
1130-
url: 'https://prebid.adnxs.com/pbc/v1/cache',
1130+
url: 'https://my-pbs.example.com/cache',
11311131
batchSize: 4,
11321132
batchTimeout: 50
11331133
}
@@ -1151,7 +1151,7 @@ Consider the following Prebid configuration:
11511151
```javascript
11521152
pbjs.setConfig({
11531153
cache: {
1154-
url: 'https://prebid.adnxs.com/pbc/v1/cache',
1154+
url: 'https://my-pbs.example.com/cache',
11551155
useLocal: true
11561156
}
11571157
});
@@ -1160,7 +1160,7 @@ pbjs.setConfig({
11601160
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:
11611161

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

11661166
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.

dev-docs/show-long-form-video-with-gam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ pbjs.que.push(function(){
184184
pbjs.addAdUnits(videoAdUnit);
185185
pbjs.setConfig({
186186
cache: {
187-
url: 'https://prebid.adnxs.com/pbc/v1/cache'
187+
url: 'https://my-pbs.example.com/cache'
188188
},
189189
adpod: {
190190
brandCategoryExclusion: true

dev-docs/show-video-with-a-dfp-video-tag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ pbjs.que.push(function() {
100100
pbjs.setConfig({
101101
/* Or whatever your preferred video cache URL is */
102102
cache: {
103-
url: 'https://prebid.adnxs.com/pbc/v1/cache'
103+
url: 'https://my-pbs.example.com/cache'
104104
}
105105
});
106106

116 KB
Binary file not shown.

prebid-server/features/pbs-caching.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,26 +49,32 @@ You can watch the caching take place with your browser developer tools.
4949
From one of the [video instream examples](/examples/video/instream/jwplayer/pb-ve-jwplayer-platform.html):
5050

5151
The VAST XML is stored into Prebid Cache from Prebid.js with this call:
52-
```
53-
POST https://prebid.adnxs.com/pbc/v1/cache
52+
53+
```http
54+
POST https://my-pbs.example.com/cache
5455
<VAST XML BODY>
5556
```
57+
5658
And the response from the /cache call is:
57-
```
59+
60+
```json
5861
{"responses":[{"uuid":"9b05c38c-709c-4fb5-8592-8fcacb1289f7"}]}
5962
```
6063

6164
And when the video player is ready to display the video ad, this
6265
call is seen go out:
66+
67+
```http
68+
GET https://my-pbs.example.com/cache?uuid=9b05c38c-709c-4fb5-8592-8fcacb1289f7
6369
```
64-
GET https://prebid.adnxs.com/pbc/v1/cache?uuid=9b05c38c-709c-4fb5-8592-8fcacb1289f7
65-
```
70+
6671
And the response is the VAST XML.
6772

6873
### AMP
6974

7075
Here's an example AMP response from Prebid Server:
71-
```
76+
77+
```json
7278
{
7379
"targeting": {
7480
"hb_cache_id": "14b468d0-3c58-4a5d-ae5d-ab9a47b6152c",
@@ -84,7 +90,7 @@ Here's an example AMP response from Prebid Server:
8490
```
8591

8692
Then when the ad is chosen by the ad server, this fetch goes out from the browser:
87-
```
93+
94+
```http
8895
https://prebid-server.example.com/cache?uuid=14b468d0-3c58-4a5d-ae5d-ab9a47b6152c
8996
```
90-

prebid-video/video-getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you’re using another ad server:
4141
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:
4242

4343
- Line items must target Prebid key-values.
44-
- 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.
44+
- 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.
4545

4646
#### In-renderer Integration
4747

prebid-video/video-integrating-solo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Configuring the video cache is done with [`setConfig`](/dev-docs/publisher-api-r
7575
```javascript
7676
pbjs.setConfig({
7777
cache: {
78-
url: 'https://prebid.adnxs.com/pbc/v1/cache'
78+
url: 'https://my-pbs.example.com/cache'
7979
/* Or whatever your preferred video cache URL is */
8080
}
8181
});

0 commit comments

Comments
 (0)