API de administración: guía para programadores de objetivos

En este documento se explica cómo usar la API de administración para acceder a los datos de objetivo.

Introducción

Un objetivo de Google Analytics está en el cuarto y último nivel de la jerarquía de la cuenta; los objetivos no tienen entidades secundarias. Cada recurso de objetivo tiene un solo recurso de vista (perfil) como su elemento principal en la jerarquía.

  • Consulta la descripción general de las entidades en la guía de descripción general de la API de administración para conocer cómo se relacionan los objetivos con otras entidades de la API de administración.
  • Consulta la guía conceptual Cuentas y vistas (perfiles) para obtener información general sobre los objetivos.

Los datos de objetivo que proporciona la API de administración describen el modo en que se configura un objetivo: nombre, valor, tipo y si está activo.

Para obtener información sobre los diferentes tipos de objetivos que se pueden crear, consulta Configurar objetivos (Centro de ayuda).

Antes de empezar

En esta guía se explica cómo acceder a la API de Google Analytics mediante los siguientes lenguajes de programación:
  • Java
  • Python
  • PHP

  • Consulta 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 de administración.
  • Consulta la Guía de referencia para acceder a la API 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. Por lo general, para crear el objeto de servicio tienes que realizar los pasos siguientes:

  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 este tutorial recorrerás los pasos iniciales de la creación de una aplicación de la API de Google Analytics. Una vez completado, podrás usar esta guía para realizar tareas del mundo real.

El fragmento de código siguiente continúa desde el paso 3: Crear un objeto de servicio Analytics y contiene una variable para almacenar un objeto de servicio autorizado.

Java

Analytics analytics = // Read Hello Analytics Tutorial for details.

Python

analytics = # Read Hello Analytics Tutorial for details.

PHP

$client = // Read Hello Analytics Tutorial for details.

// Return results as objects.
$client->setUseObjects(true);

$analytics = new apiAnalyticsService($client);

La biblioteca PHP devolverá todos los resultados de la API como una matriz asociativa. Para devolver los objetos reales, se puede llamar al método useObject de cliente, tal como se ha demostrado en el ejemplo anterior.

Después de crear un objeto de servicio Analytics, estarás preparado para realizar solicitudes a la API de administración.

Nota: El mismo objeto de servicio Analytics también se puede usar para acceder a la API de informes centrales.

Usar una cuenta de prueba

Si piensas utilizar la API de administración para crear o configurar objetivos, es recomendable que implementes y verifiques el código con una cuenta de prueba. El uso de una cuenta de este tipo te servirá para que no realices cambios accidentales en un objetivo activo. Después de haber probado y confirmado que tu código funciona del modo previsto con la cuenta de prueba y el objetivo, puedes empezar a usar la implementación con las cuentas reales.

Puedes crear una cuenta de prueba en la sección "Administrador" de la interfaz web de Google Analytics.

Límites y comportamiento de los objetivos

Los siguientes límites y comportamientos se aplican al recurso Objetivo:

  • Existe un límite superior de 20 objetivos por vista (perfil). Una vez que una vista (perfil) alcanza el límite, no se pueden crear objetivos adicionales mediante la API para esa vista (perfil). Sin embargo, los objetivos existentes se pueden actualizar y reutilizar. Consulta Límites y cuotas para obtener información acerca de los límites generales.
  • Los objetivos no se pueden suprimir, pero se pueden marcar como inactivos si se configura la propiedad active del objetivo como False. Cuando un objetivo se encuentra desactivado, no se registra ningún dato, pero seguirá estando disponible el historial de datos.

Ejemplos de código

La API de administración permite enumerar, obtener, insertar, actualizar y parchear objetivos de un usuario autorizado. Para utilizar cualquiera de estos métodos, primero debes crear un objeto de servicio Analytics, tal como se describe en la sección Antes de empezar.

Para ver ejemplos de código que muestran cómo trabajar con el recurso Objetivo, consulta las siguientes referencias de métodos:

  • list: enumera los objetivos a los que tiene acceso el usuario.
  • get: obtiene un objetivo al que tiene acceso el usuario.
  • insert: crea un nuevo objetivo.
  • patch: actualiza un objetivo. Este método es compatible con la semántica de parches.
  • update: actualiza un objetivo.

Aplicación de ejemplo

Consulta en la muestra de referencia de la API de administración un ejemplo funcional de cómo recorrer todos los datos de la API de administración y cómo acceder a ellos.

Java


API de Google Analytics: ejemplo de la biblioteca de cliente Java

Python


API de Google Analytics: ejemplo de la biblioteca de cliente Python

PHP


API de Google Analytics: ejemplo de la biblioteca de cliente PHP