Struct gapi_grpc::google::analytics::data::v1alpha::RunPivotReportResponse

pub struct RunPivotReportResponse {
    pub pivot_headers: Vec<PivotHeader>,
    pub dimension_headers: Vec<DimensionHeader>,
    pub metric_headers: Vec<MetricHeader>,
    pub rows: Vec<Row>,
    pub aggregates: Vec<Row>,
    pub metadata: Option<ResponseMetaData>,
    pub property_quota: Option<PropertyQuota>,
}

The response pivot report table corresponding to a pivot request.

Fields

pivot_headers: Vec<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" }]
  }]
}]

dimension_headers: Vec<DimensionHeader>

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

metric_headers: Vec<MetricHeader>

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

rows: Vec<Row>

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

aggregates: Vec<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_”.

metadata: Option<ResponseMetaData>

Metadata for the report.

property_quota: Option<PropertyQuota>

This Analytics Property’s quota state including this request.

Trait Implementations

impl Clone for RunPivotReportResponse

fn clone(&self) -> RunPivotReportResponse

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunPivotReportResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RunPivotReportResponse

fn default() -> RunPivotReportResponse

Returns the “default value” for a type.

impl Message for RunPivotReportResponse

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<RunPivotReportResponse> for RunPivotReportResponse

fn eq(&self, other: &RunPivotReportResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RunPivotReportResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for RunPivotReportResponse