filter
查询字符串参数可限制AdSense Management API报告中返回的数据。使用filter
参数时,您需要提供要过滤的维度,以及过滤器表达式。
过滤查询会限制要包含在结果中的行。结果中的每一行都要用过滤器进行测试:如果某行符合过滤器的条件,则保留该行;否则将删除该行。
- 网址编码:客户端库会自动对过滤器运算符进行编码。但是,如果您直接向协议发出请求,那么您必须明确地对过滤器运算符进行编码,具体如下表所示。
- 过滤优先级:过滤发生在汇总任何维度之前,因此返回的指标仅代表相关维度的总和。
过滤器语法
单个过滤器使用以下格式:
name operator expression
在此语法中:
- name — 应用过滤的维度的名称。例如:
AD_CLIENT_ID
会按广告客户ID进行过滤。 - operator — 定义要使用的过滤器匹配的类型。
- expression — 说明要在结果中包含的值。
过滤器运算符
过滤器运算符有两种。运算符必须采用网址编码,才能纳入网址查询字符串。
运算符 | 说明 | 网址编码格式 | 示例 |
---|---|---|---|
== | 完全匹配 | %3D%3D | 国家/地区名称是“Canada”时的汇总指标:filter=COUNTRY_NAME%3D%3DCanada |
=@ | 包含子字符串 | %3D@ | 国家/地区名称包含“United”(例如“United States”和“United Kingdom”都是匹配情况)时的汇总指标:filter=COUNTRY_NAME%3D@United |
过滤器表达式
下面是过滤器表达式要遵守的几大规则:
- 网址预留字符 —
&
等字符必须以常规方式进行网址编码。客户端库会替您完成编码,因此您只需在向协议发出直接调用时考虑此编码问题。 - 预留字符:如果逗号和反斜杠出现在表达式中,那么必须加上反斜杠进行转义。
- 反斜杠
\\
- 逗号
\,
- 反斜杠
注意:请务必将转义反斜杠加在逗号前面,以避免重复转义。
合并过滤器
过滤器可以使用OR
和AND
布尔值逻辑进行组合。
OR逻辑
OR
逻辑通过在过滤器表达式中使用逗号(,
)进行定义。
示例:(均须经过网址编码)
国家/地区代码是(US OR UK):
COUNTRY_CODE==US,COUNTRY_CODE==UK
AND逻辑
AND
逻辑通过提供多个过滤器参数(会表达为在客户端库中提供一系列过滤器)实现。
示例:
国家/地区代码是US AND产品代码是AFC:
filter=COUNTRY_CODE%3D%3DUS&filter=PRODUCT_CODE%3D%3DAFC
合并AND和OR逻辑
您可以将AND和OR逻辑合并在同一个表达式中。
注意:系统会对每个过滤器进行单独评估,然后才会将它们合并到一个AND逻辑表达式中。
示例:
国家/地区代码是(US OR UK) AND产品代码是AFC:
filter=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filter=PRODUCT_CODE%3D%3DAFC