This page shows you how to get started with the Google Analytics Admin API in your favorite programming language using the client Libraries.
Step 1. Enable the API
Click this button to create a new Cloud Platform project and automatically enable the Google Analytics Admin API:
Enable the Google Analytics Admin APIIn resulting dialog click DOWNLOAD CLIENT CONFIGURATION and save the file
credentials.json to your working directory.
Step 2. Configure authentication
This application demonstrates the usage of the Google Analytics Admin API using service account credentials.
Read more for instructions on creating and setting service account credentials for your application.
An easy way to provide service account credentials is by setting the GOOGLE_APPLICATION_CREDENTIALS environment variable, the API client will use the value of this variable to find the service account key JSON file.
To set the application credentials in this example, run the following command and use the path to the service account JSON file downloaded at Step 1:
export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
For example:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service_account.json"
Step 3. Install the client library
Java
Python
Node.js
Ruby
Go
go get google.golang.org/genproto/googleapis/analytics/admin/v1alpha
.NET
Make an API call
Now you can use the Google Analytics Admin API to list the Google Analytics accounts. Run the following code to perform your first call to the API:
Java
import com.google.analytics.admin.v1beta.Account;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPage;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPagedResponse;
import com.google.analytics.admin.v1beta.ListAccountsRequest;
public class QuickstartSample {
public static void main(String... args) throws Exception {
listAccounts();
}
// This is an example snippet that calls the Google Analytics Admin API and lists all Google
// Analytics accounts available to the authenticated user.
static void listAccounts() throws Exception {
// Instantiates a client using default credentials.
// See https://cloud.google.com/docs/authentication/production for more information
// about managing credentials.
try (AnalyticsAdminServiceClient analyticsAdmin = AnalyticsAdminServiceClient.create()) {
// Calls listAccounts() method of the Google Analytics Admin API and prints
// the response for each account.
ListAccountsPagedResponse response =
analyticsAdmin.listAccounts(ListAccountsRequest.newBuilder().build());
for (ListAccountsPage page : response.iteratePages()) {
for (Account account : page.iterateAll()) {
System.out.printf("Account name: %s%n", account.getName());
System.out.printf("Display name: %s%n", account.getDisplayName());
System.out.printf("Country code: %s%n", account.getRegionCode());
System.out.printf("Create time: %s%n", account.getCreateTime().getSeconds());
System.out.printf("Update time: %s%n", account.getUpdateTime().getSeconds());
System.out.println();
}
}
}
}
}
Python
def list_accounts(transport: str = None):
"""
Lists the available Google Analytics accounts.
Args:
transport(str): The transport to use. For example, "grpc"
or "rest". If set to None, a transport is chosen automatically.
"""
from google.analytics.admin import AnalyticsAdminServiceClient
# Using a default constructor instructs the client to use the credentials
# specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
client = AnalyticsAdminServiceClient(transport=transport)
results = client.list_accounts()
# Displays the configuration information for all Google Analytics accounts
# available to the authenticated user.
print("Result:")
for account in results:
print(account)
Node.js
// Imports the Google Analytics Admin API client library
const analyticsAdmin = require('@google-analytics/admin');
async function main() {
// Instantiates a client using default credentials.
// TODO(developer): uncomment and use the following line in order to
// manually set the path to the service account JSON file instead of
// using the value from the GOOGLE_APPLICATION_CREDENTIALS environment
// variable.
// const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient(
// {keyFilename: "your_key_json_file_path"});
const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient();
// Calls listAccounts() method of the Google Analytics Admin API and prints
// the response for each account.
const [accounts] = await analyticsAdminClient.listAccounts();
console.log('Accounts:');
accounts.forEach(account => {
console.log(account);
});
}
main(...process.argv.slice(2)).catch(err => {
console.error(err.message);
process.exitCode = 1;
});
process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});
Ruby
Go
.NET
using Google.Analytics.Admin.V1Alpha;
using System;
namespace AnalyticsSamples
{
class QuickStart
{
static void Main(string[] args)
{
var client = AnalyticsAdminServiceClient.Create();
var response = client.ListAccounts( new ListAccountsRequest() );
foreach( Account account in response )
{
Console.WriteLine("Account name: {0}", account.Name);
Console.WriteLine("Display name: {0}", account.DisplayName);
Console.WriteLine("Country code: {0}", account.CountryCode);
Console.WriteLine("Update time: {0}", account.UpdateTime);
Console.WriteLine("Create time: {0}", account.CreateTime);
Console.WriteLine();
}
}
}
}
Congratulations! You've sent your first request to the Google Analytics Admin API.