El parámetro de cadena de consulta filters restringe los datos que se muestran en un informe de la API de AdSense Management. Cuando usas el parámetro filters, proporcionas una dimensión que deseas filtrar, seguida de la expresión de filtro.
Las consultas filtradas restringen las filas que se incluyen en el resultado. Cada fila del resultado se prueba con el filtro: si el filtro coincide, la fila se conserva y, si no coincide, se descarta.
- Codificación de URL: Las bibliotecas cliente codifican de forma automática los operadores de filtro. Sin embargo, si realizas solicitudes directamente al protocolo, debes codificar de forma explícita los operadores de filtro como se indica en la siguiente tabla.
- Prioridad de filtrado: El filtrado se produce antes de que se agreguen las dimensiones, de modo que las métricas que se muestran representen el total solo para las dimensiones relevantes.
Sintaxis del filtro
Un único filtro utiliza el siguiente formato:
name operator expression
En esta sintaxis:
- name: Es el nombre de la dimensión en la que se filtrará.
Por ejemplo:
AD_CLIENT_IDfiltrará el ID de cliente del anuncio. - operador: Define el tipo de coincidencia de filtro que se usará.
- expression: indica los valores incluidos en los resultados.
Todas las dimensiones que se aplican a las métricas sobre las que se informan los informes se pueden usar como filtros, a excepción de las dimensiones relacionadas con la fecha (DATE, WEEK y MONTH). Para filtrar por fecha, especifica el período del informe.
Operadores de filtro
Hay dos operadores de filtros. Los operadores deben estar codificados en formato URL para que se los incluya en las cadenas de consulta de URL.
| Operador | Descripción | Formulario de URL codificada | Ejemplo |
|---|---|---|---|
== |
Concordancia exacta | %3D%3D |
Métricas agregadas en las que el nombre del país es Canadá:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
Contiene una substring | %3D@ |
Métricas agregadas en las que el nombre del país contiene United,
coincide con Estados Unidos y el Reino Unido, por ejemplo:
filters=COUNTRY_NAME%3D@United |
Filtrar expresiones
Existen algunas reglas importantes para las expresiones de filtro:
- Caracteres reservados en URL: Los caracteres como
&se deben codificar en formato de URL de la manera habitual. Las bibliotecas cliente se encargan de esto, por lo que solo tendrás que preocuparte por la codificación si realizas llamadas directas al protocolo. - Caracteres reservados: La coma y la barra inversa se deben escapar cuando aparezcan en una expresión.
- barra inversa
\\ - coma
\,
- barra inversa
Nota: Asegúrate de escapar las barras inversas antes de las comas para evitar el escape doble.
Combinación de filtros
Los filtros se pueden combinar con la lógica booleana OR y AND.
Lógica OR
La lógica OR se define con una coma (,) dentro de la expresión de filtro.
Ejemplo: (cada una debe tener codificación URL)
El código de país es (EE.UU. O Reino Unido):
COUNTRY_CODE==US,COUNTRY_CODE==UK
Lógica Y
La lógica de AND se logra proporcionando varios parámetros de filtro, lo que se traduce en proporcionar un array de filtros en las bibliotecas cliente.
Ejemplo:
El código de país es US Y el código de producto es AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
Combina los operadores lógicos Y y O
Es posible combinar la lógica AND y la lógica OR en una sola expresión.
Nota: Cada filtro se evalúa de forma individual antes de que todos se combinen en una expresión lógica AND.
Ejemplo:
El código de país es (EE.UU. O Reino Unido) Y el código de producto es AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC