Aprovisionar cuentas controladas por un partner – Guía para desarrolladores de APIs

Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Introducción

La función createAccountTree es una parte de la API de aprovisionamiento que se puede usar para crear cuentas de Google Analytics a la escala deseada. A diferencia de createAccountTicket, createAccountTree no es necesario que el usuario final haga nada para acabar de crear la cuenta, ya que el proceso está completamente automatizado. Esta opción es útil cuando tienes que aprovisionar una cuenta de Analytics que controlas en nombre de un cliente en la que le proporcionas una vista personalizada de esos datos.

Esta API está reservada para los partners que controlan los sitios web o las propiedades web de sus usuarios. Si tus usuarios controlan sus propios sitios web o propiedades web, debes crear cuentas de Analytics controladas por el usuario.

Antes de empezar

A todas las API de Google Analytics se accede de un modo similar. Antes de empezar a usar la API de aprovisionamiento, debes hacer lo siguiente:

  • Consultar la página de bibliotecas de cliente para obtener una lista completa de las bibliotecas de cliente de cada lenguaje de programación que funcionan con esta API.
  • Consultar la guía de referencia para obtener información sobre la interfaz de esta API y el acceso a los datos sin una biblioteca de cliente.

Cada biblioteca de cliente proporciona un solo objeto de servicio analítica para acceder a la API de aprovisionamiento. Por lo general, para crear el objeto de servicio debes seguir estos pasos:

  1. Registra tu aplicación en la consola de APIs de Google.
  2. Autoriza la creación de una nueva cuenta de Google Analytics.
  3. Crea un objeto de servicio analytics.

Si no has completado estos pasos, no sigas y lee el tutorial sobre la API Hello de Google Analytics, en el que se te guiará por los pasos para empezar a usar la API de Google Analytics. Una vez que lo hayas leído, sabrás cómo acceder a las API de Google Analytics para crear una aplicación.

La cuenta de plantilla

Al incluirte en la lista blanca para usar esta API, deberás proporcionar una nueva cuenta de Google Analytics, que sirve como cuenta de plantilla para esta API. Cuando se crean nuevas cuentas, heredan varias opciones de configuración de la cuenta de plantilla, como quién ha aceptado las condiciones del servicio, la organización y varias opciones de configuración para compartir datos. Consulta la referencia de createAccountTree para obtener más detalles sobre la cuenta de plantilla, como la lista de todos los datos heredados.

Aprovisionar una cuenta

Para aprovisionar una cuenta de Google Analytics, envía una solicitud al punto de conexión createAccountTree de la API. La información que debes proporcionar es la siguiente:

Una vez que tengas los detalles, haz una llamada autenticada al punto de conexión de la API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

Si la llamada se establece correctamente, la API responderá con los detalles de la cuenta, la propiedad web y la vista recién creadas:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Propiedad y gestión de cuentas

La cuenta de Google Analytics que se cree será propiedad de la cuenta de usuario que haya autorizado la respuesta a través de OAuth. Por esta razón, recomendamos que tu organización use una cuenta de servicio para gestionar la cuenta de Analytics, en lugar de una cuenta de usuario individual.

Una vez que se haya creado la cuenta, puedes configurarla con la API de administración. Las siguientes tareas pueden llevarse a cabo en todas las cuentas recién creadas:

Aclaración sobre las relaciones entre cuentas

Al igual que con todas las API de Google, para poder autorizar las solicitudes hay que tener un proyecto de Google Cloud. Tal como se explica en la documentación de OAuth 2.0, esta es la cuenta en la que gestionarás tus credenciales para las solicitudes a la API. Sin embargo, la cuenta de Google Analytics que se ha creado no está directamente afiliada al proyecto de Cloud en modo alguno, ni tampoco a sus cuentas de gestión; únicamente está afiliada a la cuenta de usuario o de servicio que ha autorizado la solicitud. Puedes utilizar la API de administración si quieres seleccionar qué cuentas de usuario pueden acceder a la cuenta de Analytics, así como sus permisos.