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



1240
1241
1242
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1240

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

Instance Attribute Details

#data_last_refreshedString

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)


1231
1232
1233
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1231

def data_last_refreshed
  @data_last_refreshed
end

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


1214
1215
1216
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1214

def is_data_golden
  @is_data_golden
end

#maximumsArray<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



1238
1239
1240
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1238

def maximums
  @maximums
end

#minimumsArray<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



1185
1186
1187
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1185

def minimums
  @minimums
end

#row_countFixnum

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

Returns:

  • (Fixnum)


1225
1226
1227
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1225

def row_count
  @row_count
end

#rowsArray<Google::Apis::AnalyticsreportingV4::ReportRow>

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



1220
1221
1222
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1220

def rows
  @rows
end

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


1207
1208
1209
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1207

def samples_read_counts
  @samples_read_counts
end

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


1178
1179
1180
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1178

def sampling_space_sizes
  @sampling_space_sizes
end

#totalsArray<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



1197
1198
1199
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1197

def totals
  @totals
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1245

def update!(**args)
  @sampling_space_sizes = args[:sampling_space_sizes] if args.key?(:sampling_space_sizes)
  @minimums = args[:minimums] if args.key?(:minimums)
  @totals = args[:totals] if args.key?(:totals)
  @samples_read_counts = args[:samples_read_counts] if args.key?(:samples_read_counts)
  @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)
end