gpt-ads-module

Google Publisher Tag ads integration for Nuxt

Forked from ax2inc/nuxt-modules and split to the separate repo to use git link as an npm dependency

📖 Release Notes

Features

Integrate Google Publisher Tag with your Nuxt project.

Setup

• Install the module with your favorite package manager.

yarn add @ax2/gpt-ads-module
# Or npm i @ax2/gpt-ads-module

• Add @ax2/gpt-ads-module to modules section of nuxt.config.js.

// nuxt.config.js

{
  modules: [
    '@ax2/gpt-ads-module',
 ],
}

• Configure the module as needed by adding a gptAds key to nuxt.config.js.

// nuxt.config.js

{
  gptAds: {
    // Module options
  }
}

Options

networkCode

• Type: Array|String: required

Your network code as found in Google Ad Manager > Admin > Global Settings.

debug

• Type: Boolean
• Default: false

Enable debug mode, when this is true, GPT console opens when the app loads.

componentName

• Type: String
• Default: 'GptAd'

Name of the component that the module registers.

individualRefresh

• Type: Boolean
• Default: false

If enabled, ads won't be fetched on page load but will be refreshed individually as they are mounted.

responsive

• Type: Boolean
• Default: false

Set to true to enable responsive mode for all ads slot. In responsive mode, ad slots listen to window resize events and refresh themselves if a different size mapping matches current window size.

collapseEmptyDivs

• Type: Boolean
• Default: false

Set to true to have empty ad slots collapsed themselves, this can be overridden at slot-level with collapseEmptyDiv prop.

ghostMode

• Type: Boolean
• Default: false

Set to true to enable ghost mode. With ghost mode enabled, ad slots aren't displayed and are replaced by empty bordered divs of the size the ads would have if they were displayed. This is useful during development where you might not want to display real ads.

emptyClass

• Type: String
• Default: 'is-empty'

Class to apply to empty ads slots.

Usage

When the module is enabled, it registers a global Vue component that you can use to display ads in your app. By default, the component's name is GptAd but this can be changed via the componentName option.

The component accepts a few props to customize the ads you display.

Props

adUnit

• Type: string: required

The ad unit for a given ad as defined in Google Ad Manager > Inventory > Ad units.

size

• Type: Array|string: required

Default size for this ad, can be an array ([<width>, <height>]) or a string ('<width>x<height>').

To support multiple sizes, either pass an array of arrays ([[<width>, <height>], [<width>, <height>]]), or a string where dimensions are separated by a comma ('<width>x<height>,<width>x<height>').

sizeMapping

• Type: Array
• Default: []

Size mapping for this ad. Each item in the list is an array of its own, where the first item is the browser size, and the second is the expected ad's size(s) for the breakpoint. Sizes should either be arrays in the form [<width>, <height>] or strings in the form '<width>x<height>'.

isResponsive

• Type: Boolean
• Default: <%= options.responsive %>

Turn responsive mode on or off for specific ads, defaults to module's responsive option.

windowResizeDebounce

• Type: Number
• Default: 300

Debounce duration between each window resize handling.

collapseEmptyDiv

• Type: Boolean
• Default: null

Override collapseEmptyDivs option at the slot's level.

Examples

<template>
  <GptAd
    ad-unit="SOME-AD-UNIT"
    :size="[120, 60]"
    :size-mapping="[
      [
        [1024, 768],
        [970, 250],
      ],
      [
        [980, 690],
        [728, 90],
      ],
      [
        [640, 480],
        [120, 60],
      ],
      [
        [0, 0],
        [88, 31],
      ],
    ]"
  />
</template>

Equivalent:

<template>
  <GptAd
    ad-unit="SOME-AD-UNIT"
    size="120x60"
    :size-mapping="[
      ['1024x768', '970x250'],
      ['980x690', '728x90'],
      ['640x480', '120x60'],
      ['0x0', '88x31'],
    ]"
  />
</template>

Development

• Clone this repository
• Install dependencies using yarn install or npm install
• Start development server using npm run dev

License

MIT License

Copyright (c) Ax2 Inc.