Filtrado

El parámetro de cadena de consulta filter limita los datos devueltos en un informe de la API de administración de AdSense. Si se utiliza el parámetro filter, hay que especificar la dimensión por la que se desea filtrar, seguida de la expresión de filtro.

Las consultas filtradas limitan las filas incluidas en el resultado. Cada fila del resultado se prueba con el filtro: si hay concordancia, se mantiene el filtro; de lo contrario, se quita.

  • Codificación de URL: las bibliotecas del cliente codifican automáticamente los operadores de filtro. No obstante, si realizas solicitudes directamente al protocolo, debes codificar de forma explícita los operadores de filtro, tal como se indica en la tabla siguiente.
  • Prioridad de filtrado: el filtrado se realiza antes de que se agregue ninguna dimensión, por lo que las métricas devueltas representan el total solo para las dimensiones relevantes.

Sintaxis de filtro

Un filtro individual usa la forma siguiente:

name operator expression

En esta sintaxis:

  • name: el nombre de la dimensión a la que se va a aplicar el filtro. Por ejemplo: AD_CLIENT_ID filtrará por el ID de cliente publicitario.
  • operator: define el tipo de coincidencia de filtro que se va a utilizar.
  • expression: especifica los valores incluidos en los resultados.

Operadores de filtro

Hay dos operadores de filtro. Los operadores deben codificarse en URL para incluirlos en las cadenas de consulta URL.

Operador Descripción Forma codificada en URL Ejemplo
== Concordancia exacta %3D%3D Agrega métricas donde el nombre de país es Canada:
filter=COUNTRY_NAME%3D%3DCanada
=@ Contiene subcadena %3D@ Agrega métricas donde el nombre de país contiene United, que coincide con "United States" y "United Kingdom"; por ejemplo:
filter=COUNTRY_NAME%3D@United

Expresiones de filtro

Hay un par de reglas importantes para las expresiones de filtro:

  • Caracteres reservados de URL: los caracteres como & deben codificarse en la URL de la manera habitual. Las bibliotecas de cliente se ocupan de esto automáticamente, de manera que solo tienes que preocuparte de la codificación si realizas llamadas directas al protocolo.
  • Caracteres reservados: la coma y la barra diagonal inversa deben ir precedidas de una barra diagonal inversa cuando aparecen en una expresión.
    • barra diagonal inversa \\
    • coma \,

Nota: Asegúrate de incluir la barra inversa antes de las comas, con el fin de evitar dobles caracteres de escape.

Cómo combinar filtros

Los filtros se pueden combinar con la lógica booleana OR y AND.

OR lógico

El operador OR lógico se define mediante una coma (,) dentro de la expresión de filtro.

Ejemplo: (cada uno debe estar codificado en URL)

El código de país es (US OR UK):
COUNTRY_CODE==US,COUNTRY_CODE==UK

AND lógico

El operador AND lógico se obtiene proporcionando varios parámetros de filtro, lo que se traduce en proporcionar una matriz de filtros en las bibliotecas de cliente.

Ejemplo:

El código de país es US y el código de producto es AFC:
filter=COUNTRY_CODE%3D%3DUS&filter=PRODUCT_CODE%3D%3DAFC

Cómo combinar AND y OR lógicos

Es posible combinar los operadores AND y OR lógicos en una sola expresión.

Nota: Cada filtro se evalúa individualmente antes de combinar todos los filtros en una expresión lógica AND.

Ejemplo:

El código de país es (US O UK) Y el código de producto es AFC:
filter=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filter=PRODUCT_CODE%3D%3DAFC

Pasos siguientes

Enviar comentarios sobre...

AdSense Management API
AdSense Management API