Java idiomatic client for Analytics Data.
Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.
🚌 In October 2022, this library has moved to
google-cloud-java/java-analytics-data.
This repository will be archived in the future.
Future releases will appear in the new repository (https://github.com/googleapis/google-cloud-java/releases).
The Maven artifact coordinates (com.google.analytics:google-analytics-data) remain the same.
If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.analytics</groupId>
<artifactId>google-analytics-data</artifactId>
<version>0.16.0</version>
</dependency>If you are using Gradle without BOM, add this to your dependencies:
implementation 'com.google.analytics:google-analytics-data:0.16.0'If you are using SBT, add this to your dependencies:
libraryDependencies += "com.google.analytics" % "google-analytics-data" % "0.16.0"See the Authentication section in the base directory's README.
The client application making API calls must be granted authorization scopes required for the desired Analytics Data APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Analytics Data API calls.
You will need a Google Cloud Platform Console project with the Analytics Data API enabled.
You will need to enable billing to use Google Analytics Data.
Follow these instructions to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud SDK and running the following commands in command line:
gcloud auth login and gcloud config set project [YOUR PROJECT ID].
You'll need to obtain the google-analytics-data library. See the Quickstart section
to add google-analytics-data as a dependency in your code.
Analytics Data provides programmatic methods to access report data in Google Analytics App+Web properties.
See the Analytics Data client library docs to learn how to use this Analytics Data Client Library.
Samples are in the samples/ directory.
| Sample | Source Code | Try it |
|---|---|---|
| Get Common Metadata Sample | source code |  |
| Get Metadata By Property Id Sample | source code | |
| Quickstart Json Credentials Sample | source code | |
| Quickstart Sample | source code | |
| Run Batch Report Sample | source code | |
| Run Pivot Report Sample | source code | |
| Run Realtime Report Sample | source code | |
| Run Realtime Report With Multiple Dimensions Sample | source code | |
| Run Realtime Report With Multiple Metrics Sample | source code | |
| Run Report Sample | source code | |
| Run Report With Aggregations Sample | source code | |
| Run Report With Cohorts Sample | source code | |
| Run Report With Date Ranges Sample | source code | |
| Run Report With Dimension And Metric Filters Sample | source code | |
| Run Report With Dimension Exclude Filter Sample | source code | |
| Run Report With Dimension Filter Sample | source code | |
| Run Report With Dimension In List Filter Sample | source code | |
| Run Report With Multiple Dimension Filters Sample | source code | |
| Run Report With Multiple Dimensions Sample | source code | |
| Run Report With Multiple Metrics Sample | source code | |
| Run Report With Named Date Ranges Sample | source code | |
| Run Report With Ordering Sample | source code | |
| Run Report With Pagination Sample | source code | |
| Run Report With Property Quota Sample | source code | |
To get help, follow the instructions in the shared Troubleshooting document.
Analytics Data uses gRPC for the transport layer.
Java 8 or above is required for using this client.
Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).
In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.
Java 11 and (in September 2021) Java 17 are the best choices for new development.
Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).
Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.
Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.
The latest versions and the supported Java versions are identified on
the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME
and on google-cloud-java.
This library follows Semantic Versioning.
It is currently in major version zero (0.y.z), which means that anything may change at any time
and the public API should not be considered stable.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information how to get started.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.
Apache 2.0 - See LICENSE for more information.
| Java Version | Status |
|---|---|
| Java 8 |  |
| Java 8 OSX |  |
| Java 8 Windows |  |
| Java 11 |  |
Java is a registered trademark of Oracle and/or its affiliates.