Filtragem

O parâmetro de string de consulta filters restringe os dados retornados em um relatório da API AdSense Management. Quando você usa o parâmetro filters, fornece uma dimensão que quer filtrar, seguida pela expressão do filtro.

As consultas filtradas restringem as linhas que são incluídas no resultado. Cada linha no resultado é testada em relação ao filtro: se o filtro for correspondente, a linha será mantida e, caso contrário, será descartada.

  • Codificação de URL: as bibliotecas de cliente codificam automaticamente os operadores de filtro. No entanto, se você fizer solicitações diretamente no protocolo, codifique explicitamente os operadores de filtro, conforme indicado na tabela abaixo.
  • Prioridade de filtragem: a filtragem ocorre antes de qualquer dimensão ser agregada, para que as métricas retornadas representem o total somente para as dimensões relevantes.

Sintaxe de filtro

Um filtro único uso o formulário:

name operator expression

Nesta sintaxe:

  • name: o nome da dimensão a ser filtrada. Por exemplo: AD_CLIENT_ID vai filtrar o ID do cliente de anúncios.
  • operator: define o tipo de correspondência de filtro a ser usado.
  • expression: define os valores incluídos nos resultados.

Todas as dimensões que se aplicam às métricas relatadas podem ser usadas como filtros, com exceção das dimensões relacionadas à data (DATE, WEEK e MONTH). Para filtrar por data, especifique o período do relatório.

Operadores de filtro

Há dois operadores de filtro. Os operadores precisam ter codificação de URL para serem incluídos nas strings de consulta do URL.

Operador Descrição Formulário codificado pelo URL Exemplo
== Correspondência exata %3D%3D Métricas agregadas em que o nome do país é Canadá:
filters=COUNTRY_NAME%3D%3DCanada
=@ Contém substring %3D@ Métricas agregadas em que o nome do país contém Unido, corresponde a Estados Unidos e Reino Unido. Por exemplo:
filters=COUNTRY_NAME%3D@United

Expressões de filtro

Existem algumas regras importantes para expressões de filtro:

  • Caracteres reservados pelo URL: é necessário que caracteres como & sejam codificados pelo URL da maneira habitual. As bibliotecas de cliente cuidam disso para você. Portanto, você só precisa se preocupar com essa codificação se estiver fazendo chamadas diretas ao protocolo.
  • Caracteres reservados: a vírgula e a barra invertida precisam ser separadas pela barra invertida quando aparecerem em uma expressão.
    • barra invertida \\
    • vírgula \,

Observação : certifique-se de evitar o escape das barras invertidas antes das vírgulas para evitar escapes duplos.

Combinação de filtros

Os filtros podem ser combinados usando a lógica booleana OR e AND.

Lógica OR

A lógica OR é definida usando uma vírgula (,) dentro da expressão de filtro.

Exemplo:(cada um deve ser codificado por URL)

O código do país é (US OU UK):
COUNTRY_CODE==US,COUNTRY_CODE==UK

Lógica AND

A lógica AND é alcançada fornecendo vários parâmetros de filtro, o que se traduz em proporcionar uma matriz de filtros nas bibliotecas de cliente.

Exemplo:

O código do país é US E o código do produto é AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC

Combinar lógica AND e OR

É possível combinar as lógicas AND e OR em uma única expressão.

Observação : cada filtro é avaliado individualmente antes de todos os filtros serem combinados em uma expressão lógica AND.

Exemplo:

O código do país é (US OR UK) E o código do produto é AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC

Próximas etapas