This document provides a high level overview of the Google Analytics Provisioning API.
The Provisioning API can be used to create new Google Analytics accounts and enable Google Analytics for your customers at scale. It is intended for qualified service providers and large partners.
For example, you could use the Provisioning API as part of a new user onboarding process to create a new Google Analytics account for a client and then use additional Management API resources to programmatically configure the account and link it to AdWords. This can all be automated and initiated from within your own admin or reporting interface.
The Provisioning API allows service providers to programmatically create new Google Analytics accounts on behalf of their users. There are two business cases supported by the Provisioning API:
- If your users control their own websites (or web properties), you want to create user-controlled analytics accounts. While you'll have administrative access to these accounts, they are owned and controlled by the end-user.
- If you own or control the website (or web property) on behalf of your user, you want to create partner-controlled analytics accounts. Your end-users won't have any direct access to these accounts by default, though you can grant them access later.
The requirements and high-level steps to create a new user-controlled account using the Provisioning API are:
- End users must have a Google Account or will have to create one during the Google Analytics provisioning flow.
- The Google Analytics provisioning flow consists of 2-steps:
- End user grants your application permissions to provision an account on their behalf.
- Partner makes an API call to create an account ticket.
- End user accepts the Google Analytics Terms of Service (TOS) and data sharing settings policy.
- The account is created on behalf of the end user.
Learn about how to create user-controlled Analytics accounts in the User-controlled account API Developer Guide.
These are the high level steps for creating a partner-controlled analytics account:
- Partner accepts the Terms of Service for the Provisioning API service, which will require the partner to accept the Terms of Service for Google Analytics, which will apply to all partner-controlled accounts. This step only has to be completed once.
- Make the relevant API call to create an account.
Learn more about how to create partner-controlled Analytics accounts in the Partner-Controlled Account API Developer Guide.