标准查询参数

以下查询参数可用于该 API 中的所有方法和所有资源。

下表显示了适用于所有 Analytics Reporting API v4 操作的查询参数。

备注(关于 API 密钥和授权令牌):

  1. 每个请求均需要 key 参数,除非您在请求中提供了 OAuth 2.0 令牌
  2. 必须为每个需要 OAuth 范围的请求发送授权令牌。OAuth 2.0 是唯一受支持的授权协议。
  3. 您可以通过以下两种方式中的任何一个为任何请求提供 OAuth 2.0 令牌:
    • 使用如下所示的 access_token 查询参数:?access_token=oauth2-token
    • 使用如下所示的 HTTP Authorization 标头:Authorization: Bearer oauth2-token

除特别备注外,以下所有参数均是可选的。

参数 含义 备注
access_token 适合当前用户的 OAuth 2.0 令牌。
alt

响应的数据格式。

  • 有效值:json、media、proto
  • 默认值:json
fields 用于指定要包含在响应中的字段子集的选择器。
  • 有关详情,请参阅“性能提示”文档中的部分响应一节。
  • 用于提升性能。
key API 密钥。(必填*)
  • *必填(除非您提供 OAuth 2.0 令牌)。
  • 您的 API 密钥用于确定您的项目,并且为您提供 API 访问权限、配额和报告。
  • 通过 Google API 控制台获取项目的 API 密钥。
prettyPrint

返回带有缩进和换行符的响应。

  • 如果该参数的值为 true,系统会以用户可读的格式返回响应。
  • 默认值:true
  • 如果该参数的值为 false,则可以降低响应的负载量,进而在某些环境中提升性能。
quotaUser 作为用户唯一标识的任意字符串。
  • 即使不知道用户的 IP 地址,您也可以通过服务器端的应用,强制执行每个用户的配额限制。例如,当应用代表用户在 App 引擎上运行定时任务时,会发生此类情况。
  • 您可以选择任意字符串用作辨别用户的唯一标识符,但字符数不能超过 40 个。
  • 详细了解设置 API 使用上限