\n\t\n\t\t\n\t\t\t![](\"{{imageurl}}\"/)
\n\t\t\t
\n```\n\nRequirements:\n\n* Ensure a key contains `%%CLICK_URL_UNESC%%%%DEST_URL%%` which is used in any `a` tags in order to track the click through, as well as redirect to the creative's url.\n* Ensure a key named `impressionUrl` contains `%%VIEW_URL_UNESC%%` so the system can track the impression.\n\n## Recid Ads `data-sv-adstyle=\"recid\"`\n\nRecid ads are used when you have content that has already loaded on your page but you want to track it's impression and click through in the ad server. This is commonly used for tracking Featured Listings.\n\nIn the following template, it will track the impression to the ad that is returned for that recid. It will also cause the click through to be tracked if the user clicks either element with the `data-sv-adclick` attribute.\n\n```html\n\n```\n\n# API Documentation\n\n## GamClient(args)\n\nConstructor that initializes the GamClient object. This must be called in order to use `GamClient.renderAds()` or `GamClient.getAd(args, cb)`.\n\n* args - `object`\n\t* `addScript` - `boolean` - default `true` - If true, will inject Google's gpt.js script into the dom.\n\t* `loadEvent` - `string` - default `sv-adloaded` - Event thrown when an ad of type `template`, `html` or `recid`. It is dispatched on the event that has the `data-sv-adunit`.\n\t\t* When listening on `sv-adloaded` the event handler will receive an `Event` object which contains `detail` key with `{ data, adSlot }`.\n\t* `attrs` - `object`\n\t\t* `adcomplete` - `string` - default `data-sv-adcomplete` - Attribute used for marking when an ad has loaded.\n\t\t* `adunit` - `string` - default `data-sv-adunit` - Attribute used for determining the GAM adunit.\n\t\t* `adstyle` - `string` - default `data-sv-adstyle` - Attribute used for determining the ad style.\n\t\t* `adrecid` - `string` - default `data-sv-adrecid` - Attribute used for determining the recid used when ad style is `recid`.\n\t\t* `adsize` - `string` - default `data-sv-adsize` - Attribute used for determining the ad size when ad style is `iframe`, `template`, or `html`.\n\t\t* `adclick` - `string` - default `data-sv-adclick` - Attribute used for marking dom elements to count as an ad click throughs when ad style is `recid`.\n\n## GamClient.renderAds()\n\nRenders all ads on a page. Calling this multiple times will not reload an add but will render ads that have been added to the dom after the previous `renderAds()` call. \n\n## GamClient.getAd(args, cb)\n\nFor ads where you want to manually pull a creative associated with an ad so you can render it yourself, utilize `GamClient.getAd()`. This returns the creative for and ad. Impression tracking, and display of the ad must be manually done when using this function.\n\n* `args` - `object` - The args object.\n\t* `adunit` - `string` - The network code and adunit code for the ad in the following format: \"/`NETWORK_CODE`/`ADUNIT_CODE`\".\n\t* `size` - `string` - The size of the adunit in the following format \"`WIDTH`x`HEIGHT`\".\n\t* `targeting` - `object` - key/value pairs to target. You do not need to encode the key or value, pass them unencoded.\n* `cb` - `function` - The callback function. This function returns 1 parameter `data` which contains the entirety of the creative for the defined adunit. Errors thrown by this function are completely ignored and not reported. \n\n```js\n// manually pull an ad's creative\ndtn.getAd({ adunit : \"/NETWORK_CODE/ADUNIT_CODE\", size : \"WIDTHxHEIGHT\" }, function(data) {\n\t// do something to render result of data\n});\n```\n\n# Development\n\n* `npm run docker` - To load the dev environment.\n* `npm start` - To combile the `index.min.js` for UMD. Browse to http://kube.simpleview.io:8080/ . Any changes made to files in the `src` folder will automatically trigger a rebuild of the `dist/index.min.js` file.\n* `npm test` - To execute the unit tests in a headless browser.\n\n# GAM Documentation\n\n* GPT Libary Reference - https://developers.google.com/doubleclick-gpt/reference\n* Load Creative with URL - https://support.google.com/admanager/answer/2623168?hl=en\n* Macros - https://support.google.com/admanager/answer/2376981?hl=en\n* GPT Samples - https://support.google.com/admanager/answer/4578089?hl=en","readmeFilename":"README.md"}{{title}}
\n\t\t\n\t\n