Aprovisionamiento de cuentas controladas por socios: Guía para desarrolladores de la API

Introducción

createAccountTree forma parte de la API de Provisioning que se puede usar para crear cuentas nuevas de Google Analytics a gran escala. A diferencia de createAccountTicket, createAccountTree no requiere ninguna interacción del usuario final para completar la creación de la cuenta; el proceso es completamente automático. Esto es útil cuando necesitas aprovisionar una cuenta de Analytics que controlas en nombre de un cliente y cuando proporcionas una vista personalizada de esos datos a tu cliente.

Esta API está reservada para los socios que controlan los sitios web o las propiedades web de sus usuarios. Si tus usuarios controlan sus propios sitios web o propiedades web, en su lugar, deberías crear cuentas de Analytics controladas por el usuario.

Antes de comenzar

Se accede a todas las APIs de Google Analytics de manera similar. Antes de comenzar a usar la API de aprovisionamiento, debes hacer lo siguiente:

  • Lee la página de bibliotecas cliente para obtener una lista completa de las bibliotecas cliente específicas de cada lenguaje de programación que funcionan con la API.
  • Lee la Guía de referencia para obtener más información sobre la interfaz de la API y cómo acceder a los datos sin una biblioteca cliente.

Cada biblioteca cliente proporciona un único objeto de servicio de estadísticas para acceder a la API de Provisioning. Por lo general, debes seguir estos pasos para crear el objeto de servicio:

  1. Registra tu aplicación en la Consola de API de Google.
  2. Autorice la creación de una cuenta nueva de Google Analytics.
  3. Crear un objeto de servicio de Analytics

Si no completaste estos pasos, detente y lee el instructivo Hello Google Analytics API Tutorial. En este instructivo, se indican los pasos iniciales para crear una aplicación de la API de Google Analytics. Cuando termines, comprenderás cómo acceder a las APIs de Google Analytics para realizar tareas reales.

La cuenta de plantilla

Como parte de tu autorización para utilizar esta API, deberás proporcionar una nueva cuenta de Google Analytics, que funcionará como cuenta de plantilla para esta API. Cuando se crean cuentas nuevas, heredan varios parámetros de configuración de la cuenta de plantilla, incluido el aceptador de las Condiciones del Servicio, la Organización y varios parámetros de configuración de uso compartido de datos. Consulta la referencia de createAccountTree para obtener más detalles sobre la cuenta de plantilla, incluida una lista de todos los datos heredados.

Aprovisionar una cuenta

Para aprovisionar una cuenta de Google Analytics nueva, realiza una solicitud al extremo de la API de createAccountTree. Necesitarás los siguientes detalles de aprovisionamiento:

  • Campos de Account
    • Un accountName para la cuenta.
  • Campos de Propiedad web
    • Es un objeto webpropertyName para la propiedad.
    • Un objeto websiteUrl. Debe ser la URL asociada con la propiedad del usuario de esta cuenta de Analytics.
  • Ver campos
    • Es un profileName para la vista.
    • Es un timezone para la vista.

Una vez que tengas los detalles, realiza una llamada autenticada al extremo 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 se realiza 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 administración de la cuenta

La cuenta de usuario que autorice la respuesta mediante OAuth será propiedad de la cuenta de Google Analytics creada. Por este motivo, te recomendamos que tu organización utilice una cuenta de servicio para administrar la cuenta de Analytics, en lugar de una cuenta de usuario individual.

Después de crear la cuenta, puedes configurarla con la API de Management. A continuación, se indican algunas tareas comunes para una cuenta recién creada:

Aclaración sobre las relaciones de las cuentas

Al igual que con todas las APIs de Google, se requiere un proyecto de Google Cloud como punto de partida para la autorización de solicitudes. Como se describe en la documentación de OAuth 2.0, en esta cuenta administrarás las credenciales para las solicitudes a la API. Sin embargo, la cuenta de Google Analytics creada no está afiliada de ninguna manera con el proyecto de Cloud ni con sus cuentas administradoras; solo está afiliada con el usuario o la cuenta de servicio que autorizó la solicitud. Puedes utilizar la API de Management si necesitas configurar el acceso a la cuenta de Analytics.