Skip to content

Commit

Permalink
upgrading AMP and stored-request docs (#3226)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bretg
bretg authored Aug 23, 2021
1 parent 39b711d commit 31a5f32
Show file tree
Hide file tree
Showing 6 changed files with 121 additions and 173 deletions.
Binary file added assets/images/prebid-server/stored-requests-amp.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/prebid-server/stored-requests-app.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 32 additions & 17 deletions dev-docs/show-prebid-ads-on-amp-pages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,34 +91,40 @@ that doesn't come from /amp parameters:
}
}
},
"imp": [
{
"id": "some-impression-id",
"banner": {
"format": [
{
"w": 300,
"h": 250
}
]
},
"ext": {
"imp": [{
"id": "some-impression-id",
"banner": {
"format": [{
"w": 300,
"h": 250
}]
},
"ext": {
"prebid": {
"bidder": {
"bidderA": {
// Insert parameters here
},
"bidderB": {
// Insert parameters here
}
}
}
}
]
}
}]
}

```
This basic OpenRTB record will be enhanced by the parameters from the call to the [/amp endpoint](/prebid-server/endpoints/openrtb2/pbs-endpoint-amp.html).

### AMP content page

First ensure that the amp-ad component is imported in the header.

```
<script async custom-element="amp-ad" src="https://cdn.ampproject.org/v0/amp-ad-0.1.js"></script>
```
This script provides code libraries that will convert `<amp-ad>` properties to the endpoint query parameters usint the [Real Time Config](https://github.com/ampproject/amphtml/blob/main/extensions/amp-a4a/rtc-documentation.md) (RTC) protocol.

The `amp-ad` elements in the page body need to be set up as shown below, especially the following attributes:

+ `data-slot`: Identifies the ad slot for the auction.
Expand All @@ -130,7 +136,7 @@ e.g. for the AppNexus cluster of Prebid Servers:
```html
<amp-ad width="300" height="250"
type="doubleclick"
data-slot="/19968336/universal_creative"
data-slot="/1111/universal_creative"
rtc-config='{"vendors": {"prebidappnexus": {"PLACEMENT_ID": "13144370"}}, "timeoutMillis": 500}'>
</amp-ad>
```
Expand All @@ -139,11 +145,20 @@ e.g. for Rubicon Project's cluster of Prebid Servers:
```html
<amp-ad width="300" height="250"
type="doubleclick"
data-slot="/19968336/universal_creative"
data-slot="/1111/universal_creative"
rtc-config='{"vendors": {"prebidrubicon": {"REQUEST_ID": "1234-amp-pub-300x250"}}, "timeoutMillis": 500}'>
</amp-ad>
```

For other hosts, you can specify the URL directly rather than using one of the convenient vendor aliases. e.g.
```html
<amp-ad width="300" height="250"
type="doubleclick"
data-slot="/1111/universal_creative"
rtc-config='{"urls": ["https://prebid-server.example.com/openrtb2/amp?tag_id=1001-amp&w=ATTR(width)&h=ATTR(height)&ow=ATTR(data-override-width)&oh=ATTR(data-override-height)&ms=ATTR(data-multi-size)&slot=ATTR(data-slot)&targeting=TGT&curl=CANONICAL_URL&timeout=TIMEOUT&adc=ADCID&purl=HREF&gdpr_consent=CONSENT_STRING&account=ACCOUNT_ID&gdpr_applies=CONSENT_METADATA(gdprApplies)&addtl_consent=CONSENT_METADATA(additionalConsent)&consent_type=CONSENT_METADATA(consentStringType)]}'
</amp-ad>
```

### HTML Creative

This is the creative that your Ad Ops team needs to upload to the ad server (it's also documented at [Setting up Prebid for AMP in Google Ad Manager]({{site.github.url}}/adops/setting-up-prebid-for-amp-in-dfp.html)).
Expand Down
189 changes: 67 additions & 122 deletions prebid-server/endpoints/openrtb2/pbs-endpoint-amp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@ title: Prebid Server | Endpoints | OpenRTB2 | AMP
---

# Prebid Server | Endpoints | /openrtb2/amp
{:.no_toc}

* TOC
{:toc}

This document describes the behavior of the Prebid Server AMP endpoint in detail.
For a more general reference, see the [Prebid AMP Implementation Guide
]({{site.baseurl}}/dev-docs/show-prebid-ads-on-amp-pages.html).
](/dev-docs/show-prebid-ads-on-amp-pages.html).

## GET /openrtb2/amp

Expand All @@ -19,24 +23,28 @@ For a more general reference, see the [Prebid AMP Implementation Guide
| Param | Scope | Type | Description |
| --- | --- | --- | --- |
| tag_id | Required | `String` | The `tag_id` ID must reference a [Stored BidRequest]({{site.baseurl}}/prebid-server/features/pbs-storedreqs.html). For a thorough description of bid request JSON, see the [/openrtb2/auction](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html) docs. |
| w | recommended | `String` | Comes from the amp-ad.width attribute. The stored request may contain width already, but this parameter reflects what's actually in the page. It replaces imp.banner.format[0].w |
| h | recommended | `String` | Comes from the amp-ad.height attribute. The stored request may contain height already, but this parameter reflects what's actually in the page. It replaces imp.banner.format[0].h |
| w | recommended | `String` | Comes from the amp-ad.width attribute. The stored request may contain width already, but this parameter reflects what's actually in the page. It's used to help determine imp.banner.format[0].w. See [resolving sizes](#resolving-sizes). |
| h | recommended | `String` | Comes from the amp-ad.height attribute. The stored request may contain height already, but this parameter reflects what's actually in the page. It's used to help determine imp.banner.format[0].h. See [resolving sizes](#resolving-sizes). |
| ms | optional | `String` | Comes from the amp-ad.data-multi-size attribute. e.g. "970x90, 728x90". Sizes are parsed and added to imp.banner.format |
| oh | optional | `String` | Comes from the amp-ad.data-override-height attribute. See below for details on size calculation. |
| ow | optional | `String` | Comes from the amp-ad.data-override-width attribute. See below for details on size calculation. |
| oh | optional | `String` | Comes from the amp-ad.data-override-height attribute. See [resolving sizes](#resolving-sizes). |
| ow | optional | `String` | Comes from the amp-ad.data-override-width attribute. See [resolving sizes](#resolving-sizes). |
| curl | optional | `String` | Added to OpenRTB request as site.page |
| slot | optional | `String` | Added to OpenRTB request as imp[0].tagid |
| timeout | optional | `String` | Added to OpenRTB request as tmax |
| targeting | optional | `String` | First Party Data (PBS-Java only) |
| targeting | optional | `String` | First Party Data |
| gdpr_consent | optional | `String` | Consent string passed from CMP. Note this is used for both GDPR and CCPA. |
| consent_type | optional | `String` | If "1", request is TCFv1 and GDPR fields are ignored. If "2", the 'gdpr_consent' field is interpreted as TCFv2. If "3", the 'gdpr_consent' field is interpreted as us_privacy. |
| gdpr_applies | optional | `String` | Takes the values "true", "false" or empty. This is used as the value of regs.ext.gdpr. If "true", regs.ext.gdpr:1, if "false", regs.ext.gdpr:0. |
| addtl_consent | optional | `String` | GAM "additional consent". If present, this value is copied to user.ext.ConsentedProvidersSettings.consented_providers |
| account | optional | `String` | Can be used to pass the Prebid-Server specific account ID. This is useful if `tag_id` parameters aren't unique across accounts. |
| debug | optional | `integer` | If 1, returns additional debug info. |
| debug | optional | `integer` | If 1, sets ext.prebid.debug to true to obtain additional debug info. |

To be compatible with AMP, this endpoint behaves different from normal `/openrtb2/auction` requests.

1. The Stored `request.imp` data must have exactly one element.
2. `request.imp[0].secure` will be always be set to `1`, because AMP requires all content to be `https`.
3. AMP query params will overwrite parts of your Stored Request. For details, see the [Query Parameters](#query_params) section.
1. The 'tag_id' parameter points to a stored request.
2. The stored request must have exactly one `imp` element.
3. The request `imp[0].secure` will be always be set to `1`, because AMP requires all content to be `https`.
4. AMP query params will overwrite parts of your Stored Request. See the table above.

### Request

Expand All @@ -63,20 +71,22 @@ An example Stored Request is given below:
}
}
},
"imp": [
{
"id": "some-impression-id",
"banner": {}, // The sizes are defined by your AMP tag query params settings
"ext": {
"appnexus": {
"imp": [{
"id": "some-impression-id",
"banner": {}, // The sizes are defined by your AMP tag query params settings
"ext": {
"prebid": {
"bidder": {
"bidderA": {
// Insert parameters here
},
"rubicon": {
"bidderB": {
// Insert parameters here
}
}
}
]
}
}
}]
}
```

Expand All @@ -90,77 +100,38 @@ Note that other ext.prebid extensions can be specified in the stored request suc

(Currently only supported in PBS-Java)

You can send first party data into an AMP request by encoding a JSON
targeting block like this:
The nature of AMP is that user-level FPD is difficult or impossible. All of the pages are cached on a CDN and page javascript that can modify RTC calls is severely limited.

```
GET /openrtb2/amp?tag_id=7470-Eater_AMP_ROS_ATF&w=300&h=250&ow=&oh=&ms=&slot=%2F172968584%2Feater%2Fgoogle%2Famp_med_rec_02&targeting=%7B%22site%22%3A%7B%22keywords%22%3A%22article%2C%20las%20vegas%22%2C%22cat%22%3A%7B%22blah%22%3A%221%22%7D%2C%22other-attribute%22%3A%22other-value%22%2C%22ext%22%3A%7B%22data%22%3A%7B%22entry_group%22%3A%5B%22front-page%22%2C%22featured-stories%22%5D%2C%22page_type%22%3A%22AMP%22%7D%7D%7D%2C%22user%22%3A%7B%22gender%22%3A%22m%22%7D%2C%22bidders%22%3A%5B%22rubicon%22%2C%22appnexus%22%5D%2C%22keywords%22%3A%22las%20vegas%20hospitality%20employees%22%2C%22foo%22%3A%7B%22bar%22%3A%22baz%22%7D%7D...
```
Contextual First Party Data must be defined in the stored request entries.

Prebid Server will expand the targeting value and merge the data into
the resulting OpenRTB JSON for the appropriate bidders.
The only field that PBS supports in the AMP call that can be considered FPD is the 'targeting' block. These are key-value pairs that are sent to the ad server. They are also copied to the ORTB JSON in imp[].ext.data.

For example, if this AMP targeting is provided:
For example, if the AMP JSON targeting provided is:
```
{
"site": {
"keywords": "article, las vegas", // (1)
"cat": { "blah": "1" }, // invalid data type, will be dropped
"other-attribute": "other-value", // not openrtb2, remove
"ext": {
"data": {
"entry_group": ["front-page","featured-stories"], // (4)
"page_type": "AMP" // (5)
}
}
},
"user": {
"gender": "m", // (2)
},
"bidders": ["rubicon","appnexus"], // (3)
"keywords": "las vegas hospitality employees", // (6)
"foo": { // (7)
"bar": "baz"
}
}
<amp-ad width="300" height="50"
type="doubleclick"
data-slot="/1111/amp_test"
rtc-config='{"vendors": {"prebidrubicon": {"REQUEST_ID": "1001-my-test"}}}'
json='{ "targeting": {"attr1": "val1", "attr2": "val2"}}' >
</amp-ad>
```
The AMP URL would be something like this:
```
The numbered elements from the raw targeting data above are merged into the resulting OpenRTB like this:
GET /openrtb2/amp?tag_id=1001-my-test&w=300&h=250&ow=&oh=&ms=&slot=%2F1111%2Famp_test&targeting=%7B%22attr1%22%3A%22val1%22%2C%22attr2%22%3A%22val2%22%7D&...
```
And the resulting OpenRTB would merge these targeting values as FPD on imp.ext.data:
```
{
"imp": [...],
"site": {
"publisher": { … },
"keywords": "article, las vegas" // (1)
"ext":{
"data": {
"entry_group": ["front-page","featured-stories"], // (4)
"page_type": "AMP" // (5)
}
}
},
"user": {
"gender": "m" // (2)
},
"ext": {
"prebid": {
"data": {
"bidders": ["rubicon",appnexus"], // (3)
}
}
},
"imp": [
"imp": [{
...
"ext": {
"context": {
"data": {
"keywords": "las vegas hospitality employees", // (6)
"foo": { // (7)
"bar": "baz"
}
}
}
"data": {
"attr1": "val1",
"attr2": "val2"
}
}
]
}],
...
}
```

Expand Down Expand Up @@ -228,41 +199,7 @@ The following errors can occur when loading a stored OpenRTB request for an inco
| Checking stored request for match against tag_id. | 999 | No AMP config found for tag_id `%s`. | Error is returned. |
| Checking if imp exists. | 999 | Data for tag_id=`'%s'` does not define the required imp array. | Error is returned. |
| Checking if imp count is greater than one. | 999 | Data for tag_id `'%s'` includes `%d` imp elements. Only one is allowed. | Error is returned. |
| Checking if request.app exists. | 999 | `request.app` must not exist in AMP stored requests. | Error is returned. |


<a name="query_params"></a>
### Query Parameter Details

- A configuration option `amp_timeout_adjustment_ms` may be set to account for estimated latency so that Prebid Server can handle timeouts from adapters and respond to the AMP RTC request before it times out.

Ensure that the amp-ad component was imported in the header.

```html
<script async custom-element="amp-ad" src="https://cdn.ampproject.org/v0/amp-ad-0.1.js"></script>
```

This script provides code libraries that will convert the `<amp-ad>` properties to the endpoint query parameters. In the most basic usage pass `width` and `height` as well as `type` and a `rtc-config`. The `type` value is the ad network you will be using. The `rtc-config` is used to pass JSON configuration to the Prebid Server, which handles the communication with [AMP RTC](https://medium.com/ampfuel/better-than-header-bidding-amp-rtc-fc54e80f3999). Vendors is an object that defines any vendors that will be receiving the RTC callout. In this example, the required parameter `tag_id` will receive the `PLACEMENT_ID` (or `REQUEST_ID`) value.

```html
<amp-ad
width="300"
height="250"
rtc-config='{"vendors": {"prebidappnexus": {"PLACEMENT_ID": "ef8299d0-cc32-46cf-abcd-41cebe8b4b85"}}, "timeoutMillis": 500}'
</amp-ad>
```
Here's a simplified URL:

```
/openrtb2/amp?tag_id='ef8299d0-cc32-46cf-abcd-41cebe8b4b85'&w=300&h=250&timeout=500
```

Some endpoint parameters will override parts of the Stored Request.

1. `ow`, `oh`, `w`, `h`, and/or `ms` will be used to set `request.imp[0].banner.format` if `request.imp[0].banner` is present.
2. `curl` will be used to set `request.site.page`
3. `timeout` will generally be used to set `request.tmax`. However, the Prebid Server host can [configure](https://github.com/prebid/prebid-server/blob/master/docs/developers/configuration.md) their deploy to reduce this timeout for technical reasons.
4. `debug` will be used to set `request.test`, causing the `response.debug` to have extra debugging info in it.
| Checking if app exists. | 999 | The `app` object must not exist in AMP stored requests. | Error is returned. |

### Resolving Sizes

Expand All @@ -271,15 +208,23 @@ track the logic used by `doubleclick` when resolving sizes used to fetch ads fro

Specifically:

1. If `ow` and `oh` exist, `request.imp[0].banner.format` will be a single element with `w: ow` and `h: oh`
2. If `ow` and `h` exist, `request.imp[0].banner.format` will be a single element with `w: ow` and `h: h`
3. If `oh` and `w` exist, `request.imp[0].banner.format` will be a single element with `w: w` and `h: oh`
4. If `ms` exists, `request.imp[0].banner.format` will contain an element for every size it uses.
5. If `w` and `h` exist, `request.imp[0].banner.format` will be a single element with `w: w` and `h: h`
6. If `w` _or_ `h` exist, it will be used to override _one_ of the dimensions inside each element of `request.imp[0].banner.format`
7. If none of these exist then the Stored Request values for `request.imp[0].banner.format` will be used without modification.
1. If `ow` and `oh` exist, `imp[0].banner.format` will be a single element with `w: ow` and `h: oh`
2. If `ow` and `h` exist, `imp[0].banner.format` will be a single element with `w: ow` and `h: h`
3. If `oh` and `w` exist, `imp[0].banner.format` will be a single element with `w: w` and `h: oh`
4. If `ms` exists, `imp[0].banner.format` will contain an element for every size it uses.
5. If `w` and `h` exist, `imp[0].banner.format` will be a single element with `w: w` and `h: h`
6. If `w` _or_ `h` exist, it will be used to override _one_ of the dimensions inside each element of `imp[0].banner.format`
7. If none of these exist then the Stored Request values for `imp[0].banner.format` will be used without modification.

## Configuration Options

- settings.generate-storedrequest-bidrequest-id: replace the stored request `id` with a UUID (PBS-Java only)
- amp.default-timeout-ms: default operation timeout for AMP requests
- amp.timeout-adjustment-ms: reduces timeout value passed in AMP request. Can be used to account for estimated latency so that Prebid Server can respond to the AMP RTC request before it times out.
- amp.max-timeout-ms: maximum operation timeout for AMP requests

## Further Reading
- [Prebid and AMP](/formats/amp.html)
- [Prebid Server AMP Use Case Overview](/prebid-server/use-cases/pbs-amp.html)
- [Prebid Server First Party Data](/prebid-server/features/pbs-fpd.html)
- [Stored Requests](/prebid-server/features/pbs-storedreqs.html)
20 changes: 14 additions & 6 deletions prebid-server/features/pbs-storedreqs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,35 @@ title: Prebid Server | Features | Stored Requests
# Prebid Server | Features | Stored Requests

'Stored Requests' are blocks of OpenRTB stored on the server-side that are merged into
OpenRTB requests in a couple of scenarios.
OpenRTB requests for Mobile App and AMP scenarios.

The data source can be local files on Prebid Server, but more commonly it would be a relational
database distributed across all the Prebid Servers in the host company's installation.

## Mobile App

Hardcoding bidders and parameters in a mobile app isn't ideal. Prebid Server allows Stored Request IDs to be
used in two ways:
We want to avoid hardcoding parameters into a mobile app like bidders and parameters. Because of this, Prebid Server allows host companies to store two types of JSON that are retrieved with a key called a 'Stored Request ID':

1. Define cross-adunit parameters like currency and price granularity
1. Define adunit-specific details: bidders and their parameters
- "top-level" requests, also called "wrapper-level" requests. This block is merged into the root level of the incoming ORTB request. It's not expected to have an imp object.
- "impression-level" requests are merged into a particular ORTB imp element.

![App stored request model](/assets/images/prebid-server/stored-requests-app.png){: .pb-lg-img :}

1. The SDK creates a 'skeleton' framework of the OpenRTB JSON that doesn't
contain the bidders or any other parameter that might be changed by AdOps.
2. Prebid Server merges all the stored requests into this template.
3. Creating the final OpenRTB JSON just like Prebid.js would have sent using the PBS Bid Adapter.

See the [Mobile SDK Use Case reference](/prebid-server/use-cases/pbs-sdk.html) for specific examples.

## AMP

The AMP protocol is converted to OpenRTB primarily using Stored Requests: the `tag_id` is used to look up
the base OpenRTB from the data source. After getting the bulk of the OpenRTB, AMP query string parameters
a single base OpenRTB from the data source. After getting the bulk of the OpenRTB, AMP query string parameters
are used to inject and adjust parameters like size, url, etc. See the [AMP endpoint documentation](/prebid-server/endpoints/openrtb2/pbs-endpoint-amp.html) for more details.

![AMP stored request model](/assets/images/prebid-server/stored-requests-amp.png){: .pb-lg-img :}

See the [AMP Use Case reference](/prebid-server/use-cases/pbs-amp.html) for specific examples.

## Creating Stored Requests
Expand Down
Loading

0 comments on commit 31a5f32

Please sign in to comment.