Zanalytics-aws-pinpoint NPM

AWS Pinpoint Plugin for `analytics`

Integration with AWS Pinpoint for analytics

Amazon Pinpoint is a flexible and scalable outbound and inbound marketing communications service. You can connect with customers over channels like email, SMS, push, or voice.

View the docs.

Installation

Install analytics and @analytics/aws-pinpoint packages

npm install analytics
npm install @analytics/aws-pinpoint

How to use

The @analytics/aws-pinpoint package works in the browser. To use, install the package, include in your project and initialize the plugin with analytics.

Below is an example of how to use the browser plugin.

import Analytics from 'analytics'
import awsPinpointPlugin from '@analytics/aws-pinpoint'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    awsPinpointPlugin({
      pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
      getCredentials: () => Auth.currentCredentials()
    })
  ]
})

/* Track a page view */
analytics.page()

/* Track a custom event */
analytics.track('cartCheckout', {
  item: 'pink socks',
  price: 20
})

/* Identify a visitor */
analytics.identify('user-id-xyz', {
  firstName: 'bill',
  lastName: 'murray'
})

After initializing analytics with the awsPinpointPlugin plugin, data will be sent into AWSPinpoint whenever analytics.page, analytics.track, or analytics.identify are called.

See additional implementation examples for more details on using in your project.

Platforms Supported

The @analytics/aws-pinpoint package works in the browser

Browser usage

The AWSPinpoint client side browser plugin works with these analytic api methods:

analytics.page - Sends page views into AWSPinpoint
analytics.reset - Reset browser storage cookies & localstorage for AWSPinpoint values
analytics.track - Track custom events and send to AWSPinpoint
analytics.identify - Identify visitors and send details to AWSPinpoint

Browser API

import Analytics from 'analytics'
import awsPinpointPlugin from '@analytics/aws-pinpoint'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    awsPinpointPlugin({
      pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
      getCredentials: () => Auth.currentCredentials()
    })
  ]
})

Configuration options for browser

Option	description
`pinpointAppId` required - string	AWS Pinpoint app Id for client side tracking
`getCredentials` required - function	Async function to get AWS Cognito creds
`pinpointRegion` optional - string	AWS Pinpoint region. Defaults to us-east-1
`appTitle` optional - string	The title of the app that's recording the event.
`appPackageName` optional - string	The name of the app package, such as com.example.my_app.
`appVersionCode` optional - string	The version number of the app, such as 3.2.0
`disableAnonymousTraffic` optional - boolean	Disable anonymous events from firing

Additional examples

Below are additional implementation examples.

Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/aws-pinpoint in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/@analytics/aws-pinpoint/dist/@analytics/aws-pinpoint.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: 'my-app-name',
        plugins: [
          analyticsAWSPinpoint.default({
            pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
            getCredentials: () => Auth.currentCredentials()
          })
        ]
      })

      /* Track a page view */
      analytics.page()

      /* Track a custom event */
      analytics.track('cartCheckout', {
        item: 'pink socks',
        price: 20
      })

      /* Identify a visitor */
      analytics.identify('user-id-xyz', {
        firstName: 'bill',
        lastName: 'murray'
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Using @analytics/aws-pinpoint in ESM modules.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/aws-pinpoint in HTML via ESModules</title>
    <script>
      // Polyfill process.
      // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
      window.process = window.process || { env: { NODE_ENV: 'production' } }
    </script>
    <script type="module">
      import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
      import analyticsAWSPinpoint from 'https://unpkg.com/@analytics/aws-pinpoint/lib/analytics-plugin-aws-pinpoint.browser.es.js?module'
      /* Initialize analytics */
      const Analytics = analytics({
        app: 'analytics-html-demo',
        debug: true,
        plugins: [
          analyticsAWSPinpoint({
            pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
            getCredentials: () => Auth.currentCredentials()
          })
          // ... add any other third party analytics plugins
        ]
      })

      /* Track a page view */
      analytics.page()

      /* Track a custom event */
      analytics.track('cartCheckout', {
        item: 'pink socks',
        price: 20
      })

      /* Identify a visitor */
      analytics.identify('user-id-xyz', {
        firstName: 'bill',
        lastName: 'murray'
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

analytics analytics-project analytics-plugin AWS Pinpoint

analytics-plugin-tab-events analytics-utils aws4fetch deepmerge

@infinitebrahmanuniverse/nolb-zan @everything-registry/sub-chunk-3220

0.4.2-beta.1

3 years ago

0.4.2-beta.0