遥测报告客户端

与遥测报告处接口的图书馆.

• 遥测报告客户端
  • 安装
  • 示例使用
    • 获取远程报告
    • 构建简易数字化过滤器
    • 已认证
  • 图标
  • 捐款
  • 许可证

安装

yarn add @esri/telemetry-reporting-client

示例使用

获取远程报告

import { getTelemetryReport } from '@esri/telemetry-reporting-client';

const requestParams = {
  scope: {
    hostname: 'hostname',
  },
  dateRange: {
    startDate: '2019-01-01',
    endDate: '2019-01-31',
  },
  metrics: ['page-views:count'],
};

const requestOptions = {
  httpMethod: 'POST',
  params: {},
  authentication: {
    token: 'token',
  },
  hubApiUrl: 'https://hubqa.arcgis.com',
  customDimensionsConfig: {
    details: 1,
    userType: 2,
    id: 16,
  },
};

const report = getTelemetryReport(requestParams, requestOptions)
  .then((response) => {
    data = response.data;
  })
  .catch((error) => {
    // Handle error
  });

构建简易数字化过滤器

import { buildSimpleDimensionFilters } from '@esri/telemetry-reporting-client';

const event = {
  category: 'Interaction',
  action: 'Download',
  label: 'Cache',
};

const dimensionFilters = buildSimpleDimensionFilters(event);

已认证

import { isAuthorized } from '@esri/telemetry-reporting-client';

const result = isAuthorized({
      itemId: '3ef',
      hostname: 'hubqa.arcgis.com',
      agoPortalUrl: 'https://qaext.arcgis.com/sharing/rest',
      hubApiUrl: 'https://hubqa.arcgis.com',
      token: 'token'
    })
    .then((response) => {
      return response;
    })
    .catch((error) => {
      // Handle error
    });

如果您已经获取了 AGO 用户, 您可以通过在用户中通过( 从而避免再次获取) , 使此调用更精确 :

import { ArcGISIdentityManager } from '@esri/arcgis-rest-request';
import { isAuthorized } from '@esri/telemetry-reporting-client';

// see https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-request/ArcGISIdentityManager/
const manager = await ArcGISIdentityManager.signIn(username, password)
const user = await manager.getUser();

const result = isAuthorized({
      itemId: '3ef',
      hostname: 'hubqa.arcgis.com',
      agoPortalUrl: 'https://qaext.arcgis.com/sharing/rest',
      hubApiUrl: 'https://hubqa.arcgis.com',
      user,
      token: 'token'
    })
    .then((response) => {
      return response;
    })
    .catch((error) => {
      // Handle error
    });

请注意,要获取目标项(如果是私人的),仍然需要该令牌.

图标

• yarn start: 此结构为 /dist 并按监视模式运行此工程, 这样任何您在内部保存的编辑 src 重建为 /dist。 。 。 .

• yarn build: 一次性建造到 /dist

• yarn test:运行完整的测试套房.

• yarn test:watch: 以监视模式运行完整的测试套件, 这样您所做的任何编辑都会重新运行测试 .

捐款

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

许可证

版权: 2022 Esri

根据Apache许可证第2.0版("License"); 您不得使用此文件,除非符合许可证. 您可在下列地点获得许可证副本:

http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )

除非适用的法律要求或书面同意,否则软件 根据许可证发放的是在“AS IS”BASIS上发放的, 没有任何明示或暗示的警告或条件. 有关许可的特定语言的许可证 许可证的限制.

许可证副本可到存放处索取 自由主义 文档.