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
,
proporciona la 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 resultado se prueba con el filtro: si el filtro coincide, la fila se y, si no coincide, la fila se descarta.
- Codificación de URL: Las bibliotecas cliente codifican automáticamente. los operadores de filtros. Sin embargo, si realiza solicitudes directamente al protocolo, debes codificar explícitamente los operadores de filtro como se indica en la siguiente tabla.
- Prioridad de filtrado: el filtrado se produce antes de cualquier las dimensiones se agregan, de manera que las métricas devueltas representen el total solo para las dimensiones relevantes.
Sintaxis del filtro
Un solo filtro usa la siguiente forma:
name operator expression
En esta sintaxis:
- name: Es el nombre de la dimensión en la que se filtrará.
Por ejemplo:
AD_CLIENT_ID
filtrará el ID de cliente del anuncio. - operator: define el tipo de coincidencia de filtro que se usará.
- expression: establece los valores incluidos en los resultados.
Todas las dimensiones
que se aplican a las métricas sobre las que se informan pueden usarse como filtros, con el
excepción de las dimensiones relacionadas con la fecha (DATE
, WEEK
,
y MONTH
). Para filtrar por fecha, especifica
período del informe en su lugar.
Operadores de filtro
Existen dos operadores de filtro. Los operadores deben estar codificados en formato URL para que incluirse en las cadenas de consulta de la URL.
Operador | Descripción | Formulario codificado para URL | Ejemplo |
---|---|---|---|
== |
Concordancia exacta | %3D%3D |
Métricas agregadas en las que el nombre del país es Canadá:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
Contiene subcadena | %3D@ |
Métricas agregadas en las que el nombre del país contiene Estado, esto
coincide con Estados Unidos y Reino Unido, por ejemplo:
filters=COUNTRY_NAME%3D@United |
Expresiones de filtro
Existen algunas reglas importantes para las expresiones de filtro:
- Caracteres reservados para URL: caracteres como los siguientes
&
se debe codificar como URL de la manera habitual. Bibliotecas cliente Por eso, solo debes preocuparte por la codificación estás haciendo llamadas directas al protocolo. - Caracteres reservados: La coma y la barra inversa deben usarse
tener una barra inversa con el escape cuando aparecen en una expresión.
- barra inversa
\\
- coma
\,
- barra inversa
Nota: Asegúrate de escapar las barras inversas antes. comas, para evitar el doble escape.
Combinación de filtros
Los filtros se pueden combinar con los valores booleanos OR
y AND
lógica.
Lógica O
La lógica OR
se define con una coma (,
) dentro del
expresión de filtro.
Ejemplo: (cada uno debe estar codificado para una URL)
El código de país puede ser uno de los siguientes (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 EE.UU. Y el código del producto es AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
Cómo combinar los operadores lógicos Y y O
Es posible combinar las lógicas Y y O en una sola expresión.
Nota: Cada filtro se evalúa de forma individual. 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 del producto es AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC