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