Skip to content

Latest commit

 

History

History
142 lines (100 loc) · 4.81 KB

README.md

File metadata and controls

142 lines (100 loc) · 4.81 KB
Raw

React Google Publisher Tag

Motivation

I needed to show adsense via google publisher tag in my react isomorphic application. Please read carefully (AdSense terms)[https://support.google.com/adsense/answer/48182?hl=en]. You are using this module on your own risk. I am using it for 2 years without any problem.

Install

npm install react-google-publisher-tag

Features

  • Automatically show AD and fit the size
  • Automatically load google script
  • Support for mobile (you can show different size for mobile users)
  • Support for isomorphic applications
  • Support for responsible layout

Usage

  • Go to https://www.google.com/dfp and create a new Ad unit. (tab Inventory)
  • Add sizes: 120x240, 120x600, 125x125, 160x600, 180x150, 200x200, 234x60, 240x400, 250x250, 300x100, 300x250, 300x600, 320x50, 336x280, 468x60, 728x90, 970x90
  • Use ad code as path in the react component

Example.jsx

//ES6
import React, { Component } from 'react';
import Ad from 'react-google-publisher-tag';

export default class Example extends Component {
  render() {
    return (
      <div id="application">
        <Ad path="/network-code/ad-code" />
        <RouteHandler />
      </div>
    );
  }
}

Parameters

Name Type Required Default
path String true
format String false MOBILE_HORIZONTAL
canBeLower Boolean false true
enableSingleRequest Boolean false false
id String false
dimensions Array false
targeting Object false
onSlotRenderEnded Function false
onImpressionViewable Function false
onSlotVisibilityChanged Function false
collapseEmpty boolean or Array false fals

Path

Path is only one required parameter. The format is: /network-code/ad-code

Example:

/22222222/myad

Network code

You can find your network code in the Admin tab (Google DFP). This unique code is included in DFP tags to identify the network, ensuring that DFP looks in the correct network for line items that are targeted to a particular ad unit. It's displayed here to help you identify which network is associated with any DFP tags you have on your site.

Ad code

You can find your ad code when you click on your ad in the Google DFP (Inventary tab) Identifies the ad unit in the associated ad tag. Ad unit codes can be up to 100 characters in length. Only letters, numbers, underscores, hyphens, periods, asterisks, forward slashes, backslashes, exclamations, left angle brackets, colons and parentheses are allowed. Each code must be unique; you can't reuse codes you've used before. Once you've created the ad unit, you can't change the code.

Formats

It will setup ad size automatically for this component:

  • [Format.HORIZONTAL]: [[970, 90], [728, 90], [468, 60], [234, 60]],
  • [Format.RECTANGLE]: [[336, 280], [300, 250], [250, 250], [200, 200], [180, 150], [125, 125]],
  • [Format.VERTICAL]: [[300, 600], [160, 600], [120, 600], [120, 240]],
  • [Format.MOBILE]: [[320, 50]],
  • [Format.MOBILE_BIG]: [[320, 100], [320, 50]],
  • [Format.MOBILE_HORIZONTAL]: [[970, 90], [728, 90], [468, 60], [320, 100], [320, 50], [234, 60]],
  • [Format.PORTRET]: [[300, 1050]],
  • [Format.BILBORD]: [[970, 250]],
  • '300x600': [[300, 600], [160, 600]],
  • '336x280': [[336, 280], [300, 250]],
  • '728x90': [[728, 90], [468, 60]],
  • '970x90': [[970, 90], [728, 90], [468, 60]],

Instead of format you can set your own dimmensions. More details you can find in the adsense documentation

Can be lower

You can allow lower ad size automatically. (Default: true)

Targeting

Add custom targeting parameters for a slot. The object's attributes are the keys while their value is the value.

Example:

{
  color: 'red',
  sport: ['rugby', 'rowing'],
}

onSlotRenderEnded

Pass a function that will be executed when the slot is rendered.

onImpressionViewable

Pass a function that will be executed when the ad is fully rendered.

onSlotVisibilityChanged

Pass a function that will be executed when the on-screen percentage of an ad area changes

Credits

Zlatko Fedor

License

The MIT License (MIT)

Copyright (c) 2016 Zlatko Fedor zlatkofedor@cherryprojects.com