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



1352
1353
1354
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1352

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) 


1343
1344
1345
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1343

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) 


1326
1327
1328
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1326

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:



1350
1351
1352
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1350

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:



1286
1287
1288
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1286

def minimums
  @minimums
end

#row_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1337
1338
1339
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1337

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:



1332
1333
1334
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1332

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


1319
1320
1321
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1319

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


1297
1298
1299
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1297

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:



1309
1310
1311
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1309

def totals
  @totals
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1357

def update!(**args)
  @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)
  @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