lyxaira.glass 74ca844f42 Actualizacion cambios generados: seccion #12, #14 y #15. | 4 vuotta sitten | |
---|---|---|
.. | ||
lib | 4 vuotta sitten | |
node_modules | 4 vuotta sitten | |
license | 4 vuotta sitten | |
package.json | 4 vuotta sitten | |
readme.md | 4 vuotta sitten |
Understand how your tool is being used by anonymously reporting usage metrics to Google Analytics or Yandex.Metrica
$ npm install insight
Currently, Insight should be used with GA set up as web tracking due to use of URLs. Future plans include refactoring to work with GA set up for app-based tracking and the Measurement Protocol.
For debugging, Insight can track OS version, Node.js version, and version of the app that implements Insight. Please set up custom dimensions per below screenshot. This is a temporary solution until Insight is refactored into app-based tracking.
Insight cares deeply about the security of your user’s data and strives to be fully transparent with what it tracks. All data is sent via HTTPS secure connections. Insight provides API to offer an easy way for users to opt-out at any time.
Below is what Insight is capable of tracking. Individual implementation can choose to not track some items.
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
// Google Analytics tracking code
trackingCode: 'UA-XXXXXXXX-X',
pkg
});
// Ask for permission the first time
if (insight.optOut === undefined) {
insight.askPermission();
}
insight.track('foo', 'bar');
// Recorded in Analytics as `/foo/bar`
insight.trackEvent({
category: 'eventCategory',
action: 'eventAction',
label: 'eventLabel',
value: 'eventValue'
});
// Recorded in Analytics behavior/events section
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
// Yandex.Metrica counter id
trackingCode: 'XXXXXXXXX'
trackingProvider: 'yandex',
pkg
});
// Ask for permission the first time
if (insight.optOut === undefined) {
insight.askPermission();
}
insight.track('foo', 'bar');
// Recorded in Yandex.Metrica as `http://<package-name>.insight/foo/bar`
Required
Type: string
Your Google Analytics trackingCode or Yandex.Metrica counter id.
Type: string
Default: google
Values: google
yandex
Tracking provider to use.
Required
Type: string
Type: string
Default: 'undefined'
Type: Object
Default: An instance of conf
If you want to use your own configuration mechanism instead of the default conf
-based one, you can provide an object that has to implement two synchronous methods:
get(key)
set(key, value)
Accepts keywords which ends up as a path in Analytics.
.track('init', 'backbone')
becomes /init/backbone
Accepts event category, action, label and value as described in the GA event tracking documentation via the options object. Note: Does not work with Yandex.Metrica.
.trackEvent({
category: 'download',
action: 'image',
label: 'logo-image'
});
Required
Type: string
Event category: Typically the object that was interacted with (e.g. ‘Video’).
Required
Type: string
Event action: The type of interaction (e.g. ‘play’).
Type: string
Event label: Useful for categorizing events (e.g. ‘Fall Campaign’).
Type: integer
Event value: A numeric value associated with the event (e.g. 42).
Asks the user permission to opt-in to tracking and sets the optOut
property in config
. You can also choose to set optOut
property in config
manually.
Optionally supply your own message
and callback
. If message
is null
, default message will be used. The callback will be called with the arguments error
and optIn
when the prompt is done and is useful for when you want to continue the execution while the prompt is running.
Returns a boolean whether the user has opted out of tracking. Should preferably only be set by a user action, eg. a prompt.
BSD-2-Clause © Google