| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.filters.html">filters</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(accountId, filterId)</a></code></p> |
| <p class="firstline">Delete a filter.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(accountId, filterId)</a></code></p> |
| <p class="firstline">Returns filters to which the user has access.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(accountId, body=None)</a></code></p> |
| <p class="firstline">Create a new filter.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(accountId, start_index=None, max_results=None)</a></code></p> |
| <p class="firstline">Lists all filters for an account</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(accountId, filterId, body=None)</a></code></p> |
| <p class="firstline">Updates an existing filter. This method supports patch semantics.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(accountId, filterId, body=None)</a></code></p> |
| <p class="firstline">Updates an existing filter.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(accountId, filterId)</code> |
| <pre>Delete a filter. |
| |
| Args: |
| accountId: string, Account ID to delete the filter for. (required) |
| filterId: string, ID of the filter to be deleted. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(accountId, filterId)</code> |
| <pre>Returns filters to which the user has access. |
| |
| Args: |
| accountId: string, Account ID to retrieve filters for. (required) |
| filterId: string, Filter ID to retrieve filters for. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(accountId, body=None)</code> |
| <pre>Create a new filter. |
| |
| Args: |
| accountId: string, Account ID to create filter for. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(accountId, start_index=None, max_results=None)</code> |
| <pre>Lists all filters for an account |
| |
| Args: |
| accountId: string, Account ID to retrieve filters for. (required) |
| start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| max_results: integer, The maximum number of filters to include in this response. |
| |
| Returns: |
| An object of the form: |
| |
| { # A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter. |
| "nextLink": "A String", # Link to next page for this filter collection. |
| "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. |
| "username": "A String", # Email ID of the authenticated user |
| "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| "kind": "analytics#filters", # Collection type. |
| "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| "previousLink": "A String", # Link to previous page for this filter collection. |
| "items": [ # A list of filters. |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(accountId, filterId, body=None)</code> |
| <pre>Updates an existing filter. This method supports patch semantics. |
| |
| Args: |
| accountId: string, Account ID to which the filter belongs. (required) |
| filterId: string, ID of the filter to be updated. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(accountId, filterId, body=None)</code> |
| <pre>Updates an existing filter. |
| |
| Args: |
| accountId: string, Account ID to which the filter belongs. (required) |
| filterId: string, ID of the filter to be updated. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # JSON template for an Analytics account filter. |
| "updated": "A String", # Time this filter was last modified. |
| "selfLink": "A String", # Link for this filter. |
| "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A 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), |
| "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. |
| "expressionValue": "A String", # Filter expression value |
| "matchType": "A 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": "analytics#filterExpression", # Kind value for filter expression |
| }, |
| "advancedDetails": { # Details for the filter of the type ADVANCED. |
| "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. |
| "fieldBRequired": True or False, # Indicates if field B is required to match. |
| "fieldB": "A String", # Field B. |
| "outputToField": "A String", # Output field. |
| "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. |
| "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldA": "A String", # Field A. |
| "extractA": "A String", # Expression to extract from field A. |
| "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "extractB": "A String", # Expression to extract from field B. |
| "outputConstructor": "A String", # Expression used to construct the output value. |
| "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| "fieldARequired": True or False, # Indicates if field A is required to match. |
| }, |
| "uppercaseDetails": { # Details for the filter of the type UPPER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. |
| "replaceString": "A String", # Term to replace the search term with. |
| "searchString": "A String", # Term to search. |
| "caseSensitive": True or False, # Determines if the filter is case sensitive. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. |
| "href": "A String", # Link to the account to which this filter belongs. |
| "type": "analytics#account", # Value is "analytics#account". |
| }, |
| "created": "A String", # Time this filter was created. |
| "id": "A String", # Filter ID. |
| "accountId": "A String", # Account ID to which this filter belongs. |
| "lowercaseDetails": { # Details for the filter of the type LOWER. |
| "field": "A String", # Field to use in the filter. |
| "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. |
| }, |
| "name": "A String", # Name of this filter. |
| "kind": "analytics#filter", # Resource type for Analytics filter. |
| }</pre> |
| </div> |
| |
| </body></html> |
