Google Analytics(分析)4 Data API 概览

您可以使用 Data API 以编程方式访问 Google Analytics(分析)4 (GA4) 报告数据。此 API 与旧版 Universal Analytics 媒体资源不兼容。

详细了解 Google Analytics(分析)4 媒体资源

下面是一些您可以提供关于使用 Google Analytics(分析)Data API v1 的报告示例:

  • 上周您的 Android 应用的每日活跃用户数量。
  • 过去 28 天内,您网站上的前 10 个网页获得的网页浏览量。
  • 过去 30 分钟内,您的 iOS 应用在各个国家/地区的活跃用户数。

您还可以使用 Google Analytics(分析)Data API v1 执行以下操作:

  • 构建自定义信息中心,以展示 Google Analytics(分析)数据。
  • 自动完成复杂的报告任务,从而节约时间。
  • 将 Google Analytics(分析)数据与其他业务应用集成。

开始使用

要开始使用,请参阅客户端库快速入门。我们提供了 Java、Python、Node.js 和其他语言的客户端库,以简化实现。

可用的方法

下面列出了 Data API 方法。如需了解详情,请参阅参考文档

  • runReport 此方法会返回 Google Analytics(分析)事件数据的自定义报告,是简单报告查询的首选方法。
  • batchRunReports 这是 runReport 方法的批量版本,可让您使用单个 API 调用生成多个报告。
  • runPivotReport 此方法会返回您的 Google Analytics(分析)事件数据的自定义透视报告。与常规报告相比,数据透视报告是更高级且更具表现力的格式。每个数据透视都描述了报告响应中的可见维度列和行。
  • batchRunPivotReports 这是 runPivotReport 方法的批处理版本,可让您使用单个 API 调用生成多个报告。
  • getMetadata 此方法会返回报告方法中提供的维度和指标的元数据。用于探索维度和指标。此方法的响应还包含适用于指定 GA4 媒体资源的自定义维度和指标。
  • checkCompatibility 此方法会列出可添加到报告请求并保持兼容性的维度和指标。
  • runRealtimeReport 此方法会针对您的媒体资源返回自定义的实时事件数据报告。事件发送到 Google Analytics(分析)几秒钟后,就会显示在实时报告中。实时报告会显示从现在到 30 分钟前(对于 Google Analytics 360 媒体资源,最长为 60 分钟)一段时间内的事件和使用情况数据。
  • properties.audienceExports 一组方法,可让您生成受众群体导出,其中包括受众群体中用户的快照。
  • properties.recurringAudienceLists (早期预览版)一组方法,可用于管理周期性受众群体导出。周期性受众群体导出每天都会生成新的受众群体名单。
  • runFunnelReport (早期预览版)此方法会返回 Google Analytics(分析)事件数据的自定义漏斗报告。借助漏斗探索,您可以直观了解用户为完成任务而采取的步骤,并快速了解用户在每个步骤的表现。

支持的维度和指标

如需查看 Data API 支持的所有维度和指标的列表,请参阅 API 架构文档