Reference documentation and code samples for the Google Analytics Data V1alpha API class Google::Analytics::Data::V1alpha::Pivot.
Describes the visible dimension columns and rows in the report response.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#field_names
def field_names() -> ::Array<::String>
Returns
- (::Array<::String>) — Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
#field_names=
def field_names=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
Returns
- (::Array<::String>) — Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.
#limit
def limit() -> ::Integer
Returns
- (::Integer) — The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.
#limit=
def limit=(value) -> ::Integer
Parameter
- value (::Integer) — The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.
Returns
- (::Integer) — The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.
#metric_aggregations
def metric_aggregations() -> ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>
Returns
- (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
#metric_aggregations=
def metric_aggregations=(value) -> ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>
Parameter
- value (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
Returns
- (::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>) — Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.
#offset
def offset() -> ::Integer
Returns
- (::Integer) — The row count of the start row. The first row is counted as row 0.
#offset=
def offset=(value) -> ::Integer
Parameter
- value (::Integer) — The row count of the start row. The first row is counted as row 0.
Returns
- (::Integer) — The row count of the start row. The first row is counted as row 0.
#order_bys
def order_bys() -> ::Array<::Google::Analytics::Data::V1alpha::OrderBy>
Returns
- (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
#order_bys=
def order_bys=(value) -> ::Array<::Google::Analytics::Data::V1alpha::OrderBy>
Parameter
- value (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.
Returns
- (::Array<::Google::Analytics::Data::V1alpha::OrderBy>) — Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.