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

En este documento se describe cómo usar la API de administración para administrar los filtros de Google Analytics de un usuario autorizado.

Introducción

Los filtros de la API de administración te permiten crear, obtener, enumerar, actualizar y suprimir filtros de tu cuenta de Google Analytics, así como administrar los filtros que se aplican a las vistas (perfiles). Para obtener más información sobre cómo funcionan los filtros, consulta Acerca de los filtros de vista (Centro de ayuda).

Los dos recursos de la API de administración que habilitan la automatización de la administración de los filtros son:

  1. El recurso Filtro, que representa un filtro en Google Analytics y su configuración. Una colección de recursos Filtro representa todos los filtros asociados a una cuenta de Google Analytics.
  2. El recurso Enlace de filtro de perfil, que representa un enlace entre un filtro y una vista (perfil) a la que se ha aplicado. Una colección de enlaces de filtro de perfil representa todos los filtros que se han aplicado actualmente a una vista (perfil).

Antes de empezar

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. 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, sabrás cómo acceder a las API de Google Analytics para realizar tareas del mundo real.

Casos prácticos

Los filtros de la API de administración se pueden usar para centralizar las prácticas recomendadas en varias cuentas y para automatizar la aplicación y la eliminación de los filtros existentes. Por ejemplo:

Crear un filtro con una configuración predefinida o estándar

Para crear un nuevo filtro con una configuración predefinida:

  1. Utiliza la API de administración o la interfaz web para recuperar el ID de la cuenta a la que se agregará el nuevo filtro.
  2. Utiliza la configuración predefinida y ejecuta el método insert del recurso filter.

Consulta en la referencia de la API la información del método insert del recurso filter.

Para aplicar un filtro a una vista (perfil):

  1. Utiliza la API de administración o la interfaz web para recuperar el ID de la cuenta a la que pertenece el filtro.
  2. Recupera el recurso de filtro para aplicarlo a la vista (perfil) ejecutando el método list del recurso filter o bien ejecutando el método get del recurso filter si conoces el ID de filtro.
  3. Utiliza la API de administración o la interfaz web para recuperar el ID de cuenta, el ID de propiedad y el ID de la vista (perfil) a la que se aplicará el filtro.
  4. Aplica el filtro ejecutando el método insert del recurso profileFilterLink.

Consulta en la referencia de la API la información del método insert del recurso profileFilterLink.

Para desvincular un filtro de una vista (perfil):

  1. Utiliza la API de administración o la interfaz web para recuperar el ID de cuenta, el ID de propiedad y el ID de la vista (perfil) de la que se quitará el filtro.
  2. Recupera el ID del enlace de filtro de perfil que se quitará de la vista. Puedes hacerlo de dos formas:
    1. Ejecuta el método list del recurso profileFilterLink y recupera el ID del enlace de filtro de perfil.
    2. Si conoces tanto el ID de filtro como el ID de vista (perfil), puedes combinarlos con dos puntos para obtener el ID de enlace de filtro de perfil. Por ejemplo, si el ID de vista es 1234 y el ID de filtro es 5678, el ID de enlace de filtro de perfil es 1234:5678.
  3. Quita el filtro ejecutando el método delete del recurso profileFilterLink.

Consulta en la referencia de la API la información del método delete del recurso profileFilterLink.

Cambiar el orden de clasificación de los filtros de una vista (perfil)

De forma predeterminada, los filtros se aplican a una vista (perfil) en el orden en el que se agregan los filtros. Para cambiar el orden de un filtro:

  1. Utiliza la API de administración o la interfaz web para recuperar el ID de cuenta, el ID de propiedad y el ID de la vista (perfil) de la que se quitará el filtro.
  2. Recupera el ID del enlace de filtro de perfil que se quitará de la vista. Puedes hacerlo de dos formas:
    1. Ejecuta el método list del recurso profileFilterLink y recupera el ID del enlace de filtro de perfil.
    2. Si conoces tanto el ID de filtro como el ID de vista (perfil), puedes combinarlos con dos puntos para obtener el ID de enlace de filtro de perfil. Por ejemplo, si el ID de vista es 1234 y el ID de filtro es 5678, el ID de enlace de filtro de perfil es 1234:5678.
  3. Cambia la clasificación del filtro ejecutando el método patch del recurso profileFilterLink.

Consulta en la referencia de la API la información del método patch del recurso profileFilterLink.

Ejemplos de código

El recurso filters permite que un usuario autorizado enumere, obtenga, actualice, parchee e inserte filtros. El recurso profileFilterLinks permite que un usuario autorizado enumere, obtenga, actualice, parchee e inserte enlaces de filtro de perfil. 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 los filtros y los recursos de enlaces de filtro de perfiles, consulta las siguientes referencias de métodos:

Administrar filtros

  • list: enumera los filtros a los que tiene acceso el usuario.
  • get: obtiene un filtro al que tiene acceso el usuario.
  • insert: crear un nuevo filtro.
  • patch: parchea un filtro.
  • update: actualiza un filtro.

Administrar enlaces de filtro

  • list: enumera los enlaces de filtro de perfil a los que tiene acceso el usuario.
  • get: obtiene un enlace de filtro de perfil al que tiene acceso el usuario.
  • insert: crea un nuevo enlace de filtro de perfil.
  • patch: parchea un enlace de filtro de perfil.
  • update: actualiza un enlace de filtro de perfil.