Class: Google::Apis::AnalyticsV3::CustomDimensions

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

Overview

A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomDimensions

Returns a new instance of CustomDimensions.



1023
1024
1025
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 1023

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

Instance Attribute Details

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

Collection of custom dimensions. Corresponds to the JSON property items

Returns:



981
982
983
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 981

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) 


989
990
991
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 989

def items_per_page
  @items_per_page
end

#kind ⇒ String

Collection type. Corresponds to the JSON property kind

Returns:

  • (String) 


994
995
996
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 994

def kind
  @kind
end

#next_link ⇒ String

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

Returns:

  • (String) 


999
1000
1001
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 999

def next_link
  @next_link
end

#previous_link ⇒ String

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

Returns:

  • (String) 


1004
1005
1006
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 1004

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) 


1010
1011
1012
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 1010

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) 


1016
1017
1018
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 1016

def total_results
  @total_results
end

#username ⇒ String

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

Returns:

  • (String) 


1021
1022
1023
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 1021

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 1028

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