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

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

Overview

The data part of the report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReportData

Returns a new instance of ReportData.

[View source]

1252
1253
1254
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1252

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) 

1187
1188
1189
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1187

def data_last_refreshed
  @data_last_refreshed
end

#empty_reason ⇒ String

If empty reason is specified, the report is empty for this reason. Corresponds to the JSON property emptyReason

Returns:

  • (String) 

1192
1193
1194
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1192

def empty_reason
  @empty_reason
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) 

1199
1200
1201
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1199

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:


1206
1207
1208
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1206

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:


1212
1213
1214
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1212

def minimums
  @minimums
end

#row_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 

1217
1218
1219
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1217

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:


1222
1223
1224
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1222

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

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

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

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

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:


1250
1251
1252
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1250

def totals
  @totals
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1257

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