Filtragem

O parâmetro de string de consulta filters restringe os dados retornados. em um relatório da API de gerenciamento do Google AdSense. Ao usar o parâmetro filters, você forneça uma dimensão que você queira filtrar, seguida pela expressão de 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á retido e, se não corresponder, a linha será descartada.

  • Codificação de URL: as bibliotecas de cliente codificam os operadores de filtro. No entanto, se você fizer solicitações diretamente ao protocolo, você precisa codificar explicitamente os operadores de filtro conforme indicado na tabela abaixo.
  • Prioridade de filtragem: a filtragem ocorre antes da são agregadas para que as métricas retornadas representem o total apenas 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 às métricas que estão sendo incluídas no relatório podem ser usadas como filtros, exceção das dimensões relacionadas a datas (DATE, WEEK, e MONTH). Para filtrar por data, especifique o para o relatório.

Operadores de filtro

Há dois operadores de filtro. Os operadores devem ser codificados por URL para que ser incluído 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@ As métricas agregadas em que o nome do país contém Unido, essa 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 para URL: caracteres como & deve ser codificado pelo URL da maneira habitual. Bibliotecas de cliente cuida disso para você, portanto, você só precisa se preocupar com essa codificação se você está fazendo chamadas diretas para o protocolo.
  • Caracteres reservados: a vírgula e a barra invertida precisam ser separados por barra invertida quando aparecerem em uma expressão.
    • barra invertida \\
    • vírgula \,

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

Combinação de filtros

Os filtros podem ser combinados usando os booleanos OR e AND. lógica.

Lógica OR

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

Exemplo: (cada uma deve ser codificada por URL)

O código do país é (US OR 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 no fornecimento de uma matriz de filtros nas bibliotecas cliente.

Exemplo:

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

Combinação de 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 que todos os filtros sejam 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