google-analytics-data-api-basics
Manages Google Analytics reporting data, enables the Analytics Data API via the Cloud CLI, and creates reports using the Google Analytics Data API (v1beta). Use when you need to interact with Google Analytics properties, run customized analytics reports, query metrics (like activeUsers, screenPageViews) and dimensions (like city, date), check metrics and dimensions compatibility, or verify API enablement.
- License 许可
- MIT
- 最近更新
- 2026-10-08
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- google-analytics-data-api-basics
- description
- Manages Google Analytics reporting data, enables the Analytics Data API via the Cloud CLI, and creates reports using the Google Analytics Data API (v1beta). Use when you need to interact with Google Analytics properties, run customized analytics reports, query metrics (like activeUsers, screenPageViews) and dimensions (like city, date), check metrics and dimensions compatibility, or verify API enablement.
02 资源文件 7
- 参考文档references/dotnet.md2.0 KB
- 参考文档references/go.md1.8 KB
- 参考文档references/java.md2.6 KB
- 参考文档references/nodejs.md1.6 KB
- 参考文档references/php.md1.7 KB
- 参考文档references/python.md1.9 KB
- 参考文档references/ruby.md1.6 KB
03 SKILL.md 正文
Getting Started with Google Analytics Data API
The Google Analytics Data API v1beta provides programmatic access to Google Analytics report data. It allows you to build customized dashboards, automate reporting workflows, and integrate Google Analytics data into your enterprise applications.
Enabling the API via Cloud CLI
Before making API calls, ensure the Google Analytics Data API is enabled in your Google Cloud project.
If gcloud is not found, prompt the user to install the Google Cloud CLI before
running these commands.
-
Enable the API: Use the Cloud CLI (
gcloud) to enableanalyticsdata.googleapis.com.gcloud services enable analyticsdata.googleapis.com --quietWhy: Enabling the API ensures your Cloud project has the necessary quota and permissions allocated for running Google Analytics reports.
-
Verify API Enablement:
gcloud services list --enabled --filter="analyticsdata.googleapis.com"
Authentication
To authenticate your API requests, you must generate Application Default Credentials (ADC) and give your account the necessary scopes. Run the following command in your terminal:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"
Why: This configures ADC in your local environment with the required Cloud Platform and Google Analytics read-only scopes, allowing the client library to automatically authenticate your requests.
Creating a Data API Report (v1beta)
To create a report, use the official Google Analytics Data client library.
Always prefer the v1beta version of the API for stability and access to
current Google Analytics reporting capabilities.
[!IMPORTANT] Mandatory Agent Directive: When the user selects or requires a specific programming language, read the corresponding client library setup reference guide in
references/listed below.
Supported Client Libraries
Python
If you need to install or set up the Google Analytics Data API client library for Python, read the setup guide:
- Python Installation Reference (Package:
google-analytics-data)
Java
If you need to install or set up the Google Analytics Data API client library for Java, read the setup guide:
- Java Installation Reference (Artifact:
com.google.cloud:google-cloud-analytics-data)
PHP
If you need to install or set up the Google Analytics Data API client library for PHP, read the setup guide:
- PHP Installation Reference (Package:
google/analytics-data)
Node.js
If you need to install or set up the Google Analytics Data API client library for Node.js, read the setup guide:
- Node.js Installation Reference (Package:
@google-analytics/data)
Go
If you need to install or set up the Google Analytics Data API client library for Go, read the setup guide:
- Go Installation Reference (Package:
cloud.google.com/go/analytics/data/apiv1beta)
.NET
If you need to install or set up the Google Analytics Data API client library for .NET / C#, read the setup guide:
- .NET Installation Reference (Package:
Google.Analytics.Data.V1Beta)
Ruby
If you need to install or set up the Google Analytics Data API client library for Ruby, read the setup guide:
- Ruby Installation Reference (Gem:
google-analytics-data-v1beta)
[!NOTE] Additional Resources: For further examples of calling the Data API with Java, PHP, Node.js, .NET, Python and REST, as well as hints on authentication with a service account, refer to the official Data API Quickstart.
Python Quick Start
-
Install the Client Library:
pip install google-analytics-dataIf
pipis not available, prompt the user to installpipbefore installing the client library. -
Run a Report Request: Below is a complete example demonstrating how to query a Google Analytics property for active users and sessions grouped by city and date. Replace
YOUR-PROPERTY-IDwith your actual Google Analytics property ID (e.g.,1234567).from google.analytics.data_v1beta import BetaAnalyticsDataClient from google.analytics.data_v1beta.types import DateRange, Dimension, Metric, RunReportRequest def sample_run_report(property_id: str): # Initialize the client. # Assumes Application Default Credentials (ADC) are configured in your environment. client = BetaAnalyticsDataClient() request = RunReportRequest( property=f"properties/{property_id}", dimensions=[ Dimension(name="city"), Dimension(name="date") ], metrics=[ Metric(name="activeUsers"), Metric(name="sessions") ], date_ranges=[ DateRange(start_date="2026-05-01", end_date="today") ], ) response = client.run_report(request) print(f"Report result for property {property_id}:") for row in response.rows: print( f"City: {row.dimension_values[0].value}, " f"Date: {row.dimension_values[1].value}, " f"Active Users: {row.metric_values[0].value}, " f"Sessions: {row.metric_values[1].value}" ) if __name__ == "__main__": sample_run_report("YOUR-PROPERTY-ID")Why: Using
BetaAnalyticsDataClientandRunReportRequestensures compatibility with the v1beta endpoint and strongly typed request validation.
Metrics and Dimensions Schema
When constructing your RunReportRequest, you must use valid API names for
dimensions and metrics. Refer to the official
Data API Schema documentation
for the complete, authoritative list of available fields.
Commonly Used Dimensions
Dimensions represent categorical attributes of your data.
city: The town or city of the user.country: The country of the user.date: The date of the event, formatted as YYYYMMDD.deviceCategory: The category of mobile device (e.g., desktop, mobile, tablet).eventName: The name of the triggered event.pageTitle: The title of the web page.
Commonly Used Metrics
Metrics represent quantitative measurements.
activeUsers: The number of active users.eventCount: The total count of events.sessions: The total number of sessions.screenPageViews: The number of app screens or web pages viewed.totalRevenue: The total revenue from purchases, subscriptions, and advertising.
Metrics and Dimensions Compatibility Check
Some dimensions and metrics cannot be queried together in the same report
request. If you encounter an INVALID_ARGUMENT error regarding incompatible
fields, verify your field combinations For programmatic access to the Data API
schema, use getMetadata(). To programmatically check the compatibility of
specific dimension and metric combinations before running a report, use the
checkCompatibility() method.
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import CheckCompatibilityRequest, Compatibility, Dimension, Metric
def sample_check_compatibility(property_id: str):
client = BetaAnalyticsDataClient()
# Define the dimensions and metrics you want to query together.
# For example, checking if 'itemDescription' (an e-commerce dimension)
# is compatible with 'activeUsers' and 'totalRevenue'.
request = CheckCompatibilityRequest(
property=f"properties/{property_id}",
dimensions=[
Dimension(name="itemDescription"),
Dimension(name="date")
],
metrics=[
Metric(name="activeUsers"),
Metric(name="totalRevenue")
],
)
response = client.check_compatibility(request)
print(f"Compatibility check for property {property_id}:")
for dim in response.dimension_compatibilities:
is_compatible = dim.compatibility == Compatibility.COMPATIBLE
print(f"Dimension '{dim.dimension_metadata.api_name}' is compatible: {is_compatible}")
for metric in response.metric_compatibilities:
is_compatible = metric.compatibility == Compatibility.COMPATIBLE
print(f"Metric '{metric.metric_metadata.api_name}' is compatible: {is_compatible}")
if __name__ == "__main__":
sample_check_compatibility("YOUR-PROPERTY-ID")
04 同仓库更多 Skills
zkrouter
Self-hosted OpenAI-compatible LLM router — smart tier-based routing, ZK-stamped routing decisions, mode overrides, free OpenRouter at install via the Birth bot. Save 60-80% on inference costs by routing to the cheapest capable model across 12+ OpenRouter models.
zk
For custom ZK Solana programs and privacy-preserving applications to prevent double spending. Guide to integrate rent-free nullifier PDAs for double-spend prevention.
zk-omni-messaging
Zero-knowledge omnichain messaging between Robinhood Chain and Solana using CheshireZkOmniMessenger (msgType 4) with nullifier anti-replay and the zk-omni-relayer service.
zerion-wallet-data
Use when the user asks to check a wallet's portfolio, token balances, DeFi positions, PnL, transaction history, or NFTs. Provides interpreted on-chain data across 40+ EVM chains and Solana via x402 pay-per-request or API key — no raw RPC decoding needed.
youtube-clipper
YouTube 视频智能剪辑工具。下载视频和字幕,AI 分析生成精细章节(几分钟级别), 用户选择片段后自动剪辑、翻译字幕为中英双语、烧录字幕到视频,并生成总结文案。 使用场景:当用户需要剪辑 YouTube 视频、生成短视频片段、制作双语字幕版本时。 关键词:视频剪辑、YouTube、字幕翻译、双语字幕、视频下载、clip video
yield-optimization
Multi-chain yield optimization via yield.xyz (StakeKit). Discover 2,988+ yield opportunities across 75+ blockchains, build deposit/withdrawal transactions with shell scripts, and sign them with a MoonPay wallet. Use when the user wants to earn yield, find the best lending or staking rate, enter/exit a position, or check portfolio balances.