Le paramètre de chaîne de requête filters
limite les données renvoyées
dans un rapport de l'API AdSense Management. Lorsque vous utilisez le paramètre filters
, vous
indiquez la dimension à filtrer, suivie de l'expression de filtre.
Les requêtes filtrées limitent les lignes incluses dans le résultat. Chaque ligne dans le résultat est testé par rapport au filtre: si le filtre correspond, la ligne est et, si ce n'est pas le cas, la ligne est supprimée.
- Encodage d'URL: les bibliothèques clientes encodent automatiquement les opérateurs de filtrage. Cependant, si vous envoyez des requêtes directement au protocole, vous devez encoder explicitement les opérateurs de filtrage, comme indiqué dans le tableau ci-dessous.
- Priorité de filtrage: le filtrage se produit avant le sont agrégées, de sorte que les métriques renvoyées représentent le total que pour les dimensions pertinentes.
Syntaxe des filtres
Un filtre unique se présente sous la forme suivante:
name operator expression
Dans cette syntaxe:
- name : nom de l'attribut à filtrer.
Par exemple,
AD_CLIENT_ID
filtre les données en fonction de l'ID de client publicitaire. - operator : définit le type de correspondance de filtre à utiliser.
- expression : indique les valeurs incluses dans les résultats.
Toutes les dimensions
s'appliquent aux métriques pour lesquelles un rapport est généré, peuvent servir de filtres,
à l'exception des dimensions de date (DATE
, WEEK
,
et MONTH
). Pour filtrer par date, indiquez le
la plage de dates du rapport.
Opérateurs de filtrage
Il existe deux opérateurs de filtrage. Les opérateurs doivent être encodés en URL pour être inclus dans les chaînes de requête d'URL.
Opérateur | Description | Format de codage URL | Exemple |
---|---|---|---|
== |
Mot clé exact | %3D%3D |
Regroupe les métriques dont le nom de pays est Canada:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
Contient une sous-chaîne | %3D@ |
Regroupe les métriques dont le nom de pays contient United,
correspond aux États-Unis et au Royaume-Uni, par exemple:
filters=COUNTRY_NAME%3D@United |
Expressions de filtre
Deux règles importantes s'appliquent aux expressions de filtre:
- Caractères réservés aux URL : les caractères tels que
&
doit être encodé au format URL comme d'habitude. Bibliothèques clientes s'en charge pour vous. Vous n'avez donc à vous soucier de cet encodage que si vous effectuez des appels directs vers le protocole. - Caractères réservés : les virgules et les barres obliques inverses doivent
être précédées d'une barre oblique inverse lorsqu'elles apparaissent dans une expression.
- barre oblique inverse
\\
- virgule
\,
- barre oblique inverse
Remarque : Veillez à échapper les barres obliques inverses avant les virgules, afin d'éviter les doubles échappements.
Combiner des filtres
Les filtres peuvent être combinés à l'aide des valeurs booléennes OR
et AND
logique.
Logique OR
La logique OR
est définie à l'aide d'une virgule (,
) à l'intérieur de
l'expression de filtre.
Exemple:(chacune doit être encodée au format URL)
Le code pays est (US OU UK):
COUNTRY_CODE==US,COUNTRY_CODE==UK
Logique AND
La logique AND
est obtenue en fournissant plusieurs paramètres de filtrage,
ce qui se traduit par la fourniture d'un tableau
de filtres dans les bibliothèques clientes.
Exemple :
Le code du pays est US ET le code produit est AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=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 que tous les filtres ne soient combinés dans une expression logique AND.
Exemple :
Le code du pays est (US OU UK) ET le code produit est AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC