什么是 Metadata API - 概览

本文档简要介绍了 Google Analytics(分析)Metadata API。有关该 API 的详细参考,请参阅 API 参考

简介

Metadata API 用于返回 Google Analytics(分析)报告 API 中提供的列(例如维度和指标)的列表和属性。返回的属性包括界面名称、说明、细分支持等。

您可以使用 Metadata API 执行以下操作:

  • 自动发现新列
  • 访问 Google Analytics(分析)Reporting API 的所有维度和指标属性

查看 实际的 Metadata API 响应,并参阅开发者指南,了解如何使用该 API。

概念性概览

Metadata API 的基本概念包括:

Metadata API 中的列资源代表单个维度或指标,包含该列的 Id 和其他属性等信息。一组 Column 资源表示 Reporting API 的所有维度和指标。

使用 API

在查询该 API 时,您需要指定希望为其提取元数据的报告类型。来自该 API 的响应将包含适用于该报告类型的所有列(即维度和指标)的集合。有关 API 响应和代码示例的详情,请参阅 Metadata API 参考指南;有关使用该 API 的详情,请参阅 Metadata API 开发者指南

API 访问权限

Metadata API 不要求进行身份验证和授权。它只要求您的应用在每次向 Analytics API 发送请求时标识自身的身份。如需详细了解如何执行此操作,请参阅开发者指南API 访问权限部分。

配额和弃用政策

Metadata API 需要处理数以百万计的操作。为避免系统收到的操作量超出其处理能力,并确保平均分配系统资源,我们需要采用配额机制。有关详情,请参阅限制和配额

如需详细了解如何处理对报告 API 列(即维度和指标)所做的更改,请参阅数据弃用政策。如需了解如何使用 Metadata API 检查已弃用的列,请参阅 Metadata API 开发者指南