The Google Publisher Tag (GPT) is an ad tagging library for Google Ad Manager which is used to dynamically build ad requests. It takes key details from you (such as ad unit code, ad size, and custom targeting), builds the request, and displays the ad on web pages.
For a brief overview of GPT, including it's benefits, basic functionality and features, visit the Ad Manager help center.
Display a test ad
The following example walks you through the process of creating a test page that uses GPT to load a generic ad from Google's test network.
Full code for this example can be found on the display a test ad sample page.
Create a basic HTML document
In a text editor, create a basic HTML document called
hello-gpt.html
.<!doctype html> <html> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="description" content="Display a fixed-sized test ad." /> <title>Display a test ad</title> <style></style> </head> <body> <script> googletag.cmd.push(() => { // Request and render an ad for the "banner-ad" slot. googletag.display("banner-ad"); }); </script> </body> </html>
Load the GPT library
Load the GPT library by adding the following to the
<head>
of the HTML document.<head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="description" content="Display a fixed-sized test ad." /> <title>Display a test ad</title> <script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script> <style></style> </head>
This code will load the GPT library from https://securepubads.g.doubleclick.net/tag/js/gpt.js. Once the library has fully loaded, it will process any queued commands in the googletag object.
Define an ad slot
Define an ad slot and initialize GPT using the googletag.enableServices() method.
<head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="description" content="Display a fixed-sized test ad." /> <title>Display a test ad</title> <script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script> <script> window.googletag = window.googletag || { cmd: [] }; googletag.cmd.push(() => { // Define an ad slot for div with id "banner-ad". googletag .defineSlot("/6355419/Travel/Europe/France/Paris", [300, 250], "banner-ad") .addService(googletag.pubads()); // Enable the PubAdsService. googletag.enableServices(); }); </script> <style></style> </head>
This code first ensures the googletag object is available, then queues a command which constructs an ad slot and enables GPT.
The ad slot in this example will load an ad of size
300x250
from the ad unit specified by path/6355419/Travel/Europe/France/Paris
. The ad will be displayed in a<div id="banner-ad">
element in the body of the page, which will be added next.- network-code is a unique identifier for the Ad Manager network the ad unit belongs to
- parent-ad-unit-code are the codes of all parent ad units (only applies to non-top level ad units)
- ad-unit-code is the code for the ad unit to be displayed
Note that all ad unit codes included in the ad unit path must adhere to the formatting rules specified by Ad Manager.
Specify where the ad will appear
Specify where the ad will appear on the page by adding the following code to the
<body>
of the HTML document.<body> <div id="banner-ad" style="width: 300px; height: 250px"></div> <script> googletag.cmd.push(() => { // Request and render an ad for the "banner-ad" slot. googletag.display("banner-ad"); }); </script> </body>
Note that the ID of this
<div>
matches the ID specified when defining the ad slot.Preview the test page
Save the
hello-gpt.html
file and open it in a web browser. Once loaded, the page will display a test ad in the body of the web page.
Display your own ad
Using the hello-gpt.html
file created in the Display a test ad
section, replace the code in the header with code specifying inventory from your
own Ad Manager network.
Generate an ad tag for the ad unit you'd like to display. Learn more about generating ad tags in the Ad Manager help center.
Copy the ad tag code provided in the Document header section and use it to replace the corresponding code in the
<head>
of your HTML document.<head> <meta charset="utf-8"> <title>Hello GPT</title> <script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script> <script> window.googletag = window.googletag || {cmd: []}; googletag.cmd.push(function() { googletag .defineSlot( 'ad-unit-path', [width, height], 'div-id') .addService(googletag.pubads()); googletag.enableServices(); }); </script> </head>
Save the updated
hello-gpt.html
file and open it in a web browser.