RGA (version 0.4.2)

get_filter: Filters

Description

Returns a filters to which the user has access.

Usage

get_filter(accountId, filterId, token)

Arguments

accountId

character. Account ID to retrieve filters for.

filterId

character. Filter ID to retrieve filters for.

token

Token2.0 class object with a valid authorization data.

Value

The Filters collection is a set of Filter resources, each of which describes a filter which can be applied to a View (profile).

id

Filter ID.

kind

Resource type for Analytics filter.

accountId

Account ID to which this filter belongs.

name

Name of this filter.

type

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

created

Time this filter was created.

updated

Time this filter was last modified.

includeDetails

Details for the filter of the type INCLUDE.

excludeDetails

Details for the filter of the type EXCLUDE.

lowercaseDetails

Details for the filter of the type LOWER.

uppercaseDetails

Details for the filter of the type UPPER.

searchAndReplaceDetails

Details for the filter of the type SEARCH_AND_REPLACE.

advancedDetails

Details for the filter of the type ADVANCED.

includeDetails.kind

Kind value for filter expression

includeDetails.field

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,

includeDetails.matchType

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.

includeDetails.expressionValue

Filter expression value

includeDetails.caseSensitive

Determines if the filter is case sensitive.

includeDetails.fieldIndex

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

excludeDetails.kind

Kind value for filter expression

excludeDetails.field

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,

excludeDetails.matchType

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.

excludeDetails.expressionValue

Filter expression value

excludeDetails.caseSensitive

Determines if the filter is case sensitive.

excludeDetails.fieldIndex

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

lowercaseDetails.field

Field to use in the filter.

lowercaseDetails.fieldIndex

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

uppercaseDetails.field

Field to use in the filter.

uppercaseDetails.fieldIndex

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

searchAndReplaceDetails.field

Field to use in the filter.

searchAndReplaceDetails.fieldIndex

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

searchAndReplaceDetails.searchString

Term to search.

searchAndReplaceDetails.replaceString

Term to replace the search term with.

searchAndReplaceDetails.caseSensitive

Determines if the filter is case sensitive.

advancedDetails.fieldA

Field A.

advancedDetails.fieldAIndex

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

advancedDetails.extractA

Expression to extract from field A.

advancedDetails.fieldB

Field B.

advancedDetails.fieldBIndex

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

advancedDetails.extractB

Expression to extract from field B.

advancedDetails.outputToField

Output field.

advancedDetails.outputToFieldIndex

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

advancedDetails.outputConstructor

Expression used to construct the output value.

advancedDetails.fieldARequired

Indicates if field A is required to match.

advancedDetails.fieldBRequired

Indicates if field B is required to match.

advancedDetails.overrideOutputField

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

advancedDetails.caseSensitive

Indicates if the filter expressions are case sensitive.

References

Management API - Filters Overview

See Also

Other Management API: get_custom_dimension, get_custom_metric, get_experiment, get_goal, get_profile, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_experiments, list_filters, list_goals, list_profiles, list_segments, list_unsampled_reports, list_uploads, list_webproperties