Class: Google::Apis::AnalyticsV3::Filters

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

Overview

A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Filters

Returns a new instance of Filters.


2479
2480
2481
# File 'generated/google/apis/analytics_v3/classes.rb', line 2479

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

Instance Attribute Details

#itemsArray<Google::Apis::AnalyticsV3::Filter>

A list of filters. Corresponds to the JSON property items


2437
2438
2439
# File 'generated/google/apis/analytics_v3/classes.rb', line 2437

def items
  @items
end

#items_per_pageFixnum

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

Returns:

  • (Fixnum)

2445
2446
2447
# File 'generated/google/apis/analytics_v3/classes.rb', line 2445

def items_per_page
  @items_per_page
end

#kindString

Collection type. Corresponds to the JSON property kind

Returns:

  • (String)

2450
2451
2452
# File 'generated/google/apis/analytics_v3/classes.rb', line 2450

def kind
  @kind
end

Link to next page for this filter collection. Corresponds to the JSON property nextLink

Returns:

  • (String)

2455
2456
2457
# File 'generated/google/apis/analytics_v3/classes.rb', line 2455

def next_link
  @next_link
end

Link to previous page for this filter collection. Corresponds to the JSON property previousLink

Returns:

  • (String)

2460
2461
2462
# File 'generated/google/apis/analytics_v3/classes.rb', line 2460

def previous_link
  @previous_link
end

#start_indexFixnum

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum)

2466
2467
2468
# File 'generated/google/apis/analytics_v3/classes.rb', line 2466

def start_index
  @start_index
end

#total_resultsFixnum

The total number of results for the query, regardless of the number of results in the response. Corresponds to the JSON property totalResults

Returns:

  • (Fixnum)

2472
2473
2474
# File 'generated/google/apis/analytics_v3/classes.rb', line 2472

def total_results
  @total_results
end

#usernameString

Email ID of the authenticated user Corresponds to the JSON property username

Returns:

  • (String)

2477
2478
2479
# File 'generated/google/apis/analytics_v3/classes.rb', line 2477

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
# File 'generated/google/apis/analytics_v3/classes.rb', line 2484

def update!(**args)
  @items = args[:items] if args.key?(:items)
  @items_per_page = args[:items_per_page] if args.key?(:items_per_page)
  @kind = args[:kind] if args.key?(:kind)
  @next_link = args[:next_link] if args.key?(:next_link)
  @previous_link = args[:previous_link] if args.key?(:previous_link)
  @start_index = args[:start_index] if args.key?(:start_index)
  @total_results = args[:total_results] if args.key?(:total_results)
  @username = args[:username] if args.key?(:username)
end