1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(accountId, filterId)</a></code></p> 82<p class="firstline">Delete a filter.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(accountId, filterId)</a></code></p> 85<p class="firstline">Returns filters to which the user has access.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(accountId, body=None)</a></code></p> 88<p class="firstline">Create a new filter.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p> 91<p class="firstline">Lists all filters for an account</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(accountId, filterId, body=None)</a></code></p> 94<p class="firstline">Updates an existing filter. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(accountId, filterId, body=None)</a></code></p> 97<p class="firstline">Updates an existing filter.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(accountId, filterId)</code> 106 <pre>Delete a filter. 107 108Args: 109 accountId: string, Account ID to delete the filter for. (required) 110 filterId: string, ID of the filter to be deleted. (required) 111 112Returns: 113 An object of the form: 114 115 { # JSON template for an Analytics account filter. 116 "accountId": "A String", # Account ID to which this filter belongs. 117 "advancedDetails": { # Details for the filter of the type ADVANCED. 118 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 119 "extractA": "A String", # Expression to extract from field A. 120 "extractB": "A String", # Expression to extract from field B. 121 "fieldA": "A String", # Field A. 122 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 123 "fieldARequired": True or False, # Indicates if field A is required to match. 124 "fieldB": "A String", # Field B. 125 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 126 "fieldBRequired": True or False, # Indicates if field B is required to match. 127 "outputConstructor": "A String", # Expression used to construct the output value. 128 "outputToField": "A String", # Output field. 129 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 130 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 131 }, 132 "created": "A String", # Time this filter was created. 133 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 134 "caseSensitive": True or False, # Determines if the filter is case sensitive. 135 "expressionValue": "A String", # Filter expression value 136 "field": "A String", # Field to filter. Possible values: 137 # - Content and Traffic 138 # - PAGE_REQUEST_URI, 139 # - PAGE_HOSTNAME, 140 # - PAGE_TITLE, 141 # - REFERRAL, 142 # - COST_DATA_URI (Campaign target URL), 143 # - HIT_TYPE, 144 # - INTERNAL_SEARCH_TERM, 145 # - INTERNAL_SEARCH_TYPE, 146 # - SOURCE_PROPERTY_TRACKING_ID, 147 # - Campaign or AdGroup 148 # - CAMPAIGN_SOURCE, 149 # - CAMPAIGN_MEDIUM, 150 # - CAMPAIGN_NAME, 151 # - CAMPAIGN_AD_GROUP, 152 # - CAMPAIGN_TERM, 153 # - CAMPAIGN_CONTENT, 154 # - CAMPAIGN_CODE, 155 # - CAMPAIGN_REFERRAL_PATH, 156 # - E-Commerce 157 # - TRANSACTION_COUNTRY, 158 # - TRANSACTION_REGION, 159 # - TRANSACTION_CITY, 160 # - TRANSACTION_AFFILIATION (Store or order location), 161 # - ITEM_NAME, 162 # - ITEM_CODE, 163 # - ITEM_VARIATION, 164 # - TRANSACTION_ID, 165 # - TRANSACTION_CURRENCY_CODE, 166 # - PRODUCT_ACTION_TYPE, 167 # - Audience/Users 168 # - BROWSER, 169 # - BROWSER_VERSION, 170 # - BROWSER_SIZE, 171 # - PLATFORM, 172 # - PLATFORM_VERSION, 173 # - LANGUAGE, 174 # - SCREEN_RESOLUTION, 175 # - SCREEN_COLORS, 176 # - JAVA_ENABLED (Boolean Field), 177 # - FLASH_VERSION, 178 # - GEO_SPEED (Connection speed), 179 # - VISITOR_TYPE, 180 # - GEO_ORGANIZATION (ISP organization), 181 # - GEO_DOMAIN, 182 # - GEO_IP_ADDRESS, 183 # - GEO_IP_VERSION, 184 # - Location 185 # - GEO_COUNTRY, 186 # - GEO_REGION, 187 # - GEO_CITY, 188 # - Event 189 # - EVENT_CATEGORY, 190 # - EVENT_ACTION, 191 # - EVENT_LABEL, 192 # - Other 193 # - CUSTOM_FIELD_1, 194 # - CUSTOM_FIELD_2, 195 # - USER_DEFINED_VALUE, 196 # - Application 197 # - APP_ID, 198 # - APP_INSTALLER_ID, 199 # - APP_NAME, 200 # - APP_VERSION, 201 # - SCREEN, 202 # - IS_APP (Boolean Field), 203 # - IS_FATAL_EXCEPTION (Boolean Field), 204 # - EXCEPTION_DESCRIPTION, 205 # - Mobile device 206 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 207 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 208 # - DEVICE_CATEGORY, 209 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 210 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 211 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 212 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 213 # - MOBILE_BRAND_NAME, 214 # - MOBILE_MODEL_NAME, 215 # - MOBILE_MARKETING_NAME, 216 # - MOBILE_POINTING_METHOD, 217 # - Social 218 # - SOCIAL_NETWORK, 219 # - SOCIAL_ACTION, 220 # - SOCIAL_ACTION_TARGET, 221 # - Custom dimension 222 # - CUSTOM_DIMENSION (See accompanying field index), 223 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 224 "kind": "analytics#filterExpression", # Kind value for filter expression 225 "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. 226 }, 227 "id": "A String", # Filter ID. 228 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 229 "caseSensitive": True or False, # Determines if the filter is case sensitive. 230 "expressionValue": "A String", # Filter expression value 231 "field": "A String", # Field to filter. Possible values: 232 # - Content and Traffic 233 # - PAGE_REQUEST_URI, 234 # - PAGE_HOSTNAME, 235 # - PAGE_TITLE, 236 # - REFERRAL, 237 # - COST_DATA_URI (Campaign target URL), 238 # - HIT_TYPE, 239 # - INTERNAL_SEARCH_TERM, 240 # - INTERNAL_SEARCH_TYPE, 241 # - SOURCE_PROPERTY_TRACKING_ID, 242 # - Campaign or AdGroup 243 # - CAMPAIGN_SOURCE, 244 # - CAMPAIGN_MEDIUM, 245 # - CAMPAIGN_NAME, 246 # - CAMPAIGN_AD_GROUP, 247 # - CAMPAIGN_TERM, 248 # - CAMPAIGN_CONTENT, 249 # - CAMPAIGN_CODE, 250 # - CAMPAIGN_REFERRAL_PATH, 251 # - E-Commerce 252 # - TRANSACTION_COUNTRY, 253 # - TRANSACTION_REGION, 254 # - TRANSACTION_CITY, 255 # - TRANSACTION_AFFILIATION (Store or order location), 256 # - ITEM_NAME, 257 # - ITEM_CODE, 258 # - ITEM_VARIATION, 259 # - TRANSACTION_ID, 260 # - TRANSACTION_CURRENCY_CODE, 261 # - PRODUCT_ACTION_TYPE, 262 # - Audience/Users 263 # - BROWSER, 264 # - BROWSER_VERSION, 265 # - BROWSER_SIZE, 266 # - PLATFORM, 267 # - PLATFORM_VERSION, 268 # - LANGUAGE, 269 # - SCREEN_RESOLUTION, 270 # - SCREEN_COLORS, 271 # - JAVA_ENABLED (Boolean Field), 272 # - FLASH_VERSION, 273 # - GEO_SPEED (Connection speed), 274 # - VISITOR_TYPE, 275 # - GEO_ORGANIZATION (ISP organization), 276 # - GEO_DOMAIN, 277 # - GEO_IP_ADDRESS, 278 # - GEO_IP_VERSION, 279 # - Location 280 # - GEO_COUNTRY, 281 # - GEO_REGION, 282 # - GEO_CITY, 283 # - Event 284 # - EVENT_CATEGORY, 285 # - EVENT_ACTION, 286 # - EVENT_LABEL, 287 # - Other 288 # - CUSTOM_FIELD_1, 289 # - CUSTOM_FIELD_2, 290 # - USER_DEFINED_VALUE, 291 # - Application 292 # - APP_ID, 293 # - APP_INSTALLER_ID, 294 # - APP_NAME, 295 # - APP_VERSION, 296 # - SCREEN, 297 # - IS_APP (Boolean Field), 298 # - IS_FATAL_EXCEPTION (Boolean Field), 299 # - EXCEPTION_DESCRIPTION, 300 # - Mobile device 301 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 302 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 303 # - DEVICE_CATEGORY, 304 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 305 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 306 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 307 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 308 # - MOBILE_BRAND_NAME, 309 # - MOBILE_MODEL_NAME, 310 # - MOBILE_MARKETING_NAME, 311 # - MOBILE_POINTING_METHOD, 312 # - Social 313 # - SOCIAL_NETWORK, 314 # - SOCIAL_ACTION, 315 # - SOCIAL_ACTION_TARGET, 316 # - Custom dimension 317 # - CUSTOM_DIMENSION (See accompanying field index), 318 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 319 "kind": "analytics#filterExpression", # Kind value for filter expression 320 "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. 321 }, 322 "kind": "analytics#filter", # Resource type for Analytics filter. 323 "lowercaseDetails": { # Details for the filter of the type LOWER. 324 "field": "A String", # Field to use in the filter. 325 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 326 }, 327 "name": "A String", # Name of this filter. 328 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 329 "href": "A String", # Link to the account to which this filter belongs. 330 "type": "analytics#account", # Value is "analytics#account". 331 }, 332 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 333 "caseSensitive": True or False, # Determines if the filter is case sensitive. 334 "field": "A String", # Field to use in the filter. 335 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 336 "replaceString": "A String", # Term to replace the search term with. 337 "searchString": "A String", # Term to search. 338 }, 339 "selfLink": "A String", # Link for this filter. 340 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 341 "updated": "A String", # Time this filter was last modified. 342 "uppercaseDetails": { # Details for the filter of the type UPPER. 343 "field": "A String", # Field to use in the filter. 344 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 345 }, 346}</pre> 347</div> 348 349<div class="method"> 350 <code class="details" id="get">get(accountId, filterId)</code> 351 <pre>Returns filters to which the user has access. 352 353Args: 354 accountId: string, Account ID to retrieve filters for. (required) 355 filterId: string, Filter ID to retrieve filters for. (required) 356 357Returns: 358 An object of the form: 359 360 { # JSON template for an Analytics account filter. 361 "accountId": "A String", # Account ID to which this filter belongs. 362 "advancedDetails": { # Details for the filter of the type ADVANCED. 363 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 364 "extractA": "A String", # Expression to extract from field A. 365 "extractB": "A String", # Expression to extract from field B. 366 "fieldA": "A String", # Field A. 367 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 368 "fieldARequired": True or False, # Indicates if field A is required to match. 369 "fieldB": "A String", # Field B. 370 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 371 "fieldBRequired": True or False, # Indicates if field B is required to match. 372 "outputConstructor": "A String", # Expression used to construct the output value. 373 "outputToField": "A String", # Output field. 374 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 375 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 376 }, 377 "created": "A String", # Time this filter was created. 378 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 379 "caseSensitive": True or False, # Determines if the filter is case sensitive. 380 "expressionValue": "A String", # Filter expression value 381 "field": "A String", # Field to filter. Possible values: 382 # - Content and Traffic 383 # - PAGE_REQUEST_URI, 384 # - PAGE_HOSTNAME, 385 # - PAGE_TITLE, 386 # - REFERRAL, 387 # - COST_DATA_URI (Campaign target URL), 388 # - HIT_TYPE, 389 # - INTERNAL_SEARCH_TERM, 390 # - INTERNAL_SEARCH_TYPE, 391 # - SOURCE_PROPERTY_TRACKING_ID, 392 # - Campaign or AdGroup 393 # - CAMPAIGN_SOURCE, 394 # - CAMPAIGN_MEDIUM, 395 # - CAMPAIGN_NAME, 396 # - CAMPAIGN_AD_GROUP, 397 # - CAMPAIGN_TERM, 398 # - CAMPAIGN_CONTENT, 399 # - CAMPAIGN_CODE, 400 # - CAMPAIGN_REFERRAL_PATH, 401 # - E-Commerce 402 # - TRANSACTION_COUNTRY, 403 # - TRANSACTION_REGION, 404 # - TRANSACTION_CITY, 405 # - TRANSACTION_AFFILIATION (Store or order location), 406 # - ITEM_NAME, 407 # - ITEM_CODE, 408 # - ITEM_VARIATION, 409 # - TRANSACTION_ID, 410 # - TRANSACTION_CURRENCY_CODE, 411 # - PRODUCT_ACTION_TYPE, 412 # - Audience/Users 413 # - BROWSER, 414 # - BROWSER_VERSION, 415 # - BROWSER_SIZE, 416 # - PLATFORM, 417 # - PLATFORM_VERSION, 418 # - LANGUAGE, 419 # - SCREEN_RESOLUTION, 420 # - SCREEN_COLORS, 421 # - JAVA_ENABLED (Boolean Field), 422 # - FLASH_VERSION, 423 # - GEO_SPEED (Connection speed), 424 # - VISITOR_TYPE, 425 # - GEO_ORGANIZATION (ISP organization), 426 # - GEO_DOMAIN, 427 # - GEO_IP_ADDRESS, 428 # - GEO_IP_VERSION, 429 # - Location 430 # - GEO_COUNTRY, 431 # - GEO_REGION, 432 # - GEO_CITY, 433 # - Event 434 # - EVENT_CATEGORY, 435 # - EVENT_ACTION, 436 # - EVENT_LABEL, 437 # - Other 438 # - CUSTOM_FIELD_1, 439 # - CUSTOM_FIELD_2, 440 # - USER_DEFINED_VALUE, 441 # - Application 442 # - APP_ID, 443 # - APP_INSTALLER_ID, 444 # - APP_NAME, 445 # - APP_VERSION, 446 # - SCREEN, 447 # - IS_APP (Boolean Field), 448 # - IS_FATAL_EXCEPTION (Boolean Field), 449 # - EXCEPTION_DESCRIPTION, 450 # - Mobile device 451 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 452 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 453 # - DEVICE_CATEGORY, 454 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 455 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 456 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 457 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 458 # - MOBILE_BRAND_NAME, 459 # - MOBILE_MODEL_NAME, 460 # - MOBILE_MARKETING_NAME, 461 # - MOBILE_POINTING_METHOD, 462 # - Social 463 # - SOCIAL_NETWORK, 464 # - SOCIAL_ACTION, 465 # - SOCIAL_ACTION_TARGET, 466 # - Custom dimension 467 # - CUSTOM_DIMENSION (See accompanying field index), 468 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 469 "kind": "analytics#filterExpression", # Kind value for filter expression 470 "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. 471 }, 472 "id": "A String", # Filter ID. 473 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 474 "caseSensitive": True or False, # Determines if the filter is case sensitive. 475 "expressionValue": "A String", # Filter expression value 476 "field": "A String", # Field to filter. Possible values: 477 # - Content and Traffic 478 # - PAGE_REQUEST_URI, 479 # - PAGE_HOSTNAME, 480 # - PAGE_TITLE, 481 # - REFERRAL, 482 # - COST_DATA_URI (Campaign target URL), 483 # - HIT_TYPE, 484 # - INTERNAL_SEARCH_TERM, 485 # - INTERNAL_SEARCH_TYPE, 486 # - SOURCE_PROPERTY_TRACKING_ID, 487 # - Campaign or AdGroup 488 # - CAMPAIGN_SOURCE, 489 # - CAMPAIGN_MEDIUM, 490 # - CAMPAIGN_NAME, 491 # - CAMPAIGN_AD_GROUP, 492 # - CAMPAIGN_TERM, 493 # - CAMPAIGN_CONTENT, 494 # - CAMPAIGN_CODE, 495 # - CAMPAIGN_REFERRAL_PATH, 496 # - E-Commerce 497 # - TRANSACTION_COUNTRY, 498 # - TRANSACTION_REGION, 499 # - TRANSACTION_CITY, 500 # - TRANSACTION_AFFILIATION (Store or order location), 501 # - ITEM_NAME, 502 # - ITEM_CODE, 503 # - ITEM_VARIATION, 504 # - TRANSACTION_ID, 505 # - TRANSACTION_CURRENCY_CODE, 506 # - PRODUCT_ACTION_TYPE, 507 # - Audience/Users 508 # - BROWSER, 509 # - BROWSER_VERSION, 510 # - BROWSER_SIZE, 511 # - PLATFORM, 512 # - PLATFORM_VERSION, 513 # - LANGUAGE, 514 # - SCREEN_RESOLUTION, 515 # - SCREEN_COLORS, 516 # - JAVA_ENABLED (Boolean Field), 517 # - FLASH_VERSION, 518 # - GEO_SPEED (Connection speed), 519 # - VISITOR_TYPE, 520 # - GEO_ORGANIZATION (ISP organization), 521 # - GEO_DOMAIN, 522 # - GEO_IP_ADDRESS, 523 # - GEO_IP_VERSION, 524 # - Location 525 # - GEO_COUNTRY, 526 # - GEO_REGION, 527 # - GEO_CITY, 528 # - Event 529 # - EVENT_CATEGORY, 530 # - EVENT_ACTION, 531 # - EVENT_LABEL, 532 # - Other 533 # - CUSTOM_FIELD_1, 534 # - CUSTOM_FIELD_2, 535 # - USER_DEFINED_VALUE, 536 # - Application 537 # - APP_ID, 538 # - APP_INSTALLER_ID, 539 # - APP_NAME, 540 # - APP_VERSION, 541 # - SCREEN, 542 # - IS_APP (Boolean Field), 543 # - IS_FATAL_EXCEPTION (Boolean Field), 544 # - EXCEPTION_DESCRIPTION, 545 # - Mobile device 546 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 547 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 548 # - DEVICE_CATEGORY, 549 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 550 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 551 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 552 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 553 # - MOBILE_BRAND_NAME, 554 # - MOBILE_MODEL_NAME, 555 # - MOBILE_MARKETING_NAME, 556 # - MOBILE_POINTING_METHOD, 557 # - Social 558 # - SOCIAL_NETWORK, 559 # - SOCIAL_ACTION, 560 # - SOCIAL_ACTION_TARGET, 561 # - Custom dimension 562 # - CUSTOM_DIMENSION (See accompanying field index), 563 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 564 "kind": "analytics#filterExpression", # Kind value for filter expression 565 "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. 566 }, 567 "kind": "analytics#filter", # Resource type for Analytics filter. 568 "lowercaseDetails": { # Details for the filter of the type LOWER. 569 "field": "A String", # Field to use in the filter. 570 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 571 }, 572 "name": "A String", # Name of this filter. 573 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 574 "href": "A String", # Link to the account to which this filter belongs. 575 "type": "analytics#account", # Value is "analytics#account". 576 }, 577 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 578 "caseSensitive": True or False, # Determines if the filter is case sensitive. 579 "field": "A String", # Field to use in the filter. 580 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 581 "replaceString": "A String", # Term to replace the search term with. 582 "searchString": "A String", # Term to search. 583 }, 584 "selfLink": "A String", # Link for this filter. 585 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 586 "updated": "A String", # Time this filter was last modified. 587 "uppercaseDetails": { # Details for the filter of the type UPPER. 588 "field": "A String", # Field to use in the filter. 589 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 590 }, 591}</pre> 592</div> 593 594<div class="method"> 595 <code class="details" id="insert">insert(accountId, body=None)</code> 596 <pre>Create a new filter. 597 598Args: 599 accountId: string, Account ID to create filter for. (required) 600 body: object, The request body. 601 The object takes the form of: 602 603{ # JSON template for an Analytics account filter. 604 "accountId": "A String", # Account ID to which this filter belongs. 605 "advancedDetails": { # Details for the filter of the type ADVANCED. 606 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 607 "extractA": "A String", # Expression to extract from field A. 608 "extractB": "A String", # Expression to extract from field B. 609 "fieldA": "A String", # Field A. 610 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 611 "fieldARequired": True or False, # Indicates if field A is required to match. 612 "fieldB": "A String", # Field B. 613 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 614 "fieldBRequired": True or False, # Indicates if field B is required to match. 615 "outputConstructor": "A String", # Expression used to construct the output value. 616 "outputToField": "A String", # Output field. 617 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 618 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 619 }, 620 "created": "A String", # Time this filter was created. 621 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 622 "caseSensitive": True or False, # Determines if the filter is case sensitive. 623 "expressionValue": "A String", # Filter expression value 624 "field": "A String", # Field to filter. Possible values: 625 # - Content and Traffic 626 # - PAGE_REQUEST_URI, 627 # - PAGE_HOSTNAME, 628 # - PAGE_TITLE, 629 # - REFERRAL, 630 # - COST_DATA_URI (Campaign target URL), 631 # - HIT_TYPE, 632 # - INTERNAL_SEARCH_TERM, 633 # - INTERNAL_SEARCH_TYPE, 634 # - SOURCE_PROPERTY_TRACKING_ID, 635 # - Campaign or AdGroup 636 # - CAMPAIGN_SOURCE, 637 # - CAMPAIGN_MEDIUM, 638 # - CAMPAIGN_NAME, 639 # - CAMPAIGN_AD_GROUP, 640 # - CAMPAIGN_TERM, 641 # - CAMPAIGN_CONTENT, 642 # - CAMPAIGN_CODE, 643 # - CAMPAIGN_REFERRAL_PATH, 644 # - E-Commerce 645 # - TRANSACTION_COUNTRY, 646 # - TRANSACTION_REGION, 647 # - TRANSACTION_CITY, 648 # - TRANSACTION_AFFILIATION (Store or order location), 649 # - ITEM_NAME, 650 # - ITEM_CODE, 651 # - ITEM_VARIATION, 652 # - TRANSACTION_ID, 653 # - TRANSACTION_CURRENCY_CODE, 654 # - PRODUCT_ACTION_TYPE, 655 # - Audience/Users 656 # - BROWSER, 657 # - BROWSER_VERSION, 658 # - BROWSER_SIZE, 659 # - PLATFORM, 660 # - PLATFORM_VERSION, 661 # - LANGUAGE, 662 # - SCREEN_RESOLUTION, 663 # - SCREEN_COLORS, 664 # - JAVA_ENABLED (Boolean Field), 665 # - FLASH_VERSION, 666 # - GEO_SPEED (Connection speed), 667 # - VISITOR_TYPE, 668 # - GEO_ORGANIZATION (ISP organization), 669 # - GEO_DOMAIN, 670 # - GEO_IP_ADDRESS, 671 # - GEO_IP_VERSION, 672 # - Location 673 # - GEO_COUNTRY, 674 # - GEO_REGION, 675 # - GEO_CITY, 676 # - Event 677 # - EVENT_CATEGORY, 678 # - EVENT_ACTION, 679 # - EVENT_LABEL, 680 # - Other 681 # - CUSTOM_FIELD_1, 682 # - CUSTOM_FIELD_2, 683 # - USER_DEFINED_VALUE, 684 # - Application 685 # - APP_ID, 686 # - APP_INSTALLER_ID, 687 # - APP_NAME, 688 # - APP_VERSION, 689 # - SCREEN, 690 # - IS_APP (Boolean Field), 691 # - IS_FATAL_EXCEPTION (Boolean Field), 692 # - EXCEPTION_DESCRIPTION, 693 # - Mobile device 694 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 695 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 696 # - DEVICE_CATEGORY, 697 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 698 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 699 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 700 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 701 # - MOBILE_BRAND_NAME, 702 # - MOBILE_MODEL_NAME, 703 # - MOBILE_MARKETING_NAME, 704 # - MOBILE_POINTING_METHOD, 705 # - Social 706 # - SOCIAL_NETWORK, 707 # - SOCIAL_ACTION, 708 # - SOCIAL_ACTION_TARGET, 709 # - Custom dimension 710 # - CUSTOM_DIMENSION (See accompanying field index), 711 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 712 "kind": "analytics#filterExpression", # Kind value for filter expression 713 "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. 714 }, 715 "id": "A String", # Filter ID. 716 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 717 "caseSensitive": True or False, # Determines if the filter is case sensitive. 718 "expressionValue": "A String", # Filter expression value 719 "field": "A String", # Field to filter. Possible values: 720 # - Content and Traffic 721 # - PAGE_REQUEST_URI, 722 # - PAGE_HOSTNAME, 723 # - PAGE_TITLE, 724 # - REFERRAL, 725 # - COST_DATA_URI (Campaign target URL), 726 # - HIT_TYPE, 727 # - INTERNAL_SEARCH_TERM, 728 # - INTERNAL_SEARCH_TYPE, 729 # - SOURCE_PROPERTY_TRACKING_ID, 730 # - Campaign or AdGroup 731 # - CAMPAIGN_SOURCE, 732 # - CAMPAIGN_MEDIUM, 733 # - CAMPAIGN_NAME, 734 # - CAMPAIGN_AD_GROUP, 735 # - CAMPAIGN_TERM, 736 # - CAMPAIGN_CONTENT, 737 # - CAMPAIGN_CODE, 738 # - CAMPAIGN_REFERRAL_PATH, 739 # - E-Commerce 740 # - TRANSACTION_COUNTRY, 741 # - TRANSACTION_REGION, 742 # - TRANSACTION_CITY, 743 # - TRANSACTION_AFFILIATION (Store or order location), 744 # - ITEM_NAME, 745 # - ITEM_CODE, 746 # - ITEM_VARIATION, 747 # - TRANSACTION_ID, 748 # - TRANSACTION_CURRENCY_CODE, 749 # - PRODUCT_ACTION_TYPE, 750 # - Audience/Users 751 # - BROWSER, 752 # - BROWSER_VERSION, 753 # - BROWSER_SIZE, 754 # - PLATFORM, 755 # - PLATFORM_VERSION, 756 # - LANGUAGE, 757 # - SCREEN_RESOLUTION, 758 # - SCREEN_COLORS, 759 # - JAVA_ENABLED (Boolean Field), 760 # - FLASH_VERSION, 761 # - GEO_SPEED (Connection speed), 762 # - VISITOR_TYPE, 763 # - GEO_ORGANIZATION (ISP organization), 764 # - GEO_DOMAIN, 765 # - GEO_IP_ADDRESS, 766 # - GEO_IP_VERSION, 767 # - Location 768 # - GEO_COUNTRY, 769 # - GEO_REGION, 770 # - GEO_CITY, 771 # - Event 772 # - EVENT_CATEGORY, 773 # - EVENT_ACTION, 774 # - EVENT_LABEL, 775 # - Other 776 # - CUSTOM_FIELD_1, 777 # - CUSTOM_FIELD_2, 778 # - USER_DEFINED_VALUE, 779 # - Application 780 # - APP_ID, 781 # - APP_INSTALLER_ID, 782 # - APP_NAME, 783 # - APP_VERSION, 784 # - SCREEN, 785 # - IS_APP (Boolean Field), 786 # - IS_FATAL_EXCEPTION (Boolean Field), 787 # - EXCEPTION_DESCRIPTION, 788 # - Mobile device 789 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 790 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 791 # - DEVICE_CATEGORY, 792 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 793 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 794 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 795 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 796 # - MOBILE_BRAND_NAME, 797 # - MOBILE_MODEL_NAME, 798 # - MOBILE_MARKETING_NAME, 799 # - MOBILE_POINTING_METHOD, 800 # - Social 801 # - SOCIAL_NETWORK, 802 # - SOCIAL_ACTION, 803 # - SOCIAL_ACTION_TARGET, 804 # - Custom dimension 805 # - CUSTOM_DIMENSION (See accompanying field index), 806 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 807 "kind": "analytics#filterExpression", # Kind value for filter expression 808 "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. 809 }, 810 "kind": "analytics#filter", # Resource type for Analytics filter. 811 "lowercaseDetails": { # Details for the filter of the type LOWER. 812 "field": "A String", # Field to use in the filter. 813 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 814 }, 815 "name": "A String", # Name of this filter. 816 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 817 "href": "A String", # Link to the account to which this filter belongs. 818 "type": "analytics#account", # Value is "analytics#account". 819 }, 820 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 821 "caseSensitive": True or False, # Determines if the filter is case sensitive. 822 "field": "A String", # Field to use in the filter. 823 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 824 "replaceString": "A String", # Term to replace the search term with. 825 "searchString": "A String", # Term to search. 826 }, 827 "selfLink": "A String", # Link for this filter. 828 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 829 "updated": "A String", # Time this filter was last modified. 830 "uppercaseDetails": { # Details for the filter of the type UPPER. 831 "field": "A String", # Field to use in the filter. 832 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 833 }, 834} 835 836 837Returns: 838 An object of the form: 839 840 { # JSON template for an Analytics account filter. 841 "accountId": "A String", # Account ID to which this filter belongs. 842 "advancedDetails": { # Details for the filter of the type ADVANCED. 843 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 844 "extractA": "A String", # Expression to extract from field A. 845 "extractB": "A String", # Expression to extract from field B. 846 "fieldA": "A String", # Field A. 847 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 848 "fieldARequired": True or False, # Indicates if field A is required to match. 849 "fieldB": "A String", # Field B. 850 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 851 "fieldBRequired": True or False, # Indicates if field B is required to match. 852 "outputConstructor": "A String", # Expression used to construct the output value. 853 "outputToField": "A String", # Output field. 854 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 855 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 856 }, 857 "created": "A String", # Time this filter was created. 858 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 859 "caseSensitive": True or False, # Determines if the filter is case sensitive. 860 "expressionValue": "A String", # Filter expression value 861 "field": "A String", # Field to filter. Possible values: 862 # - Content and Traffic 863 # - PAGE_REQUEST_URI, 864 # - PAGE_HOSTNAME, 865 # - PAGE_TITLE, 866 # - REFERRAL, 867 # - COST_DATA_URI (Campaign target URL), 868 # - HIT_TYPE, 869 # - INTERNAL_SEARCH_TERM, 870 # - INTERNAL_SEARCH_TYPE, 871 # - SOURCE_PROPERTY_TRACKING_ID, 872 # - Campaign or AdGroup 873 # - CAMPAIGN_SOURCE, 874 # - CAMPAIGN_MEDIUM, 875 # - CAMPAIGN_NAME, 876 # - CAMPAIGN_AD_GROUP, 877 # - CAMPAIGN_TERM, 878 # - CAMPAIGN_CONTENT, 879 # - CAMPAIGN_CODE, 880 # - CAMPAIGN_REFERRAL_PATH, 881 # - E-Commerce 882 # - TRANSACTION_COUNTRY, 883 # - TRANSACTION_REGION, 884 # - TRANSACTION_CITY, 885 # - TRANSACTION_AFFILIATION (Store or order location), 886 # - ITEM_NAME, 887 # - ITEM_CODE, 888 # - ITEM_VARIATION, 889 # - TRANSACTION_ID, 890 # - TRANSACTION_CURRENCY_CODE, 891 # - PRODUCT_ACTION_TYPE, 892 # - Audience/Users 893 # - BROWSER, 894 # - BROWSER_VERSION, 895 # - BROWSER_SIZE, 896 # - PLATFORM, 897 # - PLATFORM_VERSION, 898 # - LANGUAGE, 899 # - SCREEN_RESOLUTION, 900 # - SCREEN_COLORS, 901 # - JAVA_ENABLED (Boolean Field), 902 # - FLASH_VERSION, 903 # - GEO_SPEED (Connection speed), 904 # - VISITOR_TYPE, 905 # - GEO_ORGANIZATION (ISP organization), 906 # - GEO_DOMAIN, 907 # - GEO_IP_ADDRESS, 908 # - GEO_IP_VERSION, 909 # - Location 910 # - GEO_COUNTRY, 911 # - GEO_REGION, 912 # - GEO_CITY, 913 # - Event 914 # - EVENT_CATEGORY, 915 # - EVENT_ACTION, 916 # - EVENT_LABEL, 917 # - Other 918 # - CUSTOM_FIELD_1, 919 # - CUSTOM_FIELD_2, 920 # - USER_DEFINED_VALUE, 921 # - Application 922 # - APP_ID, 923 # - APP_INSTALLER_ID, 924 # - APP_NAME, 925 # - APP_VERSION, 926 # - SCREEN, 927 # - IS_APP (Boolean Field), 928 # - IS_FATAL_EXCEPTION (Boolean Field), 929 # - EXCEPTION_DESCRIPTION, 930 # - Mobile device 931 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 932 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 933 # - DEVICE_CATEGORY, 934 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 935 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 936 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 937 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 938 # - MOBILE_BRAND_NAME, 939 # - MOBILE_MODEL_NAME, 940 # - MOBILE_MARKETING_NAME, 941 # - MOBILE_POINTING_METHOD, 942 # - Social 943 # - SOCIAL_NETWORK, 944 # - SOCIAL_ACTION, 945 # - SOCIAL_ACTION_TARGET, 946 # - Custom dimension 947 # - CUSTOM_DIMENSION (See accompanying field index), 948 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 949 "kind": "analytics#filterExpression", # Kind value for filter expression 950 "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. 951 }, 952 "id": "A String", # Filter ID. 953 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 954 "caseSensitive": True or False, # Determines if the filter is case sensitive. 955 "expressionValue": "A String", # Filter expression value 956 "field": "A String", # Field to filter. Possible values: 957 # - Content and Traffic 958 # - PAGE_REQUEST_URI, 959 # - PAGE_HOSTNAME, 960 # - PAGE_TITLE, 961 # - REFERRAL, 962 # - COST_DATA_URI (Campaign target URL), 963 # - HIT_TYPE, 964 # - INTERNAL_SEARCH_TERM, 965 # - INTERNAL_SEARCH_TYPE, 966 # - SOURCE_PROPERTY_TRACKING_ID, 967 # - Campaign or AdGroup 968 # - CAMPAIGN_SOURCE, 969 # - CAMPAIGN_MEDIUM, 970 # - CAMPAIGN_NAME, 971 # - CAMPAIGN_AD_GROUP, 972 # - CAMPAIGN_TERM, 973 # - CAMPAIGN_CONTENT, 974 # - CAMPAIGN_CODE, 975 # - CAMPAIGN_REFERRAL_PATH, 976 # - E-Commerce 977 # - TRANSACTION_COUNTRY, 978 # - TRANSACTION_REGION, 979 # - TRANSACTION_CITY, 980 # - TRANSACTION_AFFILIATION (Store or order location), 981 # - ITEM_NAME, 982 # - ITEM_CODE, 983 # - ITEM_VARIATION, 984 # - TRANSACTION_ID, 985 # - TRANSACTION_CURRENCY_CODE, 986 # - PRODUCT_ACTION_TYPE, 987 # - Audience/Users 988 # - BROWSER, 989 # - BROWSER_VERSION, 990 # - BROWSER_SIZE, 991 # - PLATFORM, 992 # - PLATFORM_VERSION, 993 # - LANGUAGE, 994 # - SCREEN_RESOLUTION, 995 # - SCREEN_COLORS, 996 # - JAVA_ENABLED (Boolean Field), 997 # - FLASH_VERSION, 998 # - GEO_SPEED (Connection speed), 999 # - VISITOR_TYPE, 1000 # - GEO_ORGANIZATION (ISP organization), 1001 # - GEO_DOMAIN, 1002 # - GEO_IP_ADDRESS, 1003 # - GEO_IP_VERSION, 1004 # - Location 1005 # - GEO_COUNTRY, 1006 # - GEO_REGION, 1007 # - GEO_CITY, 1008 # - Event 1009 # - EVENT_CATEGORY, 1010 # - EVENT_ACTION, 1011 # - EVENT_LABEL, 1012 # - Other 1013 # - CUSTOM_FIELD_1, 1014 # - CUSTOM_FIELD_2, 1015 # - USER_DEFINED_VALUE, 1016 # - Application 1017 # - APP_ID, 1018 # - APP_INSTALLER_ID, 1019 # - APP_NAME, 1020 # - APP_VERSION, 1021 # - SCREEN, 1022 # - IS_APP (Boolean Field), 1023 # - IS_FATAL_EXCEPTION (Boolean Field), 1024 # - EXCEPTION_DESCRIPTION, 1025 # - Mobile device 1026 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1027 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1028 # - DEVICE_CATEGORY, 1029 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1030 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1031 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1032 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1033 # - MOBILE_BRAND_NAME, 1034 # - MOBILE_MODEL_NAME, 1035 # - MOBILE_MARKETING_NAME, 1036 # - MOBILE_POINTING_METHOD, 1037 # - Social 1038 # - SOCIAL_NETWORK, 1039 # - SOCIAL_ACTION, 1040 # - SOCIAL_ACTION_TARGET, 1041 # - Custom dimension 1042 # - CUSTOM_DIMENSION (See accompanying field index), 1043 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1044 "kind": "analytics#filterExpression", # Kind value for filter expression 1045 "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. 1046 }, 1047 "kind": "analytics#filter", # Resource type for Analytics filter. 1048 "lowercaseDetails": { # Details for the filter of the type LOWER. 1049 "field": "A String", # Field to use in the filter. 1050 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1051 }, 1052 "name": "A String", # Name of this filter. 1053 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 1054 "href": "A String", # Link to the account to which this filter belongs. 1055 "type": "analytics#account", # Value is "analytics#account". 1056 }, 1057 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 1058 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1059 "field": "A String", # Field to use in the filter. 1060 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1061 "replaceString": "A String", # Term to replace the search term with. 1062 "searchString": "A String", # Term to search. 1063 }, 1064 "selfLink": "A String", # Link for this filter. 1065 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 1066 "updated": "A String", # Time this filter was last modified. 1067 "uppercaseDetails": { # Details for the filter of the type UPPER. 1068 "field": "A String", # Field to use in the filter. 1069 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1070 }, 1071}</pre> 1072</div> 1073 1074<div class="method"> 1075 <code class="details" id="list">list(accountId, max_results=None, start_index=None)</code> 1076 <pre>Lists all filters for an account 1077 1078Args: 1079 accountId: string, Account ID to retrieve filters for. (required) 1080 max_results: integer, The maximum number of filters to include in this response. 1081 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 1082 1083Returns: 1084 An object of the form: 1085 1086 { # A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter. 1087 "items": [ # A list of filters. 1088 { # JSON template for an Analytics account filter. 1089 "accountId": "A String", # Account ID to which this filter belongs. 1090 "advancedDetails": { # Details for the filter of the type ADVANCED. 1091 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 1092 "extractA": "A String", # Expression to extract from field A. 1093 "extractB": "A String", # Expression to extract from field B. 1094 "fieldA": "A String", # Field A. 1095 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1096 "fieldARequired": True or False, # Indicates if field A is required to match. 1097 "fieldB": "A String", # Field B. 1098 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1099 "fieldBRequired": True or False, # Indicates if field B is required to match. 1100 "outputConstructor": "A String", # Expression used to construct the output value. 1101 "outputToField": "A String", # Output field. 1102 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1103 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 1104 }, 1105 "created": "A String", # Time this filter was created. 1106 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 1107 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1108 "expressionValue": "A String", # Filter expression value 1109 "field": "A String", # Field to filter. Possible values: 1110 # - Content and Traffic 1111 # - PAGE_REQUEST_URI, 1112 # - PAGE_HOSTNAME, 1113 # - PAGE_TITLE, 1114 # - REFERRAL, 1115 # - COST_DATA_URI (Campaign target URL), 1116 # - HIT_TYPE, 1117 # - INTERNAL_SEARCH_TERM, 1118 # - INTERNAL_SEARCH_TYPE, 1119 # - SOURCE_PROPERTY_TRACKING_ID, 1120 # - Campaign or AdGroup 1121 # - CAMPAIGN_SOURCE, 1122 # - CAMPAIGN_MEDIUM, 1123 # - CAMPAIGN_NAME, 1124 # - CAMPAIGN_AD_GROUP, 1125 # - CAMPAIGN_TERM, 1126 # - CAMPAIGN_CONTENT, 1127 # - CAMPAIGN_CODE, 1128 # - CAMPAIGN_REFERRAL_PATH, 1129 # - E-Commerce 1130 # - TRANSACTION_COUNTRY, 1131 # - TRANSACTION_REGION, 1132 # - TRANSACTION_CITY, 1133 # - TRANSACTION_AFFILIATION (Store or order location), 1134 # - ITEM_NAME, 1135 # - ITEM_CODE, 1136 # - ITEM_VARIATION, 1137 # - TRANSACTION_ID, 1138 # - TRANSACTION_CURRENCY_CODE, 1139 # - PRODUCT_ACTION_TYPE, 1140 # - Audience/Users 1141 # - BROWSER, 1142 # - BROWSER_VERSION, 1143 # - BROWSER_SIZE, 1144 # - PLATFORM, 1145 # - PLATFORM_VERSION, 1146 # - LANGUAGE, 1147 # - SCREEN_RESOLUTION, 1148 # - SCREEN_COLORS, 1149 # - JAVA_ENABLED (Boolean Field), 1150 # - FLASH_VERSION, 1151 # - GEO_SPEED (Connection speed), 1152 # - VISITOR_TYPE, 1153 # - GEO_ORGANIZATION (ISP organization), 1154 # - GEO_DOMAIN, 1155 # - GEO_IP_ADDRESS, 1156 # - GEO_IP_VERSION, 1157 # - Location 1158 # - GEO_COUNTRY, 1159 # - GEO_REGION, 1160 # - GEO_CITY, 1161 # - Event 1162 # - EVENT_CATEGORY, 1163 # - EVENT_ACTION, 1164 # - EVENT_LABEL, 1165 # - Other 1166 # - CUSTOM_FIELD_1, 1167 # - CUSTOM_FIELD_2, 1168 # - USER_DEFINED_VALUE, 1169 # - Application 1170 # - APP_ID, 1171 # - APP_INSTALLER_ID, 1172 # - APP_NAME, 1173 # - APP_VERSION, 1174 # - SCREEN, 1175 # - IS_APP (Boolean Field), 1176 # - IS_FATAL_EXCEPTION (Boolean Field), 1177 # - EXCEPTION_DESCRIPTION, 1178 # - Mobile device 1179 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1180 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1181 # - DEVICE_CATEGORY, 1182 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1183 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1184 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1185 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1186 # - MOBILE_BRAND_NAME, 1187 # - MOBILE_MODEL_NAME, 1188 # - MOBILE_MARKETING_NAME, 1189 # - MOBILE_POINTING_METHOD, 1190 # - Social 1191 # - SOCIAL_NETWORK, 1192 # - SOCIAL_ACTION, 1193 # - SOCIAL_ACTION_TARGET, 1194 # - Custom dimension 1195 # - CUSTOM_DIMENSION (See accompanying field index), 1196 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1197 "kind": "analytics#filterExpression", # Kind value for filter expression 1198 "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. 1199 }, 1200 "id": "A String", # Filter ID. 1201 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 1202 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1203 "expressionValue": "A String", # Filter expression value 1204 "field": "A String", # Field to filter. Possible values: 1205 # - Content and Traffic 1206 # - PAGE_REQUEST_URI, 1207 # - PAGE_HOSTNAME, 1208 # - PAGE_TITLE, 1209 # - REFERRAL, 1210 # - COST_DATA_URI (Campaign target URL), 1211 # - HIT_TYPE, 1212 # - INTERNAL_SEARCH_TERM, 1213 # - INTERNAL_SEARCH_TYPE, 1214 # - SOURCE_PROPERTY_TRACKING_ID, 1215 # - Campaign or AdGroup 1216 # - CAMPAIGN_SOURCE, 1217 # - CAMPAIGN_MEDIUM, 1218 # - CAMPAIGN_NAME, 1219 # - CAMPAIGN_AD_GROUP, 1220 # - CAMPAIGN_TERM, 1221 # - CAMPAIGN_CONTENT, 1222 # - CAMPAIGN_CODE, 1223 # - CAMPAIGN_REFERRAL_PATH, 1224 # - E-Commerce 1225 # - TRANSACTION_COUNTRY, 1226 # - TRANSACTION_REGION, 1227 # - TRANSACTION_CITY, 1228 # - TRANSACTION_AFFILIATION (Store or order location), 1229 # - ITEM_NAME, 1230 # - ITEM_CODE, 1231 # - ITEM_VARIATION, 1232 # - TRANSACTION_ID, 1233 # - TRANSACTION_CURRENCY_CODE, 1234 # - PRODUCT_ACTION_TYPE, 1235 # - Audience/Users 1236 # - BROWSER, 1237 # - BROWSER_VERSION, 1238 # - BROWSER_SIZE, 1239 # - PLATFORM, 1240 # - PLATFORM_VERSION, 1241 # - LANGUAGE, 1242 # - SCREEN_RESOLUTION, 1243 # - SCREEN_COLORS, 1244 # - JAVA_ENABLED (Boolean Field), 1245 # - FLASH_VERSION, 1246 # - GEO_SPEED (Connection speed), 1247 # - VISITOR_TYPE, 1248 # - GEO_ORGANIZATION (ISP organization), 1249 # - GEO_DOMAIN, 1250 # - GEO_IP_ADDRESS, 1251 # - GEO_IP_VERSION, 1252 # - Location 1253 # - GEO_COUNTRY, 1254 # - GEO_REGION, 1255 # - GEO_CITY, 1256 # - Event 1257 # - EVENT_CATEGORY, 1258 # - EVENT_ACTION, 1259 # - EVENT_LABEL, 1260 # - Other 1261 # - CUSTOM_FIELD_1, 1262 # - CUSTOM_FIELD_2, 1263 # - USER_DEFINED_VALUE, 1264 # - Application 1265 # - APP_ID, 1266 # - APP_INSTALLER_ID, 1267 # - APP_NAME, 1268 # - APP_VERSION, 1269 # - SCREEN, 1270 # - IS_APP (Boolean Field), 1271 # - IS_FATAL_EXCEPTION (Boolean Field), 1272 # - EXCEPTION_DESCRIPTION, 1273 # - Mobile device 1274 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1275 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1276 # - DEVICE_CATEGORY, 1277 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1278 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1279 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1280 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1281 # - MOBILE_BRAND_NAME, 1282 # - MOBILE_MODEL_NAME, 1283 # - MOBILE_MARKETING_NAME, 1284 # - MOBILE_POINTING_METHOD, 1285 # - Social 1286 # - SOCIAL_NETWORK, 1287 # - SOCIAL_ACTION, 1288 # - SOCIAL_ACTION_TARGET, 1289 # - Custom dimension 1290 # - CUSTOM_DIMENSION (See accompanying field index), 1291 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1292 "kind": "analytics#filterExpression", # Kind value for filter expression 1293 "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. 1294 }, 1295 "kind": "analytics#filter", # Resource type for Analytics filter. 1296 "lowercaseDetails": { # Details for the filter of the type LOWER. 1297 "field": "A String", # Field to use in the filter. 1298 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1299 }, 1300 "name": "A String", # Name of this filter. 1301 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 1302 "href": "A String", # Link to the account to which this filter belongs. 1303 "type": "analytics#account", # Value is "analytics#account". 1304 }, 1305 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 1306 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1307 "field": "A String", # Field to use in the filter. 1308 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1309 "replaceString": "A String", # Term to replace the search term with. 1310 "searchString": "A String", # Term to search. 1311 }, 1312 "selfLink": "A String", # Link for this filter. 1313 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 1314 "updated": "A String", # Time this filter was last modified. 1315 "uppercaseDetails": { # Details for the filter of the type UPPER. 1316 "field": "A String", # Field to use in the filter. 1317 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1318 }, 1319 }, 1320 ], 1321 "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. 1322 "kind": "analytics#filters", # Collection type. 1323 "nextLink": "A String", # Link to next page for this filter collection. 1324 "previousLink": "A String", # Link to previous page for this filter collection. 1325 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. 1326 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. 1327 "username": "A String", # Email ID of the authenticated user 1328}</pre> 1329</div> 1330 1331<div class="method"> 1332 <code class="details" id="patch">patch(accountId, filterId, body=None)</code> 1333 <pre>Updates an existing filter. This method supports patch semantics. 1334 1335Args: 1336 accountId: string, Account ID to which the filter belongs. (required) 1337 filterId: string, ID of the filter to be updated. (required) 1338 body: object, The request body. 1339 The object takes the form of: 1340 1341{ # JSON template for an Analytics account filter. 1342 "accountId": "A String", # Account ID to which this filter belongs. 1343 "advancedDetails": { # Details for the filter of the type ADVANCED. 1344 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 1345 "extractA": "A String", # Expression to extract from field A. 1346 "extractB": "A String", # Expression to extract from field B. 1347 "fieldA": "A String", # Field A. 1348 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1349 "fieldARequired": True or False, # Indicates if field A is required to match. 1350 "fieldB": "A String", # Field B. 1351 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1352 "fieldBRequired": True or False, # Indicates if field B is required to match. 1353 "outputConstructor": "A String", # Expression used to construct the output value. 1354 "outputToField": "A String", # Output field. 1355 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1356 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 1357 }, 1358 "created": "A String", # Time this filter was created. 1359 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 1360 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1361 "expressionValue": "A String", # Filter expression value 1362 "field": "A String", # Field to filter. Possible values: 1363 # - Content and Traffic 1364 # - PAGE_REQUEST_URI, 1365 # - PAGE_HOSTNAME, 1366 # - PAGE_TITLE, 1367 # - REFERRAL, 1368 # - COST_DATA_URI (Campaign target URL), 1369 # - HIT_TYPE, 1370 # - INTERNAL_SEARCH_TERM, 1371 # - INTERNAL_SEARCH_TYPE, 1372 # - SOURCE_PROPERTY_TRACKING_ID, 1373 # - Campaign or AdGroup 1374 # - CAMPAIGN_SOURCE, 1375 # - CAMPAIGN_MEDIUM, 1376 # - CAMPAIGN_NAME, 1377 # - CAMPAIGN_AD_GROUP, 1378 # - CAMPAIGN_TERM, 1379 # - CAMPAIGN_CONTENT, 1380 # - CAMPAIGN_CODE, 1381 # - CAMPAIGN_REFERRAL_PATH, 1382 # - E-Commerce 1383 # - TRANSACTION_COUNTRY, 1384 # - TRANSACTION_REGION, 1385 # - TRANSACTION_CITY, 1386 # - TRANSACTION_AFFILIATION (Store or order location), 1387 # - ITEM_NAME, 1388 # - ITEM_CODE, 1389 # - ITEM_VARIATION, 1390 # - TRANSACTION_ID, 1391 # - TRANSACTION_CURRENCY_CODE, 1392 # - PRODUCT_ACTION_TYPE, 1393 # - Audience/Users 1394 # - BROWSER, 1395 # - BROWSER_VERSION, 1396 # - BROWSER_SIZE, 1397 # - PLATFORM, 1398 # - PLATFORM_VERSION, 1399 # - LANGUAGE, 1400 # - SCREEN_RESOLUTION, 1401 # - SCREEN_COLORS, 1402 # - JAVA_ENABLED (Boolean Field), 1403 # - FLASH_VERSION, 1404 # - GEO_SPEED (Connection speed), 1405 # - VISITOR_TYPE, 1406 # - GEO_ORGANIZATION (ISP organization), 1407 # - GEO_DOMAIN, 1408 # - GEO_IP_ADDRESS, 1409 # - GEO_IP_VERSION, 1410 # - Location 1411 # - GEO_COUNTRY, 1412 # - GEO_REGION, 1413 # - GEO_CITY, 1414 # - Event 1415 # - EVENT_CATEGORY, 1416 # - EVENT_ACTION, 1417 # - EVENT_LABEL, 1418 # - Other 1419 # - CUSTOM_FIELD_1, 1420 # - CUSTOM_FIELD_2, 1421 # - USER_DEFINED_VALUE, 1422 # - Application 1423 # - APP_ID, 1424 # - APP_INSTALLER_ID, 1425 # - APP_NAME, 1426 # - APP_VERSION, 1427 # - SCREEN, 1428 # - IS_APP (Boolean Field), 1429 # - IS_FATAL_EXCEPTION (Boolean Field), 1430 # - EXCEPTION_DESCRIPTION, 1431 # - Mobile device 1432 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1433 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1434 # - DEVICE_CATEGORY, 1435 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1436 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1437 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1438 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1439 # - MOBILE_BRAND_NAME, 1440 # - MOBILE_MODEL_NAME, 1441 # - MOBILE_MARKETING_NAME, 1442 # - MOBILE_POINTING_METHOD, 1443 # - Social 1444 # - SOCIAL_NETWORK, 1445 # - SOCIAL_ACTION, 1446 # - SOCIAL_ACTION_TARGET, 1447 # - Custom dimension 1448 # - CUSTOM_DIMENSION (See accompanying field index), 1449 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1450 "kind": "analytics#filterExpression", # Kind value for filter expression 1451 "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. 1452 }, 1453 "id": "A String", # Filter ID. 1454 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 1455 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1456 "expressionValue": "A String", # Filter expression value 1457 "field": "A String", # Field to filter. Possible values: 1458 # - Content and Traffic 1459 # - PAGE_REQUEST_URI, 1460 # - PAGE_HOSTNAME, 1461 # - PAGE_TITLE, 1462 # - REFERRAL, 1463 # - COST_DATA_URI (Campaign target URL), 1464 # - HIT_TYPE, 1465 # - INTERNAL_SEARCH_TERM, 1466 # - INTERNAL_SEARCH_TYPE, 1467 # - SOURCE_PROPERTY_TRACKING_ID, 1468 # - Campaign or AdGroup 1469 # - CAMPAIGN_SOURCE, 1470 # - CAMPAIGN_MEDIUM, 1471 # - CAMPAIGN_NAME, 1472 # - CAMPAIGN_AD_GROUP, 1473 # - CAMPAIGN_TERM, 1474 # - CAMPAIGN_CONTENT, 1475 # - CAMPAIGN_CODE, 1476 # - CAMPAIGN_REFERRAL_PATH, 1477 # - E-Commerce 1478 # - TRANSACTION_COUNTRY, 1479 # - TRANSACTION_REGION, 1480 # - TRANSACTION_CITY, 1481 # - TRANSACTION_AFFILIATION (Store or order location), 1482 # - ITEM_NAME, 1483 # - ITEM_CODE, 1484 # - ITEM_VARIATION, 1485 # - TRANSACTION_ID, 1486 # - TRANSACTION_CURRENCY_CODE, 1487 # - PRODUCT_ACTION_TYPE, 1488 # - Audience/Users 1489 # - BROWSER, 1490 # - BROWSER_VERSION, 1491 # - BROWSER_SIZE, 1492 # - PLATFORM, 1493 # - PLATFORM_VERSION, 1494 # - LANGUAGE, 1495 # - SCREEN_RESOLUTION, 1496 # - SCREEN_COLORS, 1497 # - JAVA_ENABLED (Boolean Field), 1498 # - FLASH_VERSION, 1499 # - GEO_SPEED (Connection speed), 1500 # - VISITOR_TYPE, 1501 # - GEO_ORGANIZATION (ISP organization), 1502 # - GEO_DOMAIN, 1503 # - GEO_IP_ADDRESS, 1504 # - GEO_IP_VERSION, 1505 # - Location 1506 # - GEO_COUNTRY, 1507 # - GEO_REGION, 1508 # - GEO_CITY, 1509 # - Event 1510 # - EVENT_CATEGORY, 1511 # - EVENT_ACTION, 1512 # - EVENT_LABEL, 1513 # - Other 1514 # - CUSTOM_FIELD_1, 1515 # - CUSTOM_FIELD_2, 1516 # - USER_DEFINED_VALUE, 1517 # - Application 1518 # - APP_ID, 1519 # - APP_INSTALLER_ID, 1520 # - APP_NAME, 1521 # - APP_VERSION, 1522 # - SCREEN, 1523 # - IS_APP (Boolean Field), 1524 # - IS_FATAL_EXCEPTION (Boolean Field), 1525 # - EXCEPTION_DESCRIPTION, 1526 # - Mobile device 1527 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1528 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1529 # - DEVICE_CATEGORY, 1530 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1531 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1532 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1533 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1534 # - MOBILE_BRAND_NAME, 1535 # - MOBILE_MODEL_NAME, 1536 # - MOBILE_MARKETING_NAME, 1537 # - MOBILE_POINTING_METHOD, 1538 # - Social 1539 # - SOCIAL_NETWORK, 1540 # - SOCIAL_ACTION, 1541 # - SOCIAL_ACTION_TARGET, 1542 # - Custom dimension 1543 # - CUSTOM_DIMENSION (See accompanying field index), 1544 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1545 "kind": "analytics#filterExpression", # Kind value for filter expression 1546 "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. 1547 }, 1548 "kind": "analytics#filter", # Resource type for Analytics filter. 1549 "lowercaseDetails": { # Details for the filter of the type LOWER. 1550 "field": "A String", # Field to use in the filter. 1551 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1552 }, 1553 "name": "A String", # Name of this filter. 1554 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 1555 "href": "A String", # Link to the account to which this filter belongs. 1556 "type": "analytics#account", # Value is "analytics#account". 1557 }, 1558 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 1559 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1560 "field": "A String", # Field to use in the filter. 1561 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1562 "replaceString": "A String", # Term to replace the search term with. 1563 "searchString": "A String", # Term to search. 1564 }, 1565 "selfLink": "A String", # Link for this filter. 1566 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 1567 "updated": "A String", # Time this filter was last modified. 1568 "uppercaseDetails": { # Details for the filter of the type UPPER. 1569 "field": "A String", # Field to use in the filter. 1570 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1571 }, 1572} 1573 1574 1575Returns: 1576 An object of the form: 1577 1578 { # JSON template for an Analytics account filter. 1579 "accountId": "A String", # Account ID to which this filter belongs. 1580 "advancedDetails": { # Details for the filter of the type ADVANCED. 1581 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 1582 "extractA": "A String", # Expression to extract from field A. 1583 "extractB": "A String", # Expression to extract from field B. 1584 "fieldA": "A String", # Field A. 1585 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1586 "fieldARequired": True or False, # Indicates if field A is required to match. 1587 "fieldB": "A String", # Field B. 1588 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1589 "fieldBRequired": True or False, # Indicates if field B is required to match. 1590 "outputConstructor": "A String", # Expression used to construct the output value. 1591 "outputToField": "A String", # Output field. 1592 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1593 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 1594 }, 1595 "created": "A String", # Time this filter was created. 1596 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 1597 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1598 "expressionValue": "A String", # Filter expression value 1599 "field": "A String", # Field to filter. Possible values: 1600 # - Content and Traffic 1601 # - PAGE_REQUEST_URI, 1602 # - PAGE_HOSTNAME, 1603 # - PAGE_TITLE, 1604 # - REFERRAL, 1605 # - COST_DATA_URI (Campaign target URL), 1606 # - HIT_TYPE, 1607 # - INTERNAL_SEARCH_TERM, 1608 # - INTERNAL_SEARCH_TYPE, 1609 # - SOURCE_PROPERTY_TRACKING_ID, 1610 # - Campaign or AdGroup 1611 # - CAMPAIGN_SOURCE, 1612 # - CAMPAIGN_MEDIUM, 1613 # - CAMPAIGN_NAME, 1614 # - CAMPAIGN_AD_GROUP, 1615 # - CAMPAIGN_TERM, 1616 # - CAMPAIGN_CONTENT, 1617 # - CAMPAIGN_CODE, 1618 # - CAMPAIGN_REFERRAL_PATH, 1619 # - E-Commerce 1620 # - TRANSACTION_COUNTRY, 1621 # - TRANSACTION_REGION, 1622 # - TRANSACTION_CITY, 1623 # - TRANSACTION_AFFILIATION (Store or order location), 1624 # - ITEM_NAME, 1625 # - ITEM_CODE, 1626 # - ITEM_VARIATION, 1627 # - TRANSACTION_ID, 1628 # - TRANSACTION_CURRENCY_CODE, 1629 # - PRODUCT_ACTION_TYPE, 1630 # - Audience/Users 1631 # - BROWSER, 1632 # - BROWSER_VERSION, 1633 # - BROWSER_SIZE, 1634 # - PLATFORM, 1635 # - PLATFORM_VERSION, 1636 # - LANGUAGE, 1637 # - SCREEN_RESOLUTION, 1638 # - SCREEN_COLORS, 1639 # - JAVA_ENABLED (Boolean Field), 1640 # - FLASH_VERSION, 1641 # - GEO_SPEED (Connection speed), 1642 # - VISITOR_TYPE, 1643 # - GEO_ORGANIZATION (ISP organization), 1644 # - GEO_DOMAIN, 1645 # - GEO_IP_ADDRESS, 1646 # - GEO_IP_VERSION, 1647 # - Location 1648 # - GEO_COUNTRY, 1649 # - GEO_REGION, 1650 # - GEO_CITY, 1651 # - Event 1652 # - EVENT_CATEGORY, 1653 # - EVENT_ACTION, 1654 # - EVENT_LABEL, 1655 # - Other 1656 # - CUSTOM_FIELD_1, 1657 # - CUSTOM_FIELD_2, 1658 # - USER_DEFINED_VALUE, 1659 # - Application 1660 # - APP_ID, 1661 # - APP_INSTALLER_ID, 1662 # - APP_NAME, 1663 # - APP_VERSION, 1664 # - SCREEN, 1665 # - IS_APP (Boolean Field), 1666 # - IS_FATAL_EXCEPTION (Boolean Field), 1667 # - EXCEPTION_DESCRIPTION, 1668 # - Mobile device 1669 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1670 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1671 # - DEVICE_CATEGORY, 1672 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1673 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1674 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1675 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1676 # - MOBILE_BRAND_NAME, 1677 # - MOBILE_MODEL_NAME, 1678 # - MOBILE_MARKETING_NAME, 1679 # - MOBILE_POINTING_METHOD, 1680 # - Social 1681 # - SOCIAL_NETWORK, 1682 # - SOCIAL_ACTION, 1683 # - SOCIAL_ACTION_TARGET, 1684 # - Custom dimension 1685 # - CUSTOM_DIMENSION (See accompanying field index), 1686 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1687 "kind": "analytics#filterExpression", # Kind value for filter expression 1688 "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. 1689 }, 1690 "id": "A String", # Filter ID. 1691 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 1692 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1693 "expressionValue": "A String", # Filter expression value 1694 "field": "A String", # Field to filter. Possible values: 1695 # - Content and Traffic 1696 # - PAGE_REQUEST_URI, 1697 # - PAGE_HOSTNAME, 1698 # - PAGE_TITLE, 1699 # - REFERRAL, 1700 # - COST_DATA_URI (Campaign target URL), 1701 # - HIT_TYPE, 1702 # - INTERNAL_SEARCH_TERM, 1703 # - INTERNAL_SEARCH_TYPE, 1704 # - SOURCE_PROPERTY_TRACKING_ID, 1705 # - Campaign or AdGroup 1706 # - CAMPAIGN_SOURCE, 1707 # - CAMPAIGN_MEDIUM, 1708 # - CAMPAIGN_NAME, 1709 # - CAMPAIGN_AD_GROUP, 1710 # - CAMPAIGN_TERM, 1711 # - CAMPAIGN_CONTENT, 1712 # - CAMPAIGN_CODE, 1713 # - CAMPAIGN_REFERRAL_PATH, 1714 # - E-Commerce 1715 # - TRANSACTION_COUNTRY, 1716 # - TRANSACTION_REGION, 1717 # - TRANSACTION_CITY, 1718 # - TRANSACTION_AFFILIATION (Store or order location), 1719 # - ITEM_NAME, 1720 # - ITEM_CODE, 1721 # - ITEM_VARIATION, 1722 # - TRANSACTION_ID, 1723 # - TRANSACTION_CURRENCY_CODE, 1724 # - PRODUCT_ACTION_TYPE, 1725 # - Audience/Users 1726 # - BROWSER, 1727 # - BROWSER_VERSION, 1728 # - BROWSER_SIZE, 1729 # - PLATFORM, 1730 # - PLATFORM_VERSION, 1731 # - LANGUAGE, 1732 # - SCREEN_RESOLUTION, 1733 # - SCREEN_COLORS, 1734 # - JAVA_ENABLED (Boolean Field), 1735 # - FLASH_VERSION, 1736 # - GEO_SPEED (Connection speed), 1737 # - VISITOR_TYPE, 1738 # - GEO_ORGANIZATION (ISP organization), 1739 # - GEO_DOMAIN, 1740 # - GEO_IP_ADDRESS, 1741 # - GEO_IP_VERSION, 1742 # - Location 1743 # - GEO_COUNTRY, 1744 # - GEO_REGION, 1745 # - GEO_CITY, 1746 # - Event 1747 # - EVENT_CATEGORY, 1748 # - EVENT_ACTION, 1749 # - EVENT_LABEL, 1750 # - Other 1751 # - CUSTOM_FIELD_1, 1752 # - CUSTOM_FIELD_2, 1753 # - USER_DEFINED_VALUE, 1754 # - Application 1755 # - APP_ID, 1756 # - APP_INSTALLER_ID, 1757 # - APP_NAME, 1758 # - APP_VERSION, 1759 # - SCREEN, 1760 # - IS_APP (Boolean Field), 1761 # - IS_FATAL_EXCEPTION (Boolean Field), 1762 # - EXCEPTION_DESCRIPTION, 1763 # - Mobile device 1764 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1765 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1766 # - DEVICE_CATEGORY, 1767 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1768 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1769 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1770 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1771 # - MOBILE_BRAND_NAME, 1772 # - MOBILE_MODEL_NAME, 1773 # - MOBILE_MARKETING_NAME, 1774 # - MOBILE_POINTING_METHOD, 1775 # - Social 1776 # - SOCIAL_NETWORK, 1777 # - SOCIAL_ACTION, 1778 # - SOCIAL_ACTION_TARGET, 1779 # - Custom dimension 1780 # - CUSTOM_DIMENSION (See accompanying field index), 1781 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1782 "kind": "analytics#filterExpression", # Kind value for filter expression 1783 "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. 1784 }, 1785 "kind": "analytics#filter", # Resource type for Analytics filter. 1786 "lowercaseDetails": { # Details for the filter of the type LOWER. 1787 "field": "A String", # Field to use in the filter. 1788 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1789 }, 1790 "name": "A String", # Name of this filter. 1791 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 1792 "href": "A String", # Link to the account to which this filter belongs. 1793 "type": "analytics#account", # Value is "analytics#account". 1794 }, 1795 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 1796 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1797 "field": "A String", # Field to use in the filter. 1798 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1799 "replaceString": "A String", # Term to replace the search term with. 1800 "searchString": "A String", # Term to search. 1801 }, 1802 "selfLink": "A String", # Link for this filter. 1803 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 1804 "updated": "A String", # Time this filter was last modified. 1805 "uppercaseDetails": { # Details for the filter of the type UPPER. 1806 "field": "A String", # Field to use in the filter. 1807 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1808 }, 1809}</pre> 1810</div> 1811 1812<div class="method"> 1813 <code class="details" id="update">update(accountId, filterId, body=None)</code> 1814 <pre>Updates an existing filter. 1815 1816Args: 1817 accountId: string, Account ID to which the filter belongs. (required) 1818 filterId: string, ID of the filter to be updated. (required) 1819 body: object, The request body. 1820 The object takes the form of: 1821 1822{ # JSON template for an Analytics account filter. 1823 "accountId": "A String", # Account ID to which this filter belongs. 1824 "advancedDetails": { # Details for the filter of the type ADVANCED. 1825 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 1826 "extractA": "A String", # Expression to extract from field A. 1827 "extractB": "A String", # Expression to extract from field B. 1828 "fieldA": "A String", # Field A. 1829 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1830 "fieldARequired": True or False, # Indicates if field A is required to match. 1831 "fieldB": "A String", # Field B. 1832 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1833 "fieldBRequired": True or False, # Indicates if field B is required to match. 1834 "outputConstructor": "A String", # Expression used to construct the output value. 1835 "outputToField": "A String", # Output field. 1836 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 1837 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 1838 }, 1839 "created": "A String", # Time this filter was created. 1840 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 1841 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1842 "expressionValue": "A String", # Filter expression value 1843 "field": "A String", # Field to filter. Possible values: 1844 # - Content and Traffic 1845 # - PAGE_REQUEST_URI, 1846 # - PAGE_HOSTNAME, 1847 # - PAGE_TITLE, 1848 # - REFERRAL, 1849 # - COST_DATA_URI (Campaign target URL), 1850 # - HIT_TYPE, 1851 # - INTERNAL_SEARCH_TERM, 1852 # - INTERNAL_SEARCH_TYPE, 1853 # - SOURCE_PROPERTY_TRACKING_ID, 1854 # - Campaign or AdGroup 1855 # - CAMPAIGN_SOURCE, 1856 # - CAMPAIGN_MEDIUM, 1857 # - CAMPAIGN_NAME, 1858 # - CAMPAIGN_AD_GROUP, 1859 # - CAMPAIGN_TERM, 1860 # - CAMPAIGN_CONTENT, 1861 # - CAMPAIGN_CODE, 1862 # - CAMPAIGN_REFERRAL_PATH, 1863 # - E-Commerce 1864 # - TRANSACTION_COUNTRY, 1865 # - TRANSACTION_REGION, 1866 # - TRANSACTION_CITY, 1867 # - TRANSACTION_AFFILIATION (Store or order location), 1868 # - ITEM_NAME, 1869 # - ITEM_CODE, 1870 # - ITEM_VARIATION, 1871 # - TRANSACTION_ID, 1872 # - TRANSACTION_CURRENCY_CODE, 1873 # - PRODUCT_ACTION_TYPE, 1874 # - Audience/Users 1875 # - BROWSER, 1876 # - BROWSER_VERSION, 1877 # - BROWSER_SIZE, 1878 # - PLATFORM, 1879 # - PLATFORM_VERSION, 1880 # - LANGUAGE, 1881 # - SCREEN_RESOLUTION, 1882 # - SCREEN_COLORS, 1883 # - JAVA_ENABLED (Boolean Field), 1884 # - FLASH_VERSION, 1885 # - GEO_SPEED (Connection speed), 1886 # - VISITOR_TYPE, 1887 # - GEO_ORGANIZATION (ISP organization), 1888 # - GEO_DOMAIN, 1889 # - GEO_IP_ADDRESS, 1890 # - GEO_IP_VERSION, 1891 # - Location 1892 # - GEO_COUNTRY, 1893 # - GEO_REGION, 1894 # - GEO_CITY, 1895 # - Event 1896 # - EVENT_CATEGORY, 1897 # - EVENT_ACTION, 1898 # - EVENT_LABEL, 1899 # - Other 1900 # - CUSTOM_FIELD_1, 1901 # - CUSTOM_FIELD_2, 1902 # - USER_DEFINED_VALUE, 1903 # - Application 1904 # - APP_ID, 1905 # - APP_INSTALLER_ID, 1906 # - APP_NAME, 1907 # - APP_VERSION, 1908 # - SCREEN, 1909 # - IS_APP (Boolean Field), 1910 # - IS_FATAL_EXCEPTION (Boolean Field), 1911 # - EXCEPTION_DESCRIPTION, 1912 # - Mobile device 1913 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 1914 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 1915 # - DEVICE_CATEGORY, 1916 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 1917 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 1918 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 1919 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 1920 # - MOBILE_BRAND_NAME, 1921 # - MOBILE_MODEL_NAME, 1922 # - MOBILE_MARKETING_NAME, 1923 # - MOBILE_POINTING_METHOD, 1924 # - Social 1925 # - SOCIAL_NETWORK, 1926 # - SOCIAL_ACTION, 1927 # - SOCIAL_ACTION_TARGET, 1928 # - Custom dimension 1929 # - CUSTOM_DIMENSION (See accompanying field index), 1930 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 1931 "kind": "analytics#filterExpression", # Kind value for filter expression 1932 "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. 1933 }, 1934 "id": "A String", # Filter ID. 1935 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 1936 "caseSensitive": True or False, # Determines if the filter is case sensitive. 1937 "expressionValue": "A String", # Filter expression value 1938 "field": "A String", # Field to filter. Possible values: 1939 # - Content and Traffic 1940 # - PAGE_REQUEST_URI, 1941 # - PAGE_HOSTNAME, 1942 # - PAGE_TITLE, 1943 # - REFERRAL, 1944 # - COST_DATA_URI (Campaign target URL), 1945 # - HIT_TYPE, 1946 # - INTERNAL_SEARCH_TERM, 1947 # - INTERNAL_SEARCH_TYPE, 1948 # - SOURCE_PROPERTY_TRACKING_ID, 1949 # - Campaign or AdGroup 1950 # - CAMPAIGN_SOURCE, 1951 # - CAMPAIGN_MEDIUM, 1952 # - CAMPAIGN_NAME, 1953 # - CAMPAIGN_AD_GROUP, 1954 # - CAMPAIGN_TERM, 1955 # - CAMPAIGN_CONTENT, 1956 # - CAMPAIGN_CODE, 1957 # - CAMPAIGN_REFERRAL_PATH, 1958 # - E-Commerce 1959 # - TRANSACTION_COUNTRY, 1960 # - TRANSACTION_REGION, 1961 # - TRANSACTION_CITY, 1962 # - TRANSACTION_AFFILIATION (Store or order location), 1963 # - ITEM_NAME, 1964 # - ITEM_CODE, 1965 # - ITEM_VARIATION, 1966 # - TRANSACTION_ID, 1967 # - TRANSACTION_CURRENCY_CODE, 1968 # - PRODUCT_ACTION_TYPE, 1969 # - Audience/Users 1970 # - BROWSER, 1971 # - BROWSER_VERSION, 1972 # - BROWSER_SIZE, 1973 # - PLATFORM, 1974 # - PLATFORM_VERSION, 1975 # - LANGUAGE, 1976 # - SCREEN_RESOLUTION, 1977 # - SCREEN_COLORS, 1978 # - JAVA_ENABLED (Boolean Field), 1979 # - FLASH_VERSION, 1980 # - GEO_SPEED (Connection speed), 1981 # - VISITOR_TYPE, 1982 # - GEO_ORGANIZATION (ISP organization), 1983 # - GEO_DOMAIN, 1984 # - GEO_IP_ADDRESS, 1985 # - GEO_IP_VERSION, 1986 # - Location 1987 # - GEO_COUNTRY, 1988 # - GEO_REGION, 1989 # - GEO_CITY, 1990 # - Event 1991 # - EVENT_CATEGORY, 1992 # - EVENT_ACTION, 1993 # - EVENT_LABEL, 1994 # - Other 1995 # - CUSTOM_FIELD_1, 1996 # - CUSTOM_FIELD_2, 1997 # - USER_DEFINED_VALUE, 1998 # - Application 1999 # - APP_ID, 2000 # - APP_INSTALLER_ID, 2001 # - APP_NAME, 2002 # - APP_VERSION, 2003 # - SCREEN, 2004 # - IS_APP (Boolean Field), 2005 # - IS_FATAL_EXCEPTION (Boolean Field), 2006 # - EXCEPTION_DESCRIPTION, 2007 # - Mobile device 2008 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 2009 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 2010 # - DEVICE_CATEGORY, 2011 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 2012 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 2013 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 2014 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 2015 # - MOBILE_BRAND_NAME, 2016 # - MOBILE_MODEL_NAME, 2017 # - MOBILE_MARKETING_NAME, 2018 # - MOBILE_POINTING_METHOD, 2019 # - Social 2020 # - SOCIAL_NETWORK, 2021 # - SOCIAL_ACTION, 2022 # - SOCIAL_ACTION_TARGET, 2023 # - Custom dimension 2024 # - CUSTOM_DIMENSION (See accompanying field index), 2025 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 2026 "kind": "analytics#filterExpression", # Kind value for filter expression 2027 "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. 2028 }, 2029 "kind": "analytics#filter", # Resource type for Analytics filter. 2030 "lowercaseDetails": { # Details for the filter of the type LOWER. 2031 "field": "A String", # Field to use in the filter. 2032 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2033 }, 2034 "name": "A String", # Name of this filter. 2035 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 2036 "href": "A String", # Link to the account to which this filter belongs. 2037 "type": "analytics#account", # Value is "analytics#account". 2038 }, 2039 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 2040 "caseSensitive": True or False, # Determines if the filter is case sensitive. 2041 "field": "A String", # Field to use in the filter. 2042 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2043 "replaceString": "A String", # Term to replace the search term with. 2044 "searchString": "A String", # Term to search. 2045 }, 2046 "selfLink": "A String", # Link for this filter. 2047 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 2048 "updated": "A String", # Time this filter was last modified. 2049 "uppercaseDetails": { # Details for the filter of the type UPPER. 2050 "field": "A String", # Field to use in the filter. 2051 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2052 }, 2053} 2054 2055 2056Returns: 2057 An object of the form: 2058 2059 { # JSON template for an Analytics account filter. 2060 "accountId": "A String", # Account ID to which this filter belongs. 2061 "advancedDetails": { # Details for the filter of the type ADVANCED. 2062 "caseSensitive": True or False, # Indicates if the filter expressions are case sensitive. 2063 "extractA": "A String", # Expression to extract from field A. 2064 "extractB": "A String", # Expression to extract from field B. 2065 "fieldA": "A String", # Field A. 2066 "fieldAIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2067 "fieldARequired": True or False, # Indicates if field A is required to match. 2068 "fieldB": "A String", # Field B. 2069 "fieldBIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2070 "fieldBRequired": True or False, # Indicates if field B is required to match. 2071 "outputConstructor": "A String", # Expression used to construct the output value. 2072 "outputToField": "A String", # Output field. 2073 "outputToFieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2074 "overrideOutputField": True or False, # Indicates if the existing value of the output field, if any, should be overridden by the output expression. 2075 }, 2076 "created": "A String", # Time this filter was created. 2077 "excludeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type EXCLUDE. 2078 "caseSensitive": True or False, # Determines if the filter is case sensitive. 2079 "expressionValue": "A String", # Filter expression value 2080 "field": "A String", # Field to filter. Possible values: 2081 # - Content and Traffic 2082 # - PAGE_REQUEST_URI, 2083 # - PAGE_HOSTNAME, 2084 # - PAGE_TITLE, 2085 # - REFERRAL, 2086 # - COST_DATA_URI (Campaign target URL), 2087 # - HIT_TYPE, 2088 # - INTERNAL_SEARCH_TERM, 2089 # - INTERNAL_SEARCH_TYPE, 2090 # - SOURCE_PROPERTY_TRACKING_ID, 2091 # - Campaign or AdGroup 2092 # - CAMPAIGN_SOURCE, 2093 # - CAMPAIGN_MEDIUM, 2094 # - CAMPAIGN_NAME, 2095 # - CAMPAIGN_AD_GROUP, 2096 # - CAMPAIGN_TERM, 2097 # - CAMPAIGN_CONTENT, 2098 # - CAMPAIGN_CODE, 2099 # - CAMPAIGN_REFERRAL_PATH, 2100 # - E-Commerce 2101 # - TRANSACTION_COUNTRY, 2102 # - TRANSACTION_REGION, 2103 # - TRANSACTION_CITY, 2104 # - TRANSACTION_AFFILIATION (Store or order location), 2105 # - ITEM_NAME, 2106 # - ITEM_CODE, 2107 # - ITEM_VARIATION, 2108 # - TRANSACTION_ID, 2109 # - TRANSACTION_CURRENCY_CODE, 2110 # - PRODUCT_ACTION_TYPE, 2111 # - Audience/Users 2112 # - BROWSER, 2113 # - BROWSER_VERSION, 2114 # - BROWSER_SIZE, 2115 # - PLATFORM, 2116 # - PLATFORM_VERSION, 2117 # - LANGUAGE, 2118 # - SCREEN_RESOLUTION, 2119 # - SCREEN_COLORS, 2120 # - JAVA_ENABLED (Boolean Field), 2121 # - FLASH_VERSION, 2122 # - GEO_SPEED (Connection speed), 2123 # - VISITOR_TYPE, 2124 # - GEO_ORGANIZATION (ISP organization), 2125 # - GEO_DOMAIN, 2126 # - GEO_IP_ADDRESS, 2127 # - GEO_IP_VERSION, 2128 # - Location 2129 # - GEO_COUNTRY, 2130 # - GEO_REGION, 2131 # - GEO_CITY, 2132 # - Event 2133 # - EVENT_CATEGORY, 2134 # - EVENT_ACTION, 2135 # - EVENT_LABEL, 2136 # - Other 2137 # - CUSTOM_FIELD_1, 2138 # - CUSTOM_FIELD_2, 2139 # - USER_DEFINED_VALUE, 2140 # - Application 2141 # - APP_ID, 2142 # - APP_INSTALLER_ID, 2143 # - APP_NAME, 2144 # - APP_VERSION, 2145 # - SCREEN, 2146 # - IS_APP (Boolean Field), 2147 # - IS_FATAL_EXCEPTION (Boolean Field), 2148 # - EXCEPTION_DESCRIPTION, 2149 # - Mobile device 2150 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 2151 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 2152 # - DEVICE_CATEGORY, 2153 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 2154 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 2155 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 2156 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 2157 # - MOBILE_BRAND_NAME, 2158 # - MOBILE_MODEL_NAME, 2159 # - MOBILE_MARKETING_NAME, 2160 # - MOBILE_POINTING_METHOD, 2161 # - Social 2162 # - SOCIAL_NETWORK, 2163 # - SOCIAL_ACTION, 2164 # - SOCIAL_ACTION_TARGET, 2165 # - Custom dimension 2166 # - CUSTOM_DIMENSION (See accompanying field index), 2167 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 2168 "kind": "analytics#filterExpression", # Kind value for filter expression 2169 "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. 2170 }, 2171 "id": "A String", # Filter ID. 2172 "includeDetails": { # JSON template for an Analytics filter expression. # Details for the filter of the type INCLUDE. 2173 "caseSensitive": True or False, # Determines if the filter is case sensitive. 2174 "expressionValue": "A String", # Filter expression value 2175 "field": "A String", # Field to filter. Possible values: 2176 # - Content and Traffic 2177 # - PAGE_REQUEST_URI, 2178 # - PAGE_HOSTNAME, 2179 # - PAGE_TITLE, 2180 # - REFERRAL, 2181 # - COST_DATA_URI (Campaign target URL), 2182 # - HIT_TYPE, 2183 # - INTERNAL_SEARCH_TERM, 2184 # - INTERNAL_SEARCH_TYPE, 2185 # - SOURCE_PROPERTY_TRACKING_ID, 2186 # - Campaign or AdGroup 2187 # - CAMPAIGN_SOURCE, 2188 # - CAMPAIGN_MEDIUM, 2189 # - CAMPAIGN_NAME, 2190 # - CAMPAIGN_AD_GROUP, 2191 # - CAMPAIGN_TERM, 2192 # - CAMPAIGN_CONTENT, 2193 # - CAMPAIGN_CODE, 2194 # - CAMPAIGN_REFERRAL_PATH, 2195 # - E-Commerce 2196 # - TRANSACTION_COUNTRY, 2197 # - TRANSACTION_REGION, 2198 # - TRANSACTION_CITY, 2199 # - TRANSACTION_AFFILIATION (Store or order location), 2200 # - ITEM_NAME, 2201 # - ITEM_CODE, 2202 # - ITEM_VARIATION, 2203 # - TRANSACTION_ID, 2204 # - TRANSACTION_CURRENCY_CODE, 2205 # - PRODUCT_ACTION_TYPE, 2206 # - Audience/Users 2207 # - BROWSER, 2208 # - BROWSER_VERSION, 2209 # - BROWSER_SIZE, 2210 # - PLATFORM, 2211 # - PLATFORM_VERSION, 2212 # - LANGUAGE, 2213 # - SCREEN_RESOLUTION, 2214 # - SCREEN_COLORS, 2215 # - JAVA_ENABLED (Boolean Field), 2216 # - FLASH_VERSION, 2217 # - GEO_SPEED (Connection speed), 2218 # - VISITOR_TYPE, 2219 # - GEO_ORGANIZATION (ISP organization), 2220 # - GEO_DOMAIN, 2221 # - GEO_IP_ADDRESS, 2222 # - GEO_IP_VERSION, 2223 # - Location 2224 # - GEO_COUNTRY, 2225 # - GEO_REGION, 2226 # - GEO_CITY, 2227 # - Event 2228 # - EVENT_CATEGORY, 2229 # - EVENT_ACTION, 2230 # - EVENT_LABEL, 2231 # - Other 2232 # - CUSTOM_FIELD_1, 2233 # - CUSTOM_FIELD_2, 2234 # - USER_DEFINED_VALUE, 2235 # - Application 2236 # - APP_ID, 2237 # - APP_INSTALLER_ID, 2238 # - APP_NAME, 2239 # - APP_VERSION, 2240 # - SCREEN, 2241 # - IS_APP (Boolean Field), 2242 # - IS_FATAL_EXCEPTION (Boolean Field), 2243 # - EXCEPTION_DESCRIPTION, 2244 # - Mobile device 2245 # - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), 2246 # - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), 2247 # - DEVICE_CATEGORY, 2248 # - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), 2249 # - MOBILE_HAS_NFC_SUPPORT (Boolean Field), 2250 # - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), 2251 # - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), 2252 # - MOBILE_BRAND_NAME, 2253 # - MOBILE_MODEL_NAME, 2254 # - MOBILE_MARKETING_NAME, 2255 # - MOBILE_POINTING_METHOD, 2256 # - Social 2257 # - SOCIAL_NETWORK, 2258 # - SOCIAL_ACTION, 2259 # - SOCIAL_ACTION_TARGET, 2260 # - Custom dimension 2261 # - CUSTOM_DIMENSION (See accompanying field index), 2262 "fieldIndex": 42, # The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. 2263 "kind": "analytics#filterExpression", # Kind value for filter expression 2264 "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. 2265 }, 2266 "kind": "analytics#filter", # Resource type for Analytics filter. 2267 "lowercaseDetails": { # Details for the filter of the type LOWER. 2268 "field": "A String", # Field to use in the filter. 2269 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2270 }, 2271 "name": "A String", # Name of this filter. 2272 "parentLink": { # Parent link for this filter. Points to the account to which this filter belongs. 2273 "href": "A String", # Link to the account to which this filter belongs. 2274 "type": "analytics#account", # Value is "analytics#account". 2275 }, 2276 "searchAndReplaceDetails": { # Details for the filter of the type SEARCH_AND_REPLACE. 2277 "caseSensitive": True or False, # Determines if the filter is case sensitive. 2278 "field": "A String", # Field to use in the filter. 2279 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2280 "replaceString": "A String", # Term to replace the search term with. 2281 "searchString": "A String", # Term to search. 2282 }, 2283 "selfLink": "A String", # Link for this filter. 2284 "type": "A String", # Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. 2285 "updated": "A String", # Time this filter was last modified. 2286 "uppercaseDetails": { # Details for the filter of the type UPPER. 2287 "field": "A String", # Field to use in the filter. 2288 "fieldIndex": 42, # The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION. 2289 }, 2290}</pre> 2291</div> 2292 2293</body></html>