API de administración: guía para programadores de dimensiones y métricas personalizadas

En este documento se describe cómo usar la API de administración para administrar las dimensiones y las métricas personalizadas de Google Analytics para un usuario autorizado.

Introducción

Las dimensiones y las métricas personalizadas en la API de administración permiten crear, obtener, enumerar, actualizar y parchear las dimensiones y las métricas personalizadas de una propiedad de Google Analytics. Para obtener más información sobre cómo funcionan las dimensiones y las métricas personalizadas, consulta Referencia de las funciones de las dimensiones y las métricas personalizadas.

Los dos recursos de la API de administración siguientes habilitan la automatización de la administración de las dimensiones y de las métricas personalizadas:

  1. El recurso Dimensiones personalizadas, que representa todas las propiedades y las configuraciones disponibles para una dimensión personalizada en Google Analytics.
  2. El recurso Métricas personalizadas que representa todas las propiedades y las configuraciones disponibles para una métrica personalizada en Google Analytics.

Requisitos previos

A todas las API de Google Analytics se accede de un modo similar. Antes de empezar a usar la API de administración, debes realizar las siguientes acciones:

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

Cada biblioteca de cliente proporciona un solo objeto de servicio Analytics para acceder a todos los datos de la API de administración. Para crear el objeto de servicio, realiza las siguientes acciones:

  1. Registrar la aplicación en Google Developers Console.
  2. Autorizar el acceso a los datos de Google Analytics.
  3. Crear un objeto de servicio Analytics.

Si no has completado estos pasos, no sigas y lee el tutorial de presentación de la API de Google Analytics. Con esta guía recorrerás los pasos iniciales de la creación de una aplicación de la API de Google Analytics. Una vez completada, sabrás cómo acceder a las API de Google Analytics para realizar tareas del mundo real.

Cambios de ámbito e incoherencias de datos

Para obtener más información, consulta la sección Consideraciones de implementación de la referencia de funciones de las dimensiones y las métricas personalizadas.

Casos prácticos

Las dimensiones y las métricas personalizadas en la API de administración se pueden usar para automatizar las tareas siguientes.

Enumerar las dimensiones y las métricas personalizadas de una propiedad

Para enumerar todas las dimensiones o las métricas personalizadas de una propiedad:

  1. Utiliza la API de administración o el Explorador de cuentas para recuperar el ID de cuenta y el ID de propiedad.
  2. Ejecuta el método list de los recursos Dimensión personalizada o Métrica personalizada.

Consulta en la referencia de la API la información del método list correspondiente a los recursos Dimensión personalizada y Métrica personalizada.

Crear nuevas dimensiones y métricas personalizadas de una propiedad

Para crear una nueva dimensión o métrica personalizada para una propiedad:

  1. Utiliza la API de administración o el Explorador de cuentas para recuperar el ID de cuenta y el ID de propiedad.
  2. Tanto para las dimensiones como para las métricas personalizadas debes proporcionar un nombre (name) y un alcance (scope); para las métricas personalizadas también debes elegir la métrica type.
  3. Ejecuta el método insert de los recursos Dimensión personalizada o Métrica personalizada.

Consulta en la referencia de la API la información del método insert correspondiente a los recursos Dimensión personalizada y Métrica personalizada.

Actualizar las dimensiones y las métricas personalizadas de una propiedad

También se puede reutilizar una dimensión o una métrica personalizada actualizando su nombre, su ámbito o su tipo. No obstante, te recomendamos que, antes de hacerlo, revises el efecto de los cambios en las dimensiones y en las métricas.

Para actualizar una dimensión o una métrica personalizada de una propiedad

  1. Utiliza la API de administración o el Explorador de cuentas para recuperar el ID de cuenta y el ID de propiedad.
  2. Tanto para las dimensiones como para las métricas personalizadas debes proporcionar un nombre (name) y un alcance (scope); para las métricas personalizadas también debes configurar la métrica type.
  3. Ejecuta el método update de los recursos Dimensión personalizada o Métrica personalizada.

Ignorar los enlaces de fuente de datos personalizada o de conjunto de datos

Si intentas usar la API de administración para actualizar una dimensión o una métrica personalizada que utiliza una fuente de datos personalizada o un conjunto de datos, la operación no se realizará correctamente y se devolverá un error. Este comportamiento impide los cambios de alcance accidentales en las dimensiones o en las métricas que pueden producir incoherencias de datos. Para anular este comportamiento e ignorar cualquier advertencia, puedes configurar el parámetro ignoreCustomDataSourceLinks como true al ejecutar una operación de actualización.

Ejemplos de código

Los recursos de dimensión personalizada o de métrica personalizada permiten que un usuario autorizado enumere, obtenga, actualice, parchee e inserte dimensiones y métricas personalizadas. Para usar cualquiera de estos métodos, primero debes crear un objeto de servicio de Analytics según se describe en la sección Requisitos previos.

Para ver ejemplos de código que muestran cómo trabajar con los recursos de dimensión personalizada o de métrica personalizada, consulta las siguientes referencias de métodos:

Administrar las dimensiones personalizadas

  • list: enumera las dimensiones personalizadas a las que tiene acceso el usuario.
  • get: obtiene una dimensión personalizada a la que tiene acceso el usuario.
  • insert: crea una nueva dimensión personalizada.
  • patch: parchea una dimensión personalizada.
  • update: actualiza una dimensión personalizada.

Administrar las métricas personalizadas

  • list: enumera las métricas personalizadas a las que tiene acceso el usuario.
  • get: obtiene una métrica personalizada a la que tiene acceso el usuario.
  • insert: crea una nueva métrica personalizada.
  • patch: parchea una métrica personalizada.
  • update: actualiza una métrica personalizada.