Параметр строки запроса filters
ограничивает данные, возвращаемые в отчете API управления AdSense. Когда вы используете параметр filters
, вы указываете измерение, по которому хотите фильтровать, а затем выражение фильтра.
Отфильтрованные запросы ограничивают количество строк, которые включаются в результат. Каждая строка в результате проверяется на соответствие фильтру: если фильтр соответствует, строка сохраняется, а если не соответствует, строка удаляется.
- Кодирование URL : клиентские библиотеки автоматически кодируют операторы фильтра. Однако если вы отправляете запросы непосредственно к протоколу, вам необходимо явно закодировать операторы фильтра, как указано в таблице ниже.
- Приоритет фильтрации . Фильтрация происходит до агрегирования каких-либо параметров, поэтому возвращаемые показатели представляют собой итоговые значения только для соответствующих параметров.
Синтаксис фильтра
Один фильтр использует форму:
name operator expression
В этом синтаксисе:
- name — имя измерения, по которому выполняется фильтрация. Например:
AD_CLIENT_ID
будет фильтроваться по идентификатору рекламного клиента. - оператор — определяет тип используемого фильтра.
- выражение — указывает значения, включенные в результаты.
Все измерения , применимые к показателям, о которых сообщается, можно использовать в качестве фильтров, за исключением измерений, связанных с датой ( DATE
, WEEK
и MONTH
). Чтобы фильтровать по дате, вместо этого укажите диапазон дат для отчета .
Операторы фильтра
Есть два оператора фильтра. Операторы должны иметь URL-кодировку, чтобы их можно было включать в строки запроса URL-адреса.
Оператор | Описание | URL-кодированная форма | Пример |
---|---|---|---|
== | Точное совпадение | %3D%3D | Совокупные показатели, в которых страна называется Канада :filters=COUNTRY_NAME%3D%3DCanada |
=@ | Содержит подстроку | %3D@ | Совокупные показатели, в которых название страны содержит United , это соответствует, например, США и Великобритании:filters=COUNTRY_NAME%3D@United |
Фильтровать выражения
Для выражений фильтра существует несколько важных правил:
- Символы, зарезервированные для URL-адреса . Такие символы, как
&
должны быть закодированы в URL-адресе обычным способом. Клиентские библиотеки позаботятся об этом за вас, поэтому вам придется беспокоиться об этом кодировании только в том случае, если вы выполняете прямые вызовы протокола. - Зарезервированные символы . Запятая и обратная косая черта должны быть экранированы обратной косой чертой, когда они появляются в выражении.
- обратная косая черта
\\
- запятая
\,
- обратная косая черта
Примечание. Обязательно экранируйте обратную косую черту перед запятыми, чтобы избежать двойного экранирования.
Комбинирование фильтров
Фильтры можно комбинировать с помощью логической логики OR
и AND
ИЛИ логика
Логика OR
определяется с помощью запятой ( ,
) внутри выражения фильтра.
Пример: (каждый должен быть закодирован в URL-адресе)
Код страны: (США ИЛИ Великобритания):
COUNTRY_CODE==US,COUNTRY_CODE==UK
И логика
Логика AND
достигается за счет предоставления нескольких параметров фильтра, что означает предоставление массива фильтров в клиентских библиотеках.
Пример:
Код страны — США И код продукта — AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
Объединение логики И и ИЛИ
Логику И и ИЛИ можно объединить в одно выражение.
Примечание. Каждый фильтр оценивается индивидуально, прежде чем все фильтры объединяются в логическое выражение AND.
Пример:
Код страны — (США ИЛИ Великобритания) И код продукта — AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC