快速入门:使用命令行

本页介绍了如何使用以下命令开始使用 Google Analytics Data API v1: 行。

第 1 步:启用 API

点击以下按钮,自动创建一个新的 Google Cloud 项目 启用 Google Analytics Data API v1,并创建用于此 API 的 OAuth2 凭据 教程:

启用 Google Analytics Data API v1

系统会自动将您重定向到 OAuth2 凭据配置 对话框。当对话框询问您从何处打电话?时,选择 桌面设备

在出现的对话框中,点击下载客户端配置并保存文件 credentials.json 到您的工作目录。

或者,您也可以按照这些步骤创建 OAuth2 凭据 项目。

第 2 步:安装并初始化 Cloud SDK

您需要使用 gcloud 命令行 工具。

第 3 步:进行 API 调用

现在,您可以使用 Google Analytics Data API 来查询 Google Analytics 属性。

选择举报实体

在本教程中,我们将使用环境变量 GA_PROPERTY_ID 来存储 要在 API 请求中使用的媒体资源 ID。

在命令行中输入以下命令,以设置 GA_PROPERTY_ID 变量:

export GA_PROPERTY_ID=[YOUR_GA_PROPERTY_ID]

[YOUR_GA_PROPERTY_ID] 替换为您的 Google Analytics 媒体资源 标识符。例如:

export GA_PROPERTY_ID=1234567890

创建请求 JSON

以下 request.json 文件演示了如何构建简单的报告。

创建包含以下文本的 JSON 请求文件,然后将其另存为 request.json 纯文本文件:

request.json

{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "country" }],
  "metrics": [{ "name": "activeUsers" }]
}

身份验证

如需在此示例中获取用户凭据,请运行以下命令并使用 在第 1 步中下载的凭据 JSON 文件的路径:

gcloud auth application-default login \
    --scopes=https://www.googleapis.com/auth/analytics.readonly \
    --client-id-file=[PATH/TO/credentials.json]

OAuth 用户意见征求对话框将在新的浏览器窗口中打开。

发送请求

使用 curlrequest.json 中的正文内容将请求发送到 Google Analytics Data API。在命令行中输入以下内容:

  curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
  -H "Content-Type: application/json; charset=utf-8" \
  https://analyticsdata.googleapis.com/v1beta/properties/$GA_PROPERTY_ID:runReport -d @request.json

curl 命令使用 gcloud auth application-default print-access-token 命令来获取身份验证令牌。

请注意,要将文件名传递给 curl,您可以使用 -d 选项(表示“数据”)和 在文件名前面加上 @ 符号。此文件应位于同一目录中 您需要在其中执行 curl 命令