angular-dfp

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>Documentation Module: dfp-script</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.simplex.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top "> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">Documentation</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="module-dfp.html">dfp</a></li><li><a href="module-dfp-ad.html">dfp-ad</a></li><li><a href="module-dfp-audience-pixel.html">dfp-audience-pixel</a></li><li><a href="module-dfp-exclusion.html">dfp-exclusion</a></li><li><a href="module-dfp-id-generator.html">dfp-id-generator</a></li><li><a href="module-dfp-incomplete-error.html">dfp-incomplete-error</a></li><li><a href="module-dfp-refresh.html">dfp-refresh</a></li><li><a href="module-dfp-responsive.html">dfp-responsive</a></li><li><a href="module-dfp-script.html">dfp-script</a></li><li><a href="module-dfp-size.html">dfp-size</a></li><li><a href="module-dfp-targeting.html">dfp-targeting</a></li><li><a href="module-dfp-value.html">dfp-value</a></li><li><a href="module-dfp-video_.html">dfp-video></a></li><li><a href="module-http-error.html">http-error</a></li><li><a href="module-parse-duration.html">parse-duration</a></li><li><a href="module-responsive-resize.html">responsive-resize</a></li><li><a href="module-script-injector.html">script-injector</a></li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="module-dfp-script-DFPScriptError.html">dfp-script~DFPScriptError</a></li><li><a href="module-dfp-video_-DFPVideoError.html">dfp-video>~DFPVideoError</a></li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="global.html#googletag">googletag</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content"> <div class="row"> <div class="col-md-8"> <div id="main"> <h1 class="page-title">Module: dfp-script</h1> <section> <header> </header> <article> <div class="container-overview"> <div class="description"><p>A directive for supplying additional JavaScript to configure an ad slot.</p> <p>Since our library does not cover all parts of the GPT library, it may be necessary to add your own, additional JavaScript to further configure an ad slot. For this, the <code>dfp-script</code> directive allows writing inline or external JS and manipulate the ad slot. More precisely, the library will inject the slot object (which can be renamed) into the scope of the JavaScript. Moreover, you may inject your own <code>scope</code> object that will be available inside the script.</p> <p>The <code>dfp-script</code> tag must be nested directly under the main <code>dfp-ad</code> tag.</p></div> <dl class="details"> <dt class="tag-license method-doc-label method-doc-details-label">License:</dt> <dd class="tag-license"> <ul class="dummy"> <li>Apache Copyright 2016 Google Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</li> </ul> </dd> </dl> <h3>Example</h3> <p class="code-caption">Example usage of the `dfp-script` directive.</p> <pre class="sunlight-highlight-javascript"><dfp-ad ad-unit="path/to/my/ad-unit"> <dfp-script slot-as="mySlot" scope="{ path: 'spaghetti' }"> if (mySlot.getAdUnitPath() === scope.path) { mySlot.clearTargeting(); } </dfp-script> </dfp-ad></pre> </div> <h3 class="subsection-title">Classes</h3> <dl> <dt><a href="module-dfp-script-DFPScriptError.html">DFPScriptError</a></dt> <dd></dd> </dl> </article> </section> </div> </div> <div class="clearfix"></div> <div class="col-md-3"> <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> </div> </div> </div> <div class="modal fade" id="searchResults"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title">Search results</h4> </div> <div class="modal-body"></div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div> </div> </div> <footer> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on 2017-04-21T11:03:14+03:00 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. </span> </footer> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/toc.js"></script> <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script> <script> $( function () { $( "[id*='$']" ).each( function () { var $this = $( this ); $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); lang = langClassMatch ? langClassMatch[1] : "javascript"; } if ( lang ) { $this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() ); } } ); Sunlight.highlightAll( { lineNumbers : false, showMenu : true, enableDoclinks : true } ); $.catchAnchorLinks( { navbarOffset: 10 } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { return $( heading ).attr( "id" ) || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, smoothScrolling: true } ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown(); $( "table" ).each( function () { var $this = $( this ); $this.addClass('table'); } ); } ); </script>   <script type="text/javascript"> $(document).ready(function() { SearcherDisplay.init(); }); </script> </body> </html>