Class: Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse

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

Overview

The response pivot report table corresponding to a pivot request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunPivotReportResponse

Returns a new instance of RunPivotReportResponse.



1450
1451
1452
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1450

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

Instance Attribute Details

#aggregates ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Row>

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_". Corresponds to the JSON property aggregates

Returns:



1407
1408
1409
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1407

def aggregates
  @aggregates
end

#dimension_headers ⇒ Array<Google::Apis::AnalyticsdataV1alpha::DimensionHeader>

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. Corresponds to the JSON property dimensionHeaders

Returns:



1413
1414
1415
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1413

def dimension_headers
  @dimension_headers
end

#metadata ⇒ Google::Apis::AnalyticsdataV1alpha::ResponseMetaData

Response's metadata carrying additional information about the report content. Corresponds to the JSON property metadata

Returns:



1418
1419
1420
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1418

def metadata
  @metadata
end

#metric_headers ⇒ Array<Google::Apis::AnalyticsdataV1alpha::MetricHeader>

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. Corresponds to the JSON property metricHeaders

Returns:



1424
1425
1426
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1424

def metric_headers
  @metric_headers
end

#pivot_headers ⇒ Array<Google::Apis::AnalyticsdataV1alpha::PivotHeader>

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": ["fieldNames": ["country", "city"], "fieldNames": "eventName"] We will have the following pivotHeaders in the response: "pivotHeaders" : [" dimensionHeaders": [ "dimensionValues": [ "value": "United Kingdom", " value": "London" ] , "dimensionValues": [ "value": "Japan", "value": "Osaka" ] ], "dimensionHeaders": [ "dimensionValues": ["value": " session_start"] , "dimensionValues": ["value": "scroll"] ]] Corresponds to the JSON property pivotHeaders

Returns:



1436
1437
1438
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1436

def pivot_headers
  @pivot_headers
end

#property_quota ⇒ Google::Apis::AnalyticsdataV1alpha::PropertyQuota

Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. Corresponds to the JSON property propertyQuota

Returns:



1443
1444
1445
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1443

def property_quota
  @property_quota
end

#rows ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Row>

Rows of dimension value combinations and metric values in the report. Corresponds to the JSON property rows

Returns:



1448
1449
1450
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1448

def rows
  @rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 1455

def update!(**args)
  @aggregates = args[:aggregates] if args.key?(:aggregates)
  @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metric_headers = args[:metric_headers] if args.key?(:metric_headers)
  @pivot_headers = args[:pivot_headers] if args.key?(:pivot_headers)
  @property_quota = args[:property_quota] if args.key?(:property_quota)
  @rows = args[:rows] if args.key?(:rows)
end