@esri/telemetry-google-analytics

这是一个插件,用于 Telemetry.js 使用 Google Analytics 4 发送数据到 Google Analytics 的软件包.

目录

• @esri/telemetry-google-analytics
  • 目录
  • 安装
  • 如何使用
    • 浏览器
    • 服务器
  • Google 分析配置
  • 问题
  • 捐款
  • 许可证

安装

npm install @esri/telemetry
npm install @esri/telemetry-google-analytics

如何使用

@esri/telemetry-google-analytics 软件包在客户端浏览器和服务器端节点.js中工作. 要使用,安装软件包,将软件包纳入您的工程,创建插件实例,并添加到 plugins 以 @esri/遥测

以下为如何使用浏览器插件的例子.

浏览器

import { Telemetry } from '@esri/telemetry'
import { GoogleAnalytics } from '@esri/telemetry-google-analytics'

const googleAnalyticsTracker = new GoogleAnalytics({
  measurementIds: [...], // required: fill in measurementIds
  metrics: {}, // optional
  dimensions: {} // optional
})

const telemetryOptions = {
  plugins: [googleAnalyticsTracker],
  portal: {
    subscriptionInfo: {},
    user: {},
  },
}

const telemetry = new Telemetry(telemetryOptions)
await telemetry.init();

telemetry.logPageView({page: 'home'}) // Required
telemetry.logEvent({
  action: 'Dataset', // Required, or will become 'other'
})


telemetry.logPageView({ page: 'home', event: {duration: 60, serviceQuery: 19 }})
telemetry.logEvent({ action: 'Dataset', duration: 4, datasetID: 'ID-XXXXXXX' })

服务器

import { Telemetry } from '@esri/telemetry';
import { GoogleAnalytics } from '@esri/telemetry-google-analytics';

const googleAnalyticsTracker = new GoogleAnalytics({
  measurementIds: [...], // required: fill in measurementIds
  metrics: {}, // optional
  dimensions: {} // optional
});

const telemetryOptions = {
  plugins: [googleAnalyticsTracker],
  portal: {
    subscriptionInfo: {},
    user: {},
  },
};

const telemetry = new Telemetry(telemetryOptions);

const scriptTags = telemetry.getScriptTags();

初始化后 Telemetry.js 与 telemetry-google-analytics 插件,遥测数据将发送到Google Analytics 4 example 与所提供的测量ID相关.

自定义计量和/或自定义维度(可选)

要使用自定义的度量衡或自定义维度,您需要通过您创建 GoogleAnatics 实例时的度量和维度. 每一模式应采用 dimensionName: Index 财务报告和审定财务报表 metricName: Index,像这样:

const googleAnalyticsTracker = new GoogleAnalytics({
  dimensions: {
    datasetID: 1,
    attribute: 2,
    serviceQuery: 3,
  },
  metrics: {
    duration: 1,
    size: 2,
  },
});

后来,当你打电话 logPageView 财务报告和审定财务报表 logEvent 并想提及这些自定义度量衡,您可以在事件数据内以下列格式通过: metricName: metricAmount 财务报告和审定财务报表 dimensionName: dimensionValue,像这样:

googleAnalyticsTracker.logPageView({page: 'homepage', event: {duration: 30, serviceQuery: 1}});

googleAnalyticsTracker.logEvent({ action: 'Dataset', duration: 20, datasetID: 220130});

如果您需要禁用跟踪, 您可以设定 disabled: true 初始化时 Telemetry 对象。 然后,你可以继续使用 方法在你的例子 Telemetry 没有丢弃例外 或记录错误.

初始化后,可以禁用并启用特定的跟踪器 disableTracker 财务报告和审定财务报表 enableTracker 方法。 。 .

telemetry.disableTracker('googleAnalytics');

telemetry.logPageView(); // no google analytics page view logged

telemetry.logEvent(); // no google analytics event logged

telemetry.enableTracker('googleAnalytics');

telemetry.logPageView(); // google analytics page view logged

telemetry.logEvent(); // google analytics event logged

问题

如果有什么不起作用,请看一看 以往问题 先说 你找到新窃听器了吗? 创建问题 这里。 。 。 .

捐款

Esri欢迎所有人的贡献。 请看我们的 提交文件的准则。 。 。 .

许可证