本页介绍了如何通过命令行开始使用 Google Analytics(分析)Data API v1。
第 1 步:启用 API
点击此按钮可创建一个新的 Cloud Platform 项目,自动启用 Google Analytics(分析)Data API v1,并创建本教程所需的 OAuth2 凭据:
启用 Google Analytics(分析)Data API v1系统会自动将您重定向到 OAuth2 凭据配置对话框。当系统询问“您是来自哪里?”时,选择“桌面设备”
在随即显示的对话框中,点击下载客户端配置,并将文件 credentials.json
保存到您的工作目录中。
或者,您也可以按照这些步骤在现有项目中手动创建 OAuth2 凭据。
第 2 步:安装并初始化 Cloud SDK
您需要在开发机器上安装 gcloud 命令行工具。
第 3 步:进行 API 调用
现在,您可以使用 Google Analytics(分析)Data API 来查询 Google Analytics(分析)4 媒体资源。
选择举报实体
在本教程中,我们将使用环境变量 GA4_PROPERTY_ID
存储要在 API 请求中使用的属性 ID。
在命令行中输入以下命令,以设置 GA4_PROPERTY_ID
变量:
export GA4_PROPERTY_ID=[YOUR-GA4-PROPERTY-ID]
将 [YOUR-GA4-PROPERTY-ID] 替换为您的 Google Analytics(分析)4 媒体资源标识符。例如:
export GA4_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 用户意见征求对话框。
发送请求
使用 curl
和 request.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/$GA4_PROPERTY_ID:runReport -d @request.json
curl
命令使用 gcloud auth application-default print-access-token
命令获取身份验证令牌。
请注意,如需将文件名传递给 curl,您可以使用 -d
选项(表示“数据”)并在文件名前面加上 @ 符号。此文件应该位于您执行 curl 命令所在的目录中。
恭喜!您已向 Google Analytics(分析)Data API 发送了第一个请求。