API de administración: guía para programadores de propiedades web

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

Introducción

Una propiedad web de Google Analytics está en el segundo nivel de la jerarquía de la cuenta. Cada propiedad web tiene un solo recurso de cuenta como su elemento principal y puede tener un elemento secundario de uno o varios recursos de vista (perfil).

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

Una propiedad web de Google Analytics es importante porque toda la recopilación de datos se produce en este nivel. Por ejemplo, cuando se agrega código de seguimiento a un sitio web o una aplicación para dispositivos móviles, se debe incluir un ID con el formato UA-xxxxx-y. Este ID se denomina ID de propiedad web e indica en qué cuenta de Google Analytics se almacenan los datos de cuenta.

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 tienes pensado usar la API de administración para crear o configurar las propiedades, 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 una propiedad activa. Después de haber probado y confirmado que tu código funciona del modo previsto con la cuenta de prueba y la propiedad, 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.

Ejemplos de código

La API de administración permite enumerar, obtener, insertar, actualizar y parchear las propiedades 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 Propiedad web, consulta las siguientes referencias de métodos:

  • list: enumera las propiedades web a las que tiene acceso el usuario.
  • get: obtiene una propiedad web a la que el usuario tiene acceso.
  • insert: crea una nueva propiedad web.
  • patch: actualiza una propiedad web. Este método es compatible con la semántica de parches.
  • update: actualiza una propiedad web.

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