Google Analytics(GA4)
Google Analytics(GA4) · 66 个端点
- 为你的账户运行 GA4 数据访问报告accounts.runAccessReport — 返回一份定制的数据访问记录报告。报告提供用户每次读取 Google Analytics 报告数据时的记录。访问记录最多保留 2 年。数据访问报告可按媒体资源申请。报告可针对任意媒体资源申请,但非配额相关的维度只能在 Google Analytics 360 媒体资源上申请。
- 搜索 GA4 账户的变更历史accounts.searchChangeHistoryEvents — 按指定筛选条件搜索一个账户或其子资源的所有变更。仅返回该 API 支持的变更子集,界面可能额外显示其他变更。
- 按账户 ID 查询 GA4 账户数据共享设置accounts.getDataSharingSettings — 获取某个账户的数据共享设置。数据共享设置是单例。
- 按账户 ID 软删除 GA4 账户accounts.delete — 将目标账户标记为软删除(即“放入回收站”)并返回。该 API 没有恢复软删除账户的方法,但可以通过“回收站”界面恢复。如果在到期时间前未恢复,该账户及其所有子资源(如媒体资源、GoogleAdsLinks、数据流、AccessBindings)将被永久清除。
- 按账户 ID 查询 GA4 账户详情accounts.get — 查询单个账户。
- 列出你的 GA4 账户accounts.list — 返回调用方有权访问的所有账户。请注意这些账户当前可能还没有 GA 媒体资源。软删除(即“放入回收站”)的账户默认被排除。找不到相关账户时返回空列表。注:检索你有权访问的全部媒体资源,最简单的方式是使用 `ListAccountSummaries`。
- 列出你的 GA4 账户与媒体资源摘要accountSummaries.list — 返回调用方有权访问的所有账户摘要。
- 更新 GA4 账户设置accounts.patch — 更新账户。
- 在 GA4 媒体资源上创建受众导出audienceExports.create — 创建一个供后续读取的受众导出。该方法会立即返回受众导出的资源名,并启动一个耗时较长的异步请求来生成受众导出。要导出受众中的用户,请先通过此方法创建受众导出,再把受众资源名传给 `QueryAudienceExport` 方法。
- 按导出 ID 查询 GA4 受众导出元数据audienceExports.get — 获取某个受众导出的配置元数据。受众导出创建之后,可用该方法了解其情况。受众导出 API 部分方法仍处于 alpha 或更早阶段。
- 列出 GA4 媒体资源上的受众导出audienceExports.list — 列出某个媒体资源的全部受众导出。可用该方法查找并复用已有的受众导出,避免创建多余的新导出。同一个受众可以有多个受众导出,分别代表不同日期该受众里的用户。
- 列出 GA4 受众导出中的用户audienceExports.query — 获取某个受众导出中的用户。创建受众后,用户不会立刻可供导出:先调用 `CreateAudienceExport` 创建用户受众导出,再用本方法获取该导出中的用户。
- 归档 GA4 媒体资源上的自定义维度customDimensions.archive — 归档媒体资源上的某个 CustomDimension。
- 在 GA4 媒体资源上创建自定义维度customDimensions.create — 创建一个 CustomDimension。
- 按维度 ID 查询 GA4 自定义维度详情customDimensions.get — 查询单个 CustomDimension。
- 列出 GA4 媒体资源上的自定义维度customDimensions.list — 列出媒体资源上的所有 CustomDimension。
- 更新 GA4 媒体资源上的自定义维度customDimensions.patch — 更新媒体资源上的某个 CustomDimension。
- 归档 GA4 媒体资源上的自定义指标customMetrics.archive — 归档媒体资源上的某个 CustomMetric。
- 在 GA4 媒体资源上创建自定义指标customMetrics.create — 创建一个 CustomMetric。
- 按指标 ID 查询 GA4 自定义指标详情customMetrics.get — 查询单个 CustomMetric。
- 列出 GA4 媒体资源上的自定义指标customMetrics.list — 列出媒体资源上的所有 CustomMetric。
- 更新 GA4 媒体资源上的自定义指标customMetrics.patch — 更新媒体资源上的某个 CustomMetric。
- GA4 媒体资源数据保留设置properties.getDataRetentionSettings — 返回该媒体资源的单例数据保留设置。
- 更新 GA4 媒体资源的数据保留设置properties.updateDataRetentionSettings — 更新该媒体资源的单例数据保留设置。
- 在 GA4 媒体资源上创建数据流dataStreams.create — 创建一个 DataStream。
- 从 GA4 媒体资源删除数据流dataStreams.delete — 删除媒体资源上的某个 DataStream。
- 按数据流 ID 查询 GA4 数据流详情dataStreams.get — 查询单个 DataStream。
- 列出 GA4 媒体资源上的数据流dataStreams.list — 列出媒体资源上的所有 DataStream。
- 更新 GA4 媒体资源上的数据流dataStreams.patch — 更新媒体资源上的某个 DataStream。
- 将 Firebase 关联到 GA4 媒体资源firebaseLinks.create — 创建一个 FirebaseLink。每个媒体资源最多只能有一个 FirebaseLink。
- 从 GA4 媒体资源删除 Firebase 关联firebaseLinks.delete — 删除媒体资源上的某个 FirebaseLink
- 列出 GA4 媒体资源上的 Firebase 关联firebaseLinks.list — 列出媒体资源上的 FirebaseLink。每个媒体资源最多只能有一个 FirebaseLink。
- 将 Google Ads 关联到 GA4 媒体资源googleAdsLinks.create — 创建一个 GoogleAdsLink。
- 从 GA4 媒体资源删除 Google Ads 关联googleAdsLinks.delete — 删除媒体资源上的某个 GoogleAdsLink
- 列出 GA4 媒体资源上的 Google Ads 关联googleAdsLinks.list — 列出媒体资源上的 GoogleAdsLink。
- 更新 GA4 媒体资源上的 Google Ads 关联googleAdsLinks.patch — 更新媒体资源上的某个 GoogleAdsLink
创建关键事件
- 创建 GA4 转化事件(已弃用)conversionEvents.create — 已弃用:请改用 `CreateKeyEvent`。创建具有指定属性的转化事件。
- 在 GA4 媒体资源上创建关键事件keyEvents.create — 创建一个关键事件。
删除关键事件
- 删除 GA4 转化事件(已弃用)conversionEvents.delete — 已弃用:请改用 `DeleteKeyEvent`。删除媒体资源中的转化事件。
- 从 GA4 媒体资源删除关键事件keyEvents.delete — 删除一个关键事件。
关键事件详情
- GA4 转化事件详情(已弃用)conversionEvents.get — 已弃用:请改用 `GetKeyEvent`。获取单个转化事件。
- 按关键事件 ID 查询 GA4 关键事件详情keyEvents.get — 获取单个关键事件。
关键事件列表
- 列出 GA4 转化事件(已弃用)conversionEvents.list — 已弃用:请改用 `ListKeyEvents`。返回指定父媒体资源中的转化事件列表;未找到转化事件时返回空列表。
- 列出 GA4 媒体资源上的关键事件keyEvents.list — 返回指定父媒体资源中的关键事件列表;未找到关键事件时返回空列表。
更新关键事件
- 更新 GA4 转化事件(已弃用)conversionEvents.patch — 已弃用:请改用 `UpdateKeyEvent`。更新具有指定属性的转化事件。
- 更新 GA4 媒体资源上的关键事件keyEvents.patch — 更新一个关键事件。
- 在 GA4 数据流上创建 Measurement Protocol 密钥measurementProtocolSecrets.create — 创建一个 Measurement Protocol 密钥。
- 从 GA4 数据流删除 Measurement Protocol 密钥measurementProtocolSecrets.delete — 删除目标 MeasurementProtocolSecret。
- 按密钥 ID 查询 GA4 Measurement Protocol 密钥measurementProtocolSecrets.get — 查询单个 MeasurementProtocolSecret。
- 列出 GA4 数据流上的 Measurement Protocol 密钥measurementProtocolSecrets.list — 返回指定父媒体资源下的子 MeasurementProtocolSecret。
- 更新 GA4 数据流上的 Measurement Protocol 密钥measurementProtocolSecrets.patch — 更新某个 Measurement Protocol 密钥。
- 列出 GA4 媒体资源的维度与指标列出你的 GA4 媒体资源支持的维度和指标,含自定义项
- 一次批量运行多个 GA4 数据透视报告properties.batchRunPivotReports — 批量返回多个数据透视报告。所有报告必须属于同一个 Google Analytics 媒体资源。
- 按媒体资源 ID 运行 GA4 数据透视报告properties.runPivotReport — 返回基于 Google Analytics 事件数据的定制数据透视报告。数据透视报告是比普通报告更高级、表达力更强的格式。在数据透视报告中,维度只有包含在某个透视中才可见。可指定多个透视,进一步拆解数据。
- 为你的媒体资源运行 GA4 数据访问报告properties.runAccessReport — 返回一份定制的数据访问记录报告。报告提供用户每次读取 Google Analytics 报告数据时的记录。访问记录最多保留 2 年。数据访问报告可按媒体资源申请。报告可针对任意媒体资源申请,但非配额相关的维度只能在 Google Analytics 360 媒体资源上申请。
- 确认 GA4 用户数据收集条款properties.acknowledgeUserDataCollection — 确认指定媒体资源的用户数据收集条款。必须先完成该确认(在 Google Analytics 界面中或通过此 API),才能创建 MeasurementProtocolSecret 资源。
- 创建 GA4 媒体资源properties.create — 按指定的位置和属性创建一个 Google Analytics 媒体资源。
- 按媒体资源 ID 软删除 GA4 媒体资源properties.delete — 将目标媒体资源标记为软删除(即“放入回收站”)并返回。该 API 没有恢复软删除媒体资源的方法,但可以通过“回收站”界面恢复。如果在到期时间前未恢复,该媒体资源及其所有子资源(如 GoogleAdsLinks、数据流、AccessBindings)将被永久清除。
- 按媒体资源 ID 查询 GA4 媒体资源详情properties.get — 查询单个 GA 媒体资源。
- 列出账户下的 GA4 媒体资源properties.list — 返回指定父账户下的子媒体资源。调用方无权访问的媒体资源会被排除。软删除(即“放入回收站”)的媒体资源默认被排除。找不到相关媒体资源时返回空列表。
- 更新 GA4 媒体资源设置properties.patch — 更新一个媒体资源。
- GA4 实时活跃用户(按页面、来源、国家)查看此刻你网站上的访客(按页面、来源和国家划分的活跃用户)
- 按媒体资源 ID 运行自定义 GA4 报告在你自己的 Google Analytics 媒体资源上运行流量或行为报告
- 一次批量运行多个 GA4 报告properties.batchRunReports — 批量返回多个报告。所有报告必须属于同一个 Google Analytics 媒体资源。
- 检查 GA4 维度与指标的兼容性properties.checkCompatibility — 该兼容性方法列出可加入报告请求且保持兼容的维度和指标。若请求中的维度与指标不兼容,该方法会失败。在 Google Analytics 中,请求不兼容的维度和/或指标会导致报告失败,此时需要从请求中移除不兼容的维度和/或指标。
账号与工具类端点
- 申请 GA4 账户创建凭据accounts.provisionAccountTicket — 申请一个用于创建账户的凭据。
这些端点可以调用,但不在目录的浏览面上。