Filtrage

Le paramètre de chaîne de requête filter limite la quantité de données renvoyées dans un rapport d'API AdSense Management. L'utilisation du paramètre filter revient à fournir une variable de filtrage suivie de l'expression de filtrage.

Les requêtes filtrées limitent le nombre de lignes à inclure dans le résultat. Chaque ligne de résultat est testée par rapport au filtre défini : si elle correspond, la ligne est conservée, sinon, elle est abandonnée.

  • Codage d'URL : les bibliothèques clientes codent automatiquement les opérateurs de filtrage. Toutefois, en cas de demande directe au protocole, vous devez coder vous-même les opérateurs de filtrage comme indiqué dans le tableau ci-dessous.
  • Priorité de filtrage : le filtrage se produit avant le regroupement de toute autre variable, afin que les statistiques renvoyées regroupent uniquement les variables correspondantes.

Syntaxe des filtres

Un filtre prend le format suivant :

name operator expression

Dans cette syntaxe :

  • name : correspond au nom de la variable à filtrer. Par exemple, AD_CLIENT_ID filtre les données en fonction des identifiants de clients publicitaires.
  • operator : définit le type de correspondance de filtrage à utiliser.
  • expression : indique les valeurs incluses dans les résultats.

Opérateurs de filtrage

Il existe deux opérateurs de filtrage. Les opérateurs doivent être codés au format URL pour faire partie des chaînes de requête de l'URL.

Opérateur Description Format de codage d'URL Exemple
== Correspondance exacte %3D%3D Regroupe les statistiques dont le nom de pays est Canada :
filter=COUNTRY_NAME%3D%3DCanada
=@ Contient une sous-chaîne %3D@ Regroupe les statistiques dont le nom de pays contient United (correspond par exemple à United States et United Kingdom) :
filter=COUNTRY_NAME%3D@United

Expressions de filtrage

Pour les expressions de filtrage, il convient de respecter quelques règles :

  • Caractères réservés aux URL : les caractères tels que & doivent être codés pour les URL en suivant la procédure habituelle. Les bibliothèques clientes se chargent du codage à votre place. Vous ne devez alors vous soucier de cette opération que si vous envoyez des appels directs au protocole.
  • Caractères réservés : utilisées dans une expression, la virgule et la barre oblique inverse doivent être précédées d'une barre oblique inverse.
    • barre oblique inverse \\
    • virgule \,

Remarque : Assurez-vous de toujours ajouter une barre oblique inverse devant les virgules afin d'éviter un double échappement.

Combinaison de filtres

Les filtres peuvent être combinés à l'aide des logiques booléennes OR et AND.

Logique "OR"

La logique OR est définie à l'aide d'une virgule (,) à l'intérieur de l'expression de filtrage.

Exemple : (chacune doit être encodée au format URL)

Le code du pays est (US OU UK) :
COUNTRY_CODE==US,COUNTRY_CODE==UK

Logique "AND"

La logique AND est obtenue en indiquant plusieurs paramètres de filtrage (ce qui se traduit par une séquence de filtres envoyés aux bibliothèques clientes).

Exemple :

Le code du pays est US AND le code produit est AFC :
filter=COUNTRY_CODE%3D%3DUS&filter=PRODUCT_CODE%3D%3DAFC

Combinaison des logiques "AND" et "OR"

Il est possible de combiner les logiques "AND" et "OR" en une seule expression.

Remarque : Chaque filtre est évalué individuellement avant de combiner tous les filtres dans une expression logique AND.

Exemple :

Le code du pays est (US OR UK) AND le code du produit est AFC :
filter=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filter=PRODUCT_CODE%3D%3DAFC

Étapes suivantes