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.


4760
4761
4762
# File 'generated/google/apis/analytics_v3/classes.rb', line 4760

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

Instance Attribute Details

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

A list of segments. Corresponds to the JSON property items


4718
4719
4720
# File 'generated/google/apis/analytics_v3/classes.rb', line 4718

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

4726
4727
4728
# File 'generated/google/apis/analytics_v3/classes.rb', line 4726

def items_per_page
  @items_per_page
end

#kindString

Collection type for segments. Corresponds to the JSON property kind

Returns:

  • (String)

4731
4732
4733
# File 'generated/google/apis/analytics_v3/classes.rb', line 4731

def kind
  @kind
end

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

Returns:

  • (String)

4736
4737
4738
# File 'generated/google/apis/analytics_v3/classes.rb', line 4736

def next_link
  @next_link
end

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

Returns:

  • (String)

4741
4742
4743
# File 'generated/google/apis/analytics_v3/classes.rb', line 4741

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)

4747
4748
4749
# File 'generated/google/apis/analytics_v3/classes.rb', line 4747

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)

4753
4754
4755
# File 'generated/google/apis/analytics_v3/classes.rb', line 4753

def total_results
  @total_results
end

#usernameString

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

Returns:

  • (String)

4758
4759
4760
# File 'generated/google/apis/analytics_v3/classes.rb', line 4758

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'generated/google/apis/analytics_v3/classes.rb', line 4765

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