Class: Google::Apis::AnalyticsV3::FilterExpression

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analytics_v3/classes.rb,
generated/google/apis/analytics_v3/representations.rb,
generated/google/apis/analytics_v3/representations.rb

Overview

JSON template for an Analytics filter expression.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FilterExpression

Returns a new instance of FilterExpression.


2275
2276
2277
# File 'generated/google/apis/analytics_v3/classes.rb', line 2275

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#case_sensitiveBoolean Also known as: case_sensitive?

Determines if the filter is case sensitive. Corresponds to the JSON property caseSensitive

Returns:

  • (Boolean)

2157
2158
2159
# File 'generated/google/apis/analytics_v3/classes.rb', line 2157

def case_sensitive
  @case_sensitive
end

#expression_valueString

Filter expression value Corresponds to the JSON property expressionValue

Returns:

  • (String)

2163
2164
2165
# File 'generated/google/apis/analytics_v3/classes.rb', line 2163

def expression_value
  @expression_value
end

#fieldString

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), Corresponds to the JSON property field

Returns:

  • (String)

2254
2255
2256
# File 'generated/google/apis/analytics_v3/classes.rb', line 2254

def field
  @field
end

#field_indexFixnum

The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. Corresponds to the JSON property fieldIndex

Returns:

  • (Fixnum)

2260
2261
2262
# File 'generated/google/apis/analytics_v3/classes.rb', line 2260

def field_index
  @field_index
end

#kindString

Kind value for filter expression Corresponds to the JSON property kind

Returns:

  • (String)

2265
2266
2267
# File 'generated/google/apis/analytics_v3/classes.rb', line 2265

def kind
  @kind
end

#match_typeString

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. Corresponds to the JSON property matchType

Returns:

  • (String)

2273
2274
2275
# File 'generated/google/apis/analytics_v3/classes.rb', line 2273

def match_type
  @match_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2280
2281
2282
2283
2284
2285
2286
2287
# File 'generated/google/apis/analytics_v3/classes.rb', line 2280

def update!(**args)
  @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
  @expression_value = args[:expression_value] if args.key?(:expression_value)
  @field = args[:field] if args.key?(:field)
  @field_index = args[:field_index] if args.key?(:field_index)
  @kind = args[:kind] if args.key?(:kind)
  @match_type = args[:match_type] if args.key?(:match_type)
end