[go: up one dir, main page]

@simoko/utm-parser
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

@simoko/utm-parser

NPM version

GA4 utm parser, parse UTM parameters from URL

Installation

Install using npm or your favourite package manager:

npm i @simoko/utm-parser

Import:

import { utmParser } from '@simoko/utm-parser'

Require:

const { utmParser } = require('@simoko/utm-parser');

Usage

// const { utmParser } = require('@simoko/utm-parser');
import { utmParser } from "@simoko/utm-parser"

const exampleUrl = "https://example.com/?source=google&utm_medium=cpc&campaign=summer_sale&term=running+shoes&content=ad1&utm_other=test"
// or
// const exampleUrl = "?source=google&utm_medium=cpc&campaign=summer_sale&term=running+shoes&content=ad1&utm_other=test"

console.log(utmParser(exampleUrl).getQueryString())
// ?utm_source=google&utm_medium=cpc&utm_campaign=summer_sale&utm_term=running%20shoes&utm_content=ad1

console.log(utmParser(exampleUrl, { strict: true }).getQueryString())
// ?utm_medium=cpc

console.log(utmParser(exampleUrl).getObject())
// {
//   source: 'google',
//   medium: 'cpc',
//   campaign: 'summer_sale',
//   term: 'running shoes',
//   content: 'ad1'
// }
// const { utmParser } = require('@simoko/utm-parser');
import { utmParser } from "@simoko/utm-parser"

const utm = utmParser("https://example.com/?source=google&utm_medium=cpc&campaign=summer_sale&term=running+shoes&content=ad1&utm_other=test")
// or
// const utm = utmParser({
//     source: 'google',
//     medium: 'cpc',
//     campaign: 'summer_sale',
//     term: 'running shoes',
//     content: 'ad1'
// })

console.log(utm.getChannelGroup())
// Paid Search

utm.setProperty('source', 'facebook')
console.log(utm.getChannelGroup())
// Paid Social

utm.setProperty('source', 'vimeo')
utm.setProperty('medium', 'affiliate')
console.log(utm.getChannelGroup())
// Affiliates

utm.setProperty('campaign', '')
utm.setProperty('content', '')
console.log(utm.getQueryString())
// ?utm_source=vimeo&utm_medium=affiliate&utm_term=running%20shoes

utm.setObject({
    source: "facebook",
    medium: "social",
    campaign: "campaign_test",
    term: "term_test",
    content: "content_test",
});
console.log(utm.getQueryString())
// ?utm_source=facebook&utm_medium=social&utm_campaign=campaign_test&utm_term=term_test&utm_content=content_test
import { utmRemover } from "@simoko/utm-parser"

const exampleUrl = "https://example.com/?source=google&utm_medium=cpc&campaign=summer_sale&term=running+shoes&content=ad1&utm_other=test&utm_other=other&foo=bar"

console.log(utmRemover(exampleUrl))
// https://example.com/?utm_other=test&foo=bar

console.log(utmRemover(exampleUrl, {extraUtm: true}))
// https://example.com/?foo=bar

Package Sidebar

Install

npm i @simoko/utm-parser

Weekly Downloads

8

Version

0.1.2

License

MIT

Unpacked Size

146 kB

Total Files

11

Last publish

Collaborators

  • supra126