This page has instructions for showing ads on Accelerated Mobile Pages (AMP) using Prebid.js.
Through this implementation, Prebid Server fetches demand and returns key-value targeting to the AMP runtime using the AMP Real Time Config (RTC) protocol.
For more information about AMP RTC, see:
To set up Prebid to serve ads into your AMP pages, you’ll need:
amp-iframe pixel that must be added to your AMP page to sync users with Prebid Server.You will have to create at least one Stored Request for Prebid Server. Valid Stored Requests for AMP pages must contain an imp array with exactly one element. It is not necessary to include a tmax field in the Stored Request, as Prebid Server will always use the smaller of the AMP default timeout (1000ms) and the value passed via the timeoutMillis field of the amp-ad.rtc-config attribute (explained in the next section).
An example Stored Request is given below. You’ll see that the Stored Request contains some important info that doesn’t come from /amp parameters:
{
"id": "some-request-id",
"cur": ["USD"],
"source": {
"ext": {
"schain": {
...
}
}
},
"site": {
"page": "prebid.org" // will be overridden by the 'curl' parameter on /amp endpoint
},
"ext": {
"prebid": {
"cache": {
"bids": {}
},
"targeting": {
"pricegranularity": { // This is equivalent to "pricegranularity": "medium"
"precision": 2,
"ranges": [{
"max": 20.00,
"increment": 0.10
}]
}
}
}
},
"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.
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 (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.rtc-config: Used to pass JSON configuration data to Prebid Server, which handles the communication with AMP RTC.
vendors is an object that defines any vendors that will be receiving RTC callouts (including Prebid Server) up to a maximum of five. The list of supported RTC vendors is maintained in callout-vendors.js. We recommend working with your Prebid Server hosting company to set up which bidders and parameters should be involved for each AMP ad unit.timeoutMillis is an optional integer that defines the timeout in milliseconds for each individual RTC callout. The configured timeout must be greater than 0 and less than 1000ms. If omitted, the timeout value defaults to 1000ms.e.g. for the AppNexus cluster of Prebid Servers:
<amp-ad width="300" height="250"
type="doubleclick"
data-slot="/1111/universal_creative"
rtc-config='{"vendors": {"prebidappnexuspsp": {"PLACEMENT_ID": "13144370"}}, "timeoutMillis": 500}'>
</amp-ad>
e.g. for Rubicon Project’s cluster of Prebid Servers:
<amp-ad width="300" height="250"
type="doubleclick"
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.
<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>
This is the creative that your Ad Ops team needs to upload to the ad server (it’s also documented at GAM Step by Step - Banner/Outstream/AMP Creatives).
For Google Ad Manager:
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN:hb_format%%.js"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = "";
ucTagData.pubUrl = "%%PATTERN:url%%";
ucTagData.targetingMap = %%PATTERN:TARGETINGMAP%%;
ucTagData.hbPb = "%%PATTERN:hb_pb%%";
try {
ucTag.renderAd(document, ucTagData);
} catch (e) {
console.log(e);
}
</script>
For all other ad servers:
<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%MACRO:hb_format%%.js"></script>
<script>
var ucTagData = {};
ucTagData.adServerDomain = "";
ucTagData.pubUrl = "%%MACRO:url%%";
ucTagData.adId = "%%MACRO:hb_adid%%";
ucTagData.cacheHost = "%%MACRO:hb_cache_host%%";
ucTagData.cachePath = "%%MACRO:hb_cache_path%%";
ucTagData.uuid = "%%MACRO:hb_cache_id%%";
ucTagData.mediaType = "%%MACRO:hb_format%%";
ucTagData.env = "%%MACRO:hb_env%%";
ucTagData.size = "%%MACRO:hb_size%%";
ucTagData.hbPb = "%%MACRO:hb_pb%%";
try {
ucTag.renderAd(document, ucTagData);
} catch (e) {
console.log(e);
}
</script>
Replace MACRO in the preceding example with the appropriate macro for the 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.)
To sync user IDs with Prebid Server, the amp-iframe below may be added to your AMP pages referring to load-cookie.html.
AMP constrains syncing as described in the amp-iframe documentation. You may only have one amp-iframe on your page that is small, e.g. 1x1. Many publishers already have some kind of analytics or tracking frame on their page, so they may find it difficult to manage this. Several hacks are possible, including building a ‘frankenstein’ script that combines all of your required tracking into one or tying the sync to an image that’s large enough to be visible.
Notes:
sandbox parameter to the amp-iframe must include both “allow-scripts” and “allow-same-origin”.load-cookie.html older than July of 2024 and if your AMP page is using a CMP, you should consider using load-cookie-with-consent.html instead. It’s the same functionality, but older versions of load-cookie.html cannot read from CMPs.If you’re using AppNexus’ managed service, you would enter something like this:
<amp-iframe width="1" title="User Sync"
height="1"
sandbox="allow-scripts allow-same-origin"
frameborder="0"
src="https://acdn.adnxs.com/prebid/amp/user-sync/load-cookie.html?endpoint=appnexus&max_sync_count=5&source=amp">
<amp-img layout="fill" src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" placeholder></amp-img>
</amp-iframe>
If you are utilizing Magnite’s managed service, there’s an extra args parameter:
<amp-iframe width="1" title="User Sync"
height="1"
sandbox="allow-scripts allow-same-origin"
frameborder="0"
src="https://GET_URL_FROM_MAGNITE_ACCOUNT_TEAM/prebid/load-cookie.html?endpoint=rubicon&max_sync_count=5&source=amp&args=account:MAGNITE_ACCOUNT_ID">
<amp-img layout="fill" src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" placeholder></amp-img>
</amp-iframe>
Or you can specify a full URL to another Prebid Server location (including a QA site) by setting endpoint to a URL-encoded string. e.g.
<amp-iframe width="1" title="User Sync"
height="1"
sandbox="allow-scripts allow-same-origin"
frameborder="0"
src="https://acdn.adnxs.com/prebid/amp/user-sync/load-cookie.html?endpoint=https%3A%2F%2Fprebid-server-qa.example.com%2Fcookie_sync&max_sync_count=5&source=amp">
<amp-img layout="fill" src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" placeholder></amp-img>
</amp-iframe>
See manually initiating a sync for more information about the available parameters and for how to host the load-cookie script.
If you’re using a custom RTC callout rather than one of the pre-defined vendor callouts, here are the parameters that can be passed through the RTC string:
To review that Prebid on AMP is working properly the following aspects can be looked at:
#development=1 to the URL to review AMP specifc debug messages in the browser console.scp query string parameter in the network request)debug=1 parameter is present in the Prebid Server query string. AMP won’t add this parameter, so you’ll need to grab the Prebid Server URL and manually add it to see the additional information provided.