Google Analytics Data V1alpha API - Class Google::Analytics::Data::V1alpha::RunPivotReportResponse (v0.8.3)

Reference documentation and code samples for the Google Analytics Data V1alpha API class Google::Analytics::Data::V1alpha::RunPivotReportResponse.

The response pivot report table corresponding to a pivot request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aggregates

def aggregates() -> ::Array<::Google::Analytics::Data::V1alpha::Row>
Returns
  • (::Array<::Google::Analytics::Data::V1alpha::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_

#aggregates=

def aggregates=(value) -> ::Array<::Google::Analytics::Data::V1alpha::Row>
Parameter
  • value (::Array<::Google::Analytics::Data::V1alpha::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::V1alpha::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_

#dimension_headers

def dimension_headers() -> ::Array<::Google::Analytics::Data::V1alpha::DimensionHeader>
Returns

#dimension_headers=

def dimension_headers=(value) -> ::Array<::Google::Analytics::Data::V1alpha::DimensionHeader>
Parameter
Returns

#metadata

def metadata() -> ::Google::Analytics::Data::V1alpha::ResponseMetaData
Returns

#metadata=

def metadata=(value) -> ::Google::Analytics::Data::V1alpha::ResponseMetaData
Parameter
Returns

#metric_headers

def metric_headers() -> ::Array<::Google::Analytics::Data::V1alpha::MetricHeader>
Returns

#metric_headers=

def metric_headers=(value) -> ::Array<::Google::Analytics::Data::V1alpha::MetricHeader>
Parameter
Returns

#pivot_headers

def pivot_headers() -> ::Array<::Google::Analytics::Data::V1alpha::PivotHeader>
Returns
  • (::Array<::Google::Analytics::Data::V1alpha::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" }]
  }]
}]

#pivot_headers=

def pivot_headers=(value) -> ::Array<::Google::Analytics::Data::V1alpha::PivotHeader>
Parameter
  • value (::Array<::Google::Analytics::Data::V1alpha::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" }]
  }]
}]
Returns
  • (::Array<::Google::Analytics::Data::V1alpha::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" }]
  }]
}]

#property_quota

def property_quota() -> ::Google::Analytics::Data::V1alpha::PropertyQuota
Returns

#property_quota=

def property_quota=(value) -> ::Google::Analytics::Data::V1alpha::PropertyQuota
Parameter
Returns

#rows

def rows() -> ::Array<::Google::Analytics::Data::V1alpha::Row>
Returns

#rows=

def rows=(value) -> ::Array<::Google::Analytics::Data::V1alpha::Row>
Parameter
Returns