The Filters collection is a set of Filter resources, each of which describes a filter which can be applied to a View (profile).
For a list of methods for this resource, see the end of this page.
Resource representations
JSON template for an Analytics account filter.
{ "id": string, "kind": "analytics#filter", "selfLink": string, "accountId": string, "name": string, "type": string, "created": datetime, "updated": datetime, "parentLink": { "type": "analytics#account", "href": string }, "includeDetails": { "kind": "analytics#filterExpression", "field": string, "matchType": string, "expressionValue": string, "caseSensitive": boolean, "fieldIndex": integer }, "excludeDetails": { "kind": "analytics#filterExpression", "field": string, "matchType": string, "expressionValue": string, "caseSensitive": boolean, "fieldIndex": integer }, "lowercaseDetails": { "field": string, "fieldIndex": integer }, "uppercaseDetails": { "field": string, "fieldIndex": integer }, "searchAndReplaceDetails": { "field": string, "fieldIndex": integer, "searchString": string, "replaceString": string, "caseSensitive": boolean }, "advancedDetails": { "fieldA": string, "fieldAIndex": integer, "extractA": string, "fieldB": string, "fieldBIndex": integer, "extractB": string, "outputToField": string, "outputToFieldIndex": integer, "outputConstructor": string, "fieldARequired": boolean, "fieldBRequired": boolean, "overrideOutputField": boolean, "caseSensitive": boolean } }
Property name | Value | Description | Notes |
---|---|---|---|
accountId |
string |
Account ID to which this filter belongs. | |
advancedDetails |
object |
Details for the filter of the type ADVANCED. | |
advancedDetails.caseSensitive |
boolean |
Indicates if the filter expressions are case sensitive. | writable |
advancedDetails.extractA |
string |
Expression to extract from field A. | writable |
advancedDetails.extractB |
string |
Expression to extract from field B. | writable |
advancedDetails.fieldA |
string |
Field A. | writable |
advancedDetails.fieldAIndex |
integer |
The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. | writable |
advancedDetails.fieldARequired |
boolean |
Indicates if field A is required to match. | writable |
advancedDetails.fieldB |
string |
Field B. | writable |
advancedDetails.fieldBIndex |
integer |
The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. | writable |
advancedDetails.fieldBRequired |
boolean |
Indicates if field B is required to match. | writable |
advancedDetails.outputConstructor |
string |
Expression used to construct the output value. | writable |
advancedDetails.outputToField |
string |
Output field. | writable |
advancedDetails.outputToFieldIndex |
integer |
The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. | writable |
advancedDetails.overrideOutputField |
boolean |
Indicates if the existing value of the output field, if any, should be overridden by the output expression. | writable |
created |
datetime |
Time this filter was created. | |
excludeDetails |
nested object |
Details for the filter of the type EXCLUDE. | |
excludeDetails.caseSensitive |
boolean |
Determines if the filter is case sensitive. | writable |
excludeDetails.expressionValue |
string |
Filter expression value | writable |
excludeDetails.field |
string |
Field to filter. Possible values:
|
writable |
excludeDetails.fieldIndex |
integer |
The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. | writable |
excludeDetails.kind |
string |
Kind value for filter expression | |
excludeDetails.matchType |
string |
Match type for this filter. Possible values are BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS , or MATCHES . GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI , or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES . |
writable |
id |
string |
Filter ID. | |
includeDetails |
nested object |
Details for the filter of the type INCLUDE. | |
includeDetails.caseSensitive |
boolean |
Determines if the filter is case sensitive. | writable |
includeDetails.expressionValue |
string |
Filter expression value | writable |
includeDetails.field |
string |
Field to filter. Possible values:
|
writable |
includeDetails.fieldIndex |
integer |
The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. | writable |
includeDetails.kind |
string |
Kind value for filter expression | |
includeDetails.matchType |
string |
Match type for this filter. Possible values are BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS , or MATCHES . GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI , or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES . |
writable |
kind |
string |
Resource type for Analytics filter. | |
lowercaseDetails |
object |
Details for the filter of the type LOWER. | |
lowercaseDetails.field |
string |
Field to use in the filter. | writable |
lowercaseDetails.fieldIndex |
integer |
The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. | writable |
name |
string |
Name of this filter. | writable |
parentLink |
object |
Parent link for this filter. Points to the account to which this filter belongs. | |
parentLink.href |
string |
Link to the account to which this filter belongs. | |
parentLink.type |
string |
Value is "analytics#account". | |
searchAndReplaceDetails |
object |
Details for the filter of the type SEARCH_AND_REPLACE. | |
searchAndReplaceDetails.caseSensitive |
boolean |
Determines if the filter is case sensitive. | writable |
searchAndReplaceDetails.field |
string |
Field to use in the filter. | writable |
searchAndReplaceDetails.fieldIndex |
integer |
The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. | writable |
searchAndReplaceDetails.replaceString |
string |
Term to replace the search term with. | writable |
searchAndReplaceDetails.searchString |
string |
Term to search. | writable |
selfLink |
string |
Link for this filter. | |
type |
string |
Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. | writable |
updated |
datetime |
Time this filter was last modified. | |
uppercaseDetails |
object |
Details for the filter of the type UPPER. | |
uppercaseDetails.field |
string |
Field to use in the filter. | writable |
uppercaseDetails.fieldIndex |
integer |
The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. | writable |