Insert

Create a new filter

52 variables
51 variables

Create a new filter

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Edit Google Analytics management entities

Input

This building block consumes 52 input parameters

  = Parameter name
  = Format

accountId STRING Required

Account ID to create filter for

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

advancedDetails.extractA STRING

Expression to extract from field A

advancedDetails.extractB STRING

Expression to extract from field B

advancedDetails.fieldA STRING

Field A

advancedDetails.fieldAIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

advancedDetails.fieldARequired BOOLEAN

Indicates if field A is required to match

advancedDetails.fieldB STRING

Field B

advancedDetails.fieldBIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

advancedDetails.fieldBRequired BOOLEAN

Indicates if field B is required to match

advancedDetails.outputConstructor STRING

Expression used to construct the output value

advancedDetails.outputToField STRING

Output field

advancedDetails.outputToFieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

advancedDetails.overrideOutputField BOOLEAN

Indicates if the existing value of the output field, if any, should be overridden by the output expression

created DATE_TIME

Time this filter was created

excludeDetails OBJECT

JSON template for an Analytics filter expression

excludeDetails.caseSensitive BOOLEAN

Determines if the filter is case sensitive

excludeDetails.expressionValue STRING

Filter expression value

excludeDetails.field STRING

Field to filter. Possible values:

  • Content and Traffic
  • PAGE_REQUEST_URI,
  • PAGE_HOSTNAME,
  • PAGE_TITLE,
  • REFERRAL,
  • COST_DATA_URI (Campaign target URL),
  • HIT_TYPE,
  • INTERNAL_SEARCH_TERM,
  • INTERNAL_SEARCH_TYPE,
  • SOURCE_PROPERTY_TRACKING_ID,
  • Campaign or AdGroup
  • CAMPAIGN_SOURCE,
  • CAMPAIGN_MEDIUM,
  • CAMPAIGN_NAME,
  • CAMPAIGN_AD_GROUP,
  • CAMPAIGN_TERM,
  • CAMPAIGN_CONTENT,
  • CAMPAIGN_CODE,
  • CAMPAIGN_REFERRAL_PATH,
  • E-Commerce
  • TRANSACTION_COUNTRY,
  • TRANSACTION_REGION,
  • TRANSACTION_CITY,
  • TRANSACTION_AFFILIATION (Store or order location),
  • ITEM_NAME,
  • ITEM_CODE,
  • ITEM_VARIATION,
  • TRANSACTION_ID,
  • TRANSACTION_CURRENCY_CODE,
  • PRODUCT_ACTION_TYPE,
  • Audience/Users
  • BROWSER,
  • BROWSER_VERSION,
  • BROWSER_SIZE,
  • PLATFORM,
  • PLATFORM_VERSION,
  • LANGUAGE,
  • SCREEN_RESOLUTION,
  • SCREEN_COLORS,
  • JAVA_ENABLED (Boolean Field),
  • FLASH_VERSION,
  • GEO_SPEED (Connection speed),
  • VISITOR_TYPE,
  • GEO_ORGANIZATION (ISP organization),
  • GEO_DOMAIN,
  • GEO_IP_ADDRESS,
  • GEO_IP_VERSION,
  • Location
  • GEO_COUNTRY,
  • GEO_REGION,
  • GEO_CITY,
  • Event
  • EVENT_CATEGORY,
  • EVENT_ACTION,
  • EVENT_LABEL,
  • Other
  • CUSTOM_FIELD_1,
  • CUSTOM_FIELD_2,
  • USER_DEFINED_VALUE,
  • Application
  • APP_ID,
  • APP_INSTALLER_ID,
  • APP_NAME,
  • APP_VERSION,
  • SCREEN,
  • IS_APP (Boolean Field),
  • IS_FATAL_EXCEPTION (Boolean Field),
  • EXCEPTION_DESCRIPTION,
  • Mobile device
  • IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
  • IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
  • DEVICE_CATEGORY,
  • MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
  • MOBILE_HAS_NFC_SUPPORT (Boolean Field),
  • MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
  • MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
  • MOBILE_BRAND_NAME,
  • MOBILE_MODEL_NAME,
  • MOBILE_MARKETING_NAME,
  • MOBILE_POINTING_METHOD,
  • Social
  • SOCIAL_NETWORK,
  • SOCIAL_ACTION,
  • SOCIAL_ACTION_TARGET,
  • Custom dimension
  • CUSTOM_DIMENSION (See accompanying field index),

excludeDetails.fieldIndex INTEGER

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION

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

id STRING

Filter ID

includeDetails OBJECT

JSON template for an Analytics filter expression

includeDetails.caseSensitive BOOLEAN

Determines if the filter is case sensitive

includeDetails.expressionValue STRING

Filter expression value

includeDetails.field STRING

Field to filter. Possible values:

  • Content and Traffic
  • PAGE_REQUEST_URI,
  • PAGE_HOSTNAME,
  • PAGE_TITLE,
  • REFERRAL,
  • COST_DATA_URI (Campaign target URL),
  • HIT_TYPE,
  • INTERNAL_SEARCH_TERM,
  • INTERNAL_SEARCH_TYPE,
  • SOURCE_PROPERTY_TRACKING_ID,
  • Campaign or AdGroup
  • CAMPAIGN_SOURCE,
  • CAMPAIGN_MEDIUM,
  • CAMPAIGN_NAME,
  • CAMPAIGN_AD_GROUP,
  • CAMPAIGN_TERM,
  • CAMPAIGN_CONTENT,
  • CAMPAIGN_CODE,
  • CAMPAIGN_REFERRAL_PATH,
  • E-Commerce
  • TRANSACTION_COUNTRY,
  • TRANSACTION_REGION,
  • TRANSACTION_CITY,
  • TRANSACTION_AFFILIATION (Store or order location),
  • ITEM_NAME,
  • ITEM_CODE,
  • ITEM_VARIATION,
  • TRANSACTION_ID,
  • TRANSACTION_CURRENCY_CODE,
  • PRODUCT_ACTION_TYPE,
  • Audience/Users
  • BROWSER,
  • BROWSER_VERSION,
  • BROWSER_SIZE,
  • PLATFORM,
  • PLATFORM_VERSION,
  • LANGUAGE,
  • SCREEN_RESOLUTION,
  • SCREEN_COLORS,
  • JAVA_ENABLED (Boolean Field),
  • FLASH_VERSION,
  • GEO_SPEED (Connection speed),
  • VISITOR_TYPE,
  • GEO_ORGANIZATION (ISP organization),
  • GEO_DOMAIN,
  • GEO_IP_ADDRESS,
  • GEO_IP_VERSION,
  • Location
  • GEO_COUNTRY,
  • GEO_REGION,
  • GEO_CITY,
  • Event
  • EVENT_CATEGORY,
  • EVENT_ACTION,
  • EVENT_LABEL,
  • Other
  • CUSTOM_FIELD_1,
  • CUSTOM_FIELD_2,
  • USER_DEFINED_VALUE,
  • Application
  • APP_ID,
  • APP_INSTALLER_ID,
  • APP_NAME,
  • APP_VERSION,
  • SCREEN,
  • IS_APP (Boolean Field),
  • IS_FATAL_EXCEPTION (Boolean Field),
  • EXCEPTION_DESCRIPTION,
  • Mobile device
  • IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
  • IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
  • DEVICE_CATEGORY,
  • MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
  • MOBILE_HAS_NFC_SUPPORT (Boolean Field),
  • MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
  • MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
  • MOBILE_BRAND_NAME,
  • MOBILE_MODEL_NAME,
  • MOBILE_MARKETING_NAME,
  • MOBILE_POINTING_METHOD,
  • Social
  • SOCIAL_NETWORK,
  • SOCIAL_ACTION,
  • SOCIAL_ACTION_TARGET,
  • Custom dimension
  • CUSTOM_DIMENSION (See accompanying field index),

includeDetails.fieldIndex INTEGER

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION

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

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

lowercaseDetails.fieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

name STRING

Name of this filter

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

searchAndReplaceDetails.field STRING

Field to use in the filter

searchAndReplaceDetails.fieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

searchAndReplaceDetails.replaceString STRING

Term to replace the search term with

searchAndReplaceDetails.searchString STRING

Term to search

selfLink STRING

Link for this filter

type STRING

Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED

updated DATE_TIME

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

uppercaseDetails.fieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

Output

This building block provides 51 output parameters

  = Parameter name
  = Format

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

advancedDetails.extractA STRING

Expression to extract from field A

advancedDetails.extractB STRING

Expression to extract from field B

advancedDetails.fieldA STRING

Field A

advancedDetails.fieldAIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

advancedDetails.fieldARequired BOOLEAN

Indicates if field A is required to match

advancedDetails.fieldB STRING

Field B

advancedDetails.fieldBIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

advancedDetails.fieldBRequired BOOLEAN

Indicates if field B is required to match

advancedDetails.outputConstructor STRING

Expression used to construct the output value

advancedDetails.outputToField STRING

Output field

advancedDetails.outputToFieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

advancedDetails.overrideOutputField BOOLEAN

Indicates if the existing value of the output field, if any, should be overridden by the output expression

created DATE_TIME

Time this filter was created

excludeDetails OBJECT

JSON template for an Analytics filter expression

excludeDetails.caseSensitive BOOLEAN

Determines if the filter is case sensitive

excludeDetails.expressionValue STRING

Filter expression value

excludeDetails.field STRING

Field to filter. Possible values:

  • Content and Traffic
  • PAGE_REQUEST_URI,
  • PAGE_HOSTNAME,
  • PAGE_TITLE,
  • REFERRAL,
  • COST_DATA_URI (Campaign target URL),
  • HIT_TYPE,
  • INTERNAL_SEARCH_TERM,
  • INTERNAL_SEARCH_TYPE,
  • SOURCE_PROPERTY_TRACKING_ID,
  • Campaign or AdGroup
  • CAMPAIGN_SOURCE,
  • CAMPAIGN_MEDIUM,
  • CAMPAIGN_NAME,
  • CAMPAIGN_AD_GROUP,
  • CAMPAIGN_TERM,
  • CAMPAIGN_CONTENT,
  • CAMPAIGN_CODE,
  • CAMPAIGN_REFERRAL_PATH,
  • E-Commerce
  • TRANSACTION_COUNTRY,
  • TRANSACTION_REGION,
  • TRANSACTION_CITY,
  • TRANSACTION_AFFILIATION (Store or order location),
  • ITEM_NAME,
  • ITEM_CODE,
  • ITEM_VARIATION,
  • TRANSACTION_ID,
  • TRANSACTION_CURRENCY_CODE,
  • PRODUCT_ACTION_TYPE,
  • Audience/Users
  • BROWSER,
  • BROWSER_VERSION,
  • BROWSER_SIZE,
  • PLATFORM,
  • PLATFORM_VERSION,
  • LANGUAGE,
  • SCREEN_RESOLUTION,
  • SCREEN_COLORS,
  • JAVA_ENABLED (Boolean Field),
  • FLASH_VERSION,
  • GEO_SPEED (Connection speed),
  • VISITOR_TYPE,
  • GEO_ORGANIZATION (ISP organization),
  • GEO_DOMAIN,
  • GEO_IP_ADDRESS,
  • GEO_IP_VERSION,
  • Location
  • GEO_COUNTRY,
  • GEO_REGION,
  • GEO_CITY,
  • Event
  • EVENT_CATEGORY,
  • EVENT_ACTION,
  • EVENT_LABEL,
  • Other
  • CUSTOM_FIELD_1,
  • CUSTOM_FIELD_2,
  • USER_DEFINED_VALUE,
  • Application
  • APP_ID,
  • APP_INSTALLER_ID,
  • APP_NAME,
  • APP_VERSION,
  • SCREEN,
  • IS_APP (Boolean Field),
  • IS_FATAL_EXCEPTION (Boolean Field),
  • EXCEPTION_DESCRIPTION,
  • Mobile device
  • IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
  • IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
  • DEVICE_CATEGORY,
  • MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
  • MOBILE_HAS_NFC_SUPPORT (Boolean Field),
  • MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
  • MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
  • MOBILE_BRAND_NAME,
  • MOBILE_MODEL_NAME,
  • MOBILE_MARKETING_NAME,
  • MOBILE_POINTING_METHOD,
  • Social
  • SOCIAL_NETWORK,
  • SOCIAL_ACTION,
  • SOCIAL_ACTION_TARGET,
  • Custom dimension
  • CUSTOM_DIMENSION (See accompanying field index),

excludeDetails.fieldIndex INTEGER

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION

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

id STRING

Filter ID

includeDetails OBJECT

JSON template for an Analytics filter expression

includeDetails.caseSensitive BOOLEAN

Determines if the filter is case sensitive

includeDetails.expressionValue STRING

Filter expression value

includeDetails.field STRING

Field to filter. Possible values:

  • Content and Traffic
  • PAGE_REQUEST_URI,
  • PAGE_HOSTNAME,
  • PAGE_TITLE,
  • REFERRAL,
  • COST_DATA_URI (Campaign target URL),
  • HIT_TYPE,
  • INTERNAL_SEARCH_TERM,
  • INTERNAL_SEARCH_TYPE,
  • SOURCE_PROPERTY_TRACKING_ID,
  • Campaign or AdGroup
  • CAMPAIGN_SOURCE,
  • CAMPAIGN_MEDIUM,
  • CAMPAIGN_NAME,
  • CAMPAIGN_AD_GROUP,
  • CAMPAIGN_TERM,
  • CAMPAIGN_CONTENT,
  • CAMPAIGN_CODE,
  • CAMPAIGN_REFERRAL_PATH,
  • E-Commerce
  • TRANSACTION_COUNTRY,
  • TRANSACTION_REGION,
  • TRANSACTION_CITY,
  • TRANSACTION_AFFILIATION (Store or order location),
  • ITEM_NAME,
  • ITEM_CODE,
  • ITEM_VARIATION,
  • TRANSACTION_ID,
  • TRANSACTION_CURRENCY_CODE,
  • PRODUCT_ACTION_TYPE,
  • Audience/Users
  • BROWSER,
  • BROWSER_VERSION,
  • BROWSER_SIZE,
  • PLATFORM,
  • PLATFORM_VERSION,
  • LANGUAGE,
  • SCREEN_RESOLUTION,
  • SCREEN_COLORS,
  • JAVA_ENABLED (Boolean Field),
  • FLASH_VERSION,
  • GEO_SPEED (Connection speed),
  • VISITOR_TYPE,
  • GEO_ORGANIZATION (ISP organization),
  • GEO_DOMAIN,
  • GEO_IP_ADDRESS,
  • GEO_IP_VERSION,
  • Location
  • GEO_COUNTRY,
  • GEO_REGION,
  • GEO_CITY,
  • Event
  • EVENT_CATEGORY,
  • EVENT_ACTION,
  • EVENT_LABEL,
  • Other
  • CUSTOM_FIELD_1,
  • CUSTOM_FIELD_2,
  • USER_DEFINED_VALUE,
  • Application
  • APP_ID,
  • APP_INSTALLER_ID,
  • APP_NAME,
  • APP_VERSION,
  • SCREEN,
  • IS_APP (Boolean Field),
  • IS_FATAL_EXCEPTION (Boolean Field),
  • EXCEPTION_DESCRIPTION,
  • Mobile device
  • IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile),
  • IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet),
  • DEVICE_CATEGORY,
  • MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field),
  • MOBILE_HAS_NFC_SUPPORT (Boolean Field),
  • MOBILE_HAS_CELLULAR_RADIO (Boolean Field),
  • MOBILE_HAS_WIFI_SUPPORT (Boolean Field),
  • MOBILE_BRAND_NAME,
  • MOBILE_MODEL_NAME,
  • MOBILE_MARKETING_NAME,
  • MOBILE_POINTING_METHOD,
  • Social
  • SOCIAL_NETWORK,
  • SOCIAL_ACTION,
  • SOCIAL_ACTION_TARGET,
  • Custom dimension
  • CUSTOM_DIMENSION (See accompanying field index),

includeDetails.fieldIndex INTEGER

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION

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

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

lowercaseDetails.fieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

name STRING

Name of this filter

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

searchAndReplaceDetails.field STRING

Field to use in the filter

searchAndReplaceDetails.fieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION

searchAndReplaceDetails.replaceString STRING

Term to replace the search term with

searchAndReplaceDetails.searchString STRING

Term to search

selfLink STRING

Link for this filter

type STRING

Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED

updated DATE_TIME

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

uppercaseDetails.fieldIndex INTEGER

The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION