Class: Google::Analytics::Data::V1beta::RunPivotReportResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1beta/analytics_data_api.rb

Overview

The response pivot report table corresponding to a pivot request.

Instance Attribute Summary collapse

Instance Attribute Details

#aggregates ⇒ ::Array<::Google::Analytics::Data::V1beta::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_".

Returns:

  • (::Array<::Google::Analytics::Data::V1beta::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_".



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimension_headers ⇒ ::Array<::Google::Analytics::Data::V1beta::DimensionHeader>

Returns Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Returns:



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#kind ⇒ ::String

Returns Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

Returns:

  • (::String) —

    Identifies what kind of resource this message is. This kind is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metadata ⇒ ::Google::Analytics::Data::V1beta::ResponseMetaData

Returns Metadata for the report.

Returns:



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metric_headers ⇒ ::Array<::Google::Analytics::Data::V1beta::MetricHeader>

Returns Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Returns:



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pivot_headers ⇒ ::Array<::Google::Analytics::Data::V1beta::PivotHeader>

Returns 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" }]
  }]
}].

Returns:

  • (::Array<::Google::Analytics::Data::V1beta::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" }]
  }]
}]



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#property_quota ⇒ ::Google::Analytics::Data::V1beta::PropertyQuota

Returns This Analytics Property's quota state including this request.

Returns:



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rows ⇒ ::Array<::Google::Analytics::Data::V1beta::Row>

Returns Rows of dimension value combinations and metric values in the report.

Returns:



370
371
372
373
 
# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 370

class RunPivotReportResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end