Google Analytics Data API Basics
GoogleOfficialPublished by Google
- Skill
- Tool integration
- Data and AI
- Apache-2.0
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a comprehensive guide for interacting with the Google Analytics Data API (v1beta). It covers the necessary steps to enable the API via the Google Cloud CLI, configure Application Default Credentials, and implement reporting logic across multiple programming languages including Python, Java, PHP, Node.js, Go, .NET, and Ruby. It focuses on programmatic data retrieval, such as querying metrics and dimensions, and includes best practices for verifying field compatibility to ensure successful report generation.
What it does
- Enables the Google Analytics Data API within Google Cloud projects.
- Configures local authentication using Application Default Credentials.
- Provides setup instructions for seven major programming language client libraries.
- Demonstrates how to construct and execute customized report requests.
- Explains how to programmatically check the compatibility of metrics and dimensions.
- Offers guidance on accessing the authoritative API schema for reporting fields.
When to use it
- When you need to build custom dashboards or automated reporting workflows.
- When integrating Google Analytics data into enterprise applications.
- When you need to query specific metrics and dimensions programmatically.
- When troubleshooting 'INVALID_ARGUMENT' errors related to incompatible field combinations.
Advantages
- Supports a wide range of popular programming languages.
- Ensures stable and current reporting via the v1beta endpoint.
- Includes built-in methods for validating report requests before execution.
- Streamlines the setup process with clear CLI commands and authentication steps.
Usage examples
- “How do I enable the Google Analytics Data API for my project?”
- The agent provides the gcloud CLI command to enable analyticsdata.googleapis.com and the command to verify its status.
- “Show me how to query active users by city using Python.”
- The agent provides a Python code snippet using the BetaAnalyticsDataClient to run a report with the specified dimensions and metrics.
- “How do I check if 'itemName' and 'totalRevenue' can be queried together?”
- The agent provides a code example using the checkCompatibility method to verify if the requested dimensions and metrics are compatible.
- “I need to set up the Google Analytics Data API for a .NET project.”
- The agent directs you to the .NET installation reference and provides the NuGet command to add the required package.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/google/google-analytics-data-api-basics/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip google-analytics-data-api-basics.zip -d .agents/skills
Documentation by Google
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 'itemName' (an e-commerce dimension)
# is compatible with 'activeUsers' and 'totalRevenue'.
request = CheckCompatibilityRequest(
property=f"properties/{property_id}",
dimensions=[
Dimension(name="itemName"),
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")Files
- ATTRIBUTION.mdAdded by AutoGineer886 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md9.4 KiB
- references/dotnet.md2.0 KiB
- references/go.md1.8 KiB
- references/java.md2.6 KiB
- references/nodejs.md1.6 KiB
- references/php.md1.7 KiB
- references/python.md1.9 KiB
- references/ruby.md1.6 KiB
LICENSE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs a command-line tool, Needs Python
Security
What our scanner noticed· Low risk
- Instructions that use the network
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Publisher
- Google (Official)
- Source
- google/skills · skills/analytics/google-analytics-data-api-basics · commit 2194d3b
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Google or Google.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download google-analytics-data-api-basics.zip