AI-generated Key Takeaways
-
The new Search Ads 360 Reporting API offers enhanced flexibility for building custom reports and data integration.
-
Reports can be filtered to show specific data by defining criteria using filters.
-
Filters are case-sensitive and operate on various data types with different operators like
equals
,startsWith
,containsSubstring
, and more. -
Some columns are not filterable, and the 'Types of Reports' reference indicates filterable columns.
-
A table provides a detailed explanation of each filter operator, its function, and the number of values it supports.
By default, your report will contain all of the data within the reportScope that your request specifies. If you want a report to contain only the data that matches a set of criteria, you can add one or more filters to a report. Only rows that satisfy all filters are returned.
For example, you can request a report of all the keywords in an agency. Then you can specify a filter so that only keywords with landing page URLs starting with www.example.com and www.another-example.com appear in the report.
"filters": [ { "column" : { "columnName": "keywordLandingPage" }, "operator" : "startsWith", "values" : [ "http://www.example.com", "http://www.another-example.com" ] } ]
Each filter specifies a column to be filtered, an operator, and a list of values that are expected to be in the specified column:
"filters": [ { "column" : column to filter on, "operator" : operator specifying the type of filter, "values" : list of values }, { ... another filter can go here ... } ]
Filterable
.
Filter operators
All filters are case sensitive. That is, a filter with "www.Sprockets.com" will not match a column that contains "www.sprockets.com".
Operator | Description | Number of values supported |
---|---|---|
equals |
The column must exactly match the specified value. | 1 |
notEquals |
The column must not match the specified value. | 1 |
in |
The column must exactly match one of the values in the filter's list.
Not valid for list data types (such as |
variable |
lessThan |
The column must contain a value that is less than the specified value.
If you specify this filter for a Not valid for list data types (such as |
1 |
greaterThan |
The column must contain a value that is greater than one of the values in the filter's list.
If you specify this filter for a
Not valid for list data types (such as |
1 |
lessThanOrEqual |
The column must contain a value that is less than or equal to one of the values in the filter's list.
If you specify this filter for a
Not valid for list data types (such as |
1 |
greaterThanOrEqual |
The column must contain a value that is greater than or equal to one of the values in the filter's list.
If you specify this filter for a
Not valid for list data types (such as |
1 |
isNull |
The column must be empty. For example, if you specify isNull
for the keywordMaxCpc column in a keyword report, the report
will contain only keywords that have not specified a Max CPC.
|
0 |
isNotNull |
The column must contain a value. | 0 |
startsWith |
The column must start with one of the strings in the filter's list.
Only valid for |
variable |
containsSubstring |
The column must contain all or part of one of the strings specified in the filter's list.
For example, a
but would not return rows with these values:
Only valid for |
variable |
doesNotContainSubstring |
The column must not contain any of the strings in the filter's list.
For example, a but would not return rows with these values:
Only valid for |
variable |
containsElement |
The column must contain at least one of values in the filter's list.
Only valid for columns with list data types (such as
For example in a |
variable |