Class: Google::Apis::AnalyticsV3::Segments

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

An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.

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) ⇒ Segments

Returns a new instance of Segments



4925
4926
4927
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4925

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

Instance Attribute Details

#items ⇒ Array<Google::Apis::AnalyticsV3::Segment>

A list of segments. Corresponds to the JSON property items

Returns:



4883
4884
4885
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4883

def items
  @items
end

#items_per_page ⇒ Fixnum

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. Corresponds to the JSON property itemsPerPage

Returns:

  • (Fixnum) 


4891
4892
4893
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4891

def items_per_page
  @items_per_page
end

#kind ⇒ String

Collection type for segments. Corresponds to the JSON property kind

Returns:

  • (String) 


4896
4897
4898
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4896

def kind
  @kind
end

#next_link ⇒ String

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

Returns:

  • (String) 


4901
4902
4903
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4901

def next_link
  @next_link
end

#previous_link ⇒ String

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

Returns:

  • (String) 


4906
4907
4908
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4906

def previous_link
  @previous_link
end

#start_index ⇒ Fixnum

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) 


4912
4913
4914
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4912

def start_index
  @start_index
end

#total_results ⇒ Fixnum

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) 


4918
4919
4920
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4918

def total_results
  @total_results
end

#username ⇒ String

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

Returns:

  • (String) 


4923
4924
4925
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4923

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4930

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