Class: Google::Apis::AnalyticsreportingV4::ReportData

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

Overview

The data part of the 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) ⇒ ReportData

Returns a new instance of ReportData



100
101
102
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 100

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

Instance Attribute Details

#data_last_refreshed ⇒ String

The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report. Corresponds to the JSON property dataLastRefreshed

Returns:

  • (String) 


51
52
53
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 51

def data_last_refreshed
  @data_last_refreshed
end

#is_data_golden ⇒ Boolean Also known as: is_data_golden?

Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time. Corresponds to the JSON property isDataGolden

Returns:

  • (Boolean) 


34
35
36
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 34

def is_data_golden
  @is_data_golden
end

#maximums ⇒ Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>

Minimum and maximum values seen over all matching rows. These are both empty when hideValueRanges in the request is false, or when rowCount is zero. Corresponds to the JSON property maximums

Returns:



58
59
60
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 58

def maximums
  @maximums
end

#minimums ⇒ Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>

Minimum and maximum values seen over all matching rows. These are both empty when hideValueRanges in the request is false, or when rowCount is zero. Corresponds to the JSON property minimums

Returns:



65
66
67
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 65

def minimums
  @minimums
end

#row_count ⇒ Fixnum

Total number of matching rows for this query. Corresponds to the JSON property rowCount

Returns:

  • (Fixnum) 


45
46
47
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 45

def row_count
  @row_count
end

#rows ⇒ Array<Google::Apis::AnalyticsreportingV4::ReportRow>

There's one ReportRow for every unique combination of dimensions. Corresponds to the JSON property rows

Returns:



40
41
42
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 40

def rows
  @rows
end

#samples_read_counts ⇒ Array<Fixnum>

If the results are sampled, this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See developer guide for details. Corresponds to the JSON property samplesReadCounts

Returns:

  • (Array<Fixnum>) 


98
99
100
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 98

def samples_read_counts
  @samples_read_counts
end

#sampling_space_sizes ⇒ Array<Fixnum>

If the results are sampled, this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See developer guide for details. Corresponds to the JSON property samplingSpaceSizes

Returns:

  • (Array<Fixnum>) 


76
77
78
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 76

def sampling_space_sizes
  @sampling_space_sizes
end

#totals ⇒ Array<Google::Apis::AnalyticsreportingV4::DateRangeValues>

For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for 3 / (ga:sessions + 2) we compute 3 / ((sum of all relevant ga:sessions) + 2). Totals are computed before pagination. Corresponds to the JSON property totals

Returns:



88
89
90
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 88

def totals
  @totals
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



105
106
107
108
109
110
111
112
113
114
115
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 105

def update!(**args)
  @is_data_golden = args[:is_data_golden] if args.key?(:is_data_golden)
  @rows = args[:rows] if args.key?(:rows)
  @row_count = args[:row_count] if args.key?(:row_count)
  @data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
  @maximums = args[:maximums] if args.key?(:maximums)
  @minimums = args[:minimums] if args.key?(:minimums)
  @sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
  @totals = args[:totals] if args.key?(:totals)
  @samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
end