This document explains how to use the Management API to access Web Property data.
A Google Analytics web property is at the second level in the account hierarchy; each Webproperty has a single account resource as its parent and can have a child that is a collection of one or more view (profile) resources.
- Read the entity overview in the Management API overview guide to understand how web properties relate to other Management API entities.
- Read the Accounts & Views (Profiles) conceptual guide for general information about web properties.
A Google Analytics web property is important because all data collection
happens at this level. For example when you add tracking code to
a web site or mobile application, you must include an ID that looks like
UA-xxxxx-y. This ID is called a web property ID and
distinguishes in which Google Analytics account data is stored.
Before You Begin
- Read the client libraries page for a complete list of programming language specific client libraries that work with the Management API.
- Read the Reference Guide to access the API without a client library
Each client library provides a single
Analytics service object
to access all Management API data. To create the service object
you generally have to go through the following steps:
- Register your application in the Google Developers Console.
- Authorize access to Google Analytics data.
- Create an
If you haven't completed these steps, please stop and read the Hello Google Analytics API Tutorial. This tutorial will walk you through the initial steps of building a Google Analytics API application. Once complete, you will be able to use this guide to perform real-world tasks.
The following code snippet continues from step 3: Create an Analytics service object and contains a variable to store an authorized service object.
Analytics analytics = // Read Hello Analytics Tutorial for details.
analytics = # Read Hello Analytics Tutorial for details.
$client = // Read Hello Analytics Tutorial for details. // Return results as objects. $client->setUseObjects(true); $analytics = new apiAnalyticsService($client);
The PHP library will return all the API results as an associative array. To return real
objects instead, you can call the client
as demonstrated in the example above.
Once you create an
Analytics service object, you are ready to make requests to
the Management API.
Note: The same
Analytics service object can also be used to access the
Core Reporting API.
Using A Test Account
If you intend to use the Management API to create and/or configure Properties, it's recommended that you implement and verify your code with a test account. Using a test account will help prevent you from making accidental changes to an active Property. Once you've tested and confirmed that your code is working as expected using the test account and Property, then you can start using the implementation with your real accounts.
You can create a test account in the Admin section of the Google Analytics web interface.
The Management API allows you to list, get, insert, update, and patch
properties for an authorized user. To use any of these methods, you first
need to create an
Analytics service object, as described in the
Before You Begin section.
For code examples that show you how to work with the Web Property resource, visit the following method references:
- list — Lists web properties to which the user has access.
- get — Gets a web property to which the user has access.
- insert — Create a new web property.
- patch — Updates an existing web property. This method supports patch semantics.
- update — Updates an existing web property.
See the Management API Reference Sample for a working example of how to traverse and access all the data in the Management API.
Google Analytics API Java client library Sample
Google Analytics API Python client library Sample
Google Analytics API PHP client library Sample