Event tracking for Google Tag Manager via Promo ads. Use in conjunction with the promo-button
, your Google Tag Manager and/or Google Analytics and Tincre Promo.
🤯 for your ads on the web, with Google.
Installation
Use your favorite package manager to rock installation of promo-sync-gtag
.
Yarn
yarn add @tincre/promo-sync-gtag # -D if you want this as a dev dep
Npm
npm install @tincre/promo-sync-gtag # --save-dev if you want it as a dev dep
Environment variables
You'll need the following environment variables available in Node.js:
PROMO_CLIENT_ID
PROMO_CLIENT_SECRET
PROMO_APP_ID
PROMO_API_KEY
(optional)
These values can be found in the Tincre.dev Dashboard
after you're logged in and have created at least one app.
.env.local
Example
PROMO_API_KEY=
PROMO_CLIENT_ID=
PROMO_APP_ID=
PROMO_CLIENT_SECRET=
Usage
To use a Google Tag (Analytics) event simply import it into your framework of choice and fire the function.
🌶️ Typically this is in a useEffect
hook within the function body if you're a React user.
import { promoEventPageView } from '@tincre/promo-sync-gtag';
export default function PageOrComponent() {
promoEventPageView()
return <></>;
}
useEffect
example
import { useEffect } from 'react';
import { promoEventPageView } from '@tincre/promo-sync-gtag';
export default function PageOrComponent() {
useEffect(() => {
promoEventPageView()
}, [])
return <></>;
}
Support
License
This code is free to use for your commercial or personal projects. It is open-source
licensed under the Mozilla Public License 2.0.
You will see various headers throughout the codebase and can reference the license
directly via LICENSE herein.
Development
Releases
We use npm
for releases. In particular, we use
npm --publish
to get the job done.
Currently, only @thinkjrs has the ability to release. The following section
is written for memory.
Release prep
Prior to using npm --publish
a release tag needs to be created for
the library using our standard tagging practices.
Ensure that tests :white_check_mark: pass during this process prior to
releasing via npm.
Test release
To do a proper release, ensure you're in the base repo directory and run
npm publish . --access public --dry-run
.
Release latest
tag
To complete a full release to the latest
npm dist-tag
, ensure you're in
the base repo directory and run npm publish . --access public
.
:tada: That's it! :tada: