Class: Google::Apis::AnalyticsV3::UnsampledReports

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 unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.

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

Returns a new instance of UnsampledReports.


5170
5171
5172
# File 'generated/google/apis/analytics_v3/classes.rb', line 5170

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

Instance Attribute Details

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

A list of unsampled reports. Corresponds to the JSON property items


5128
5129
5130
# File 'generated/google/apis/analytics_v3/classes.rb', line 5128

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)

5136
5137
5138
# File 'generated/google/apis/analytics_v3/classes.rb', line 5136

def items_per_page
  @items_per_page
end

#kindString

Collection type. Corresponds to the JSON property kind

Returns:

  • (String)

5141
5142
5143
# File 'generated/google/apis/analytics_v3/classes.rb', line 5141

def kind
  @kind
end

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

Returns:

  • (String)

5146
5147
5148
# File 'generated/google/apis/analytics_v3/classes.rb', line 5146

def next_link
  @next_link
end

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

Returns:

  • (String)

5151
5152
5153
# File 'generated/google/apis/analytics_v3/classes.rb', line 5151

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)

5157
5158
5159
# File 'generated/google/apis/analytics_v3/classes.rb', line 5157

def start_index
  @start_index
end

#total_resultsFixnum

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

Returns:

  • (Fixnum)

5163
5164
5165
# File 'generated/google/apis/analytics_v3/classes.rb', line 5163

def total_results
  @total_results
end

#usernameString

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

Returns:

  • (String)

5168
5169
5170
# File 'generated/google/apis/analytics_v3/classes.rb', line 5168

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
# File 'generated/google/apis/analytics_v3/classes.rb', line 5175

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