# @esri/telemetry-reporting-client 中文文档

规范地址：https://npmcn.com/package/%40esri/telemetry-reporting-client/

版本：4\.0\.0
npm 元数据更新时间：2025-10-31T20:21:44.087Z
中文译文更新时间：2026-11-13T22:51:06.335Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40esri/telemetry-reporting-client
原文对照：https://npmcn.com/package/%40esri/telemetry-reporting-client/?lang=original
项目主页：https://github.com/ArcGIS/telemetry-reporting-client#readme
源码仓库：https://github.com/ArcGIS/telemetry-reporting-client

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：220 kB，44 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10
- 运行依赖：3 个
- 首次发布：2022-04-28T13:46:07.084Z
- 最新版本发布：2025-04-22T16:19:15.632Z
- 近 30 天下载量：6395（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 0 个）

## 中文简介

\[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\]

## 安装

```sh
npm install @esri/telemetry-reporting-client
```

也可以使用：`pnpm add @esri/telemetry-reporting-client`、`yarn add @esri/telemetry-reporting-client`、`bun add @esri/telemetry-reporting-client`

## README

[![npm version](https://img.shields.io/npm/v/@esri/telemetry-reporting-client.svg?style=flat-square)](https://www.npmjs.com/package/@esri/telemetry-reporting-client) [![build status](https://github.com/ArcGIS/telemetry-reporting-client/actions/workflows/release.yml/badge.svg)](https://github.com/ArcGIS/telemetry-reporting-client/actions/workflows/release.yml) [![apache licensed](https://img.shields.io/badge/license-Apache%202.0-orange.svg?style=flat-square)](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-license)

# 遥测报告客户端

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

-   [遥测报告客户端](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-telemetry-reporting-client)
    -   [安装](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-installation)
    -   [示例使用](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-example-usage)
        -   [获取远程报告](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-gettelemetryreport)
        -   [构建简易数字化过滤器](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-buildsimpledimensionfilters)
        -   [已认证](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-isauthorized)
    -   [图标](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-commands)
    -   [捐款](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-contributing)
    -   [许可证](https://npmcn.com/package/%40esri/telemetry-reporting-client/#readme-license)

## 安装

```bash
yarn add @esri/telemetry-reporting-client
```

## 示例使用

### 获取远程报告

```js
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
  });
```

### 构建简易数字化过滤器

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

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

const dimensionFilters = buildSimpleDimensionFilters(event);
```

### 已认证

```js
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 用户, 您可以通过在用户中通过( 从而避免再次获取) , 使此调用更精确 :

```js
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欢迎所有人的贡献。 请看我们的 [提交文件的准则](https://npmcn.com/package/%40esri/telemetry-reporting-client/CONTRIBUTING.md)。 。 。 .

## 许可证

版权: 2022 Esri

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

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

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

许可证副本可到存放处索取 [自由主义](https://npmcn.com/package/%40esri/telemetry-reporting-client/LICENSE) 文档.

## 常见问题

### @esri/telemetry-reporting-client 是什么？

\[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\] \[永久失效連結\]

### 如何安装 @esri/telemetry-reporting-client？

在项目目录运行 npm install @esri/telemetry-reporting-client，或使用 pnpm add / yarn add / bun add。

### @esri/telemetry-reporting-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @esri/telemetry-reporting-client 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @esri/telemetry-reporting-client 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @esri/telemetry-reporting-client 可以商用吗？

@esri/telemetry-reporting-client 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @esri/telemetry-reporting-client 的下载量有多少？

根据 npm 官方下载统计，@esri/telemetry-reporting-client 在 2026/10/14 – 2026/11/12 这 30 天内被下载 6,395 次，日均约 213 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @esri/telemetry-reporting-client 还在维护吗？

最新版本 4\.0\.0 发布于 2025/04/23（1\.6 年前）；至今共发布 17 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/04/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。