Reference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::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
deffield_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=
deffield_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
deflimit()->::Integer
Returns
(::Integer) — The number of unique combinations of dimension values to return in this
pivot. The limit parameter is required. A limit of 10,000 is common for
single pivot requests.
The product of the limit for each pivot in a RunPivotReportRequest
must not exceed 100,000. For example, a two pivot request with limit:
1000 in each pivot will fail because the product is 1,000,000.
#limit=
deflimit=(value)->::Integer
Parameter
value (::Integer) — The number of unique combinations of dimension values to return in this
pivot. The limit parameter is required. A limit of 10,000 is common for
single pivot requests.
The product of the limit for each pivot in a RunPivotReportRequest
must not exceed 100,000. For example, a two pivot request with limit:
1000 in each pivot will fail because the product is 1,000,000.
Returns
(::Integer) — The number of unique combinations of dimension values to return in this
pivot. The limit parameter is required. A limit of 10,000 is common for
single pivot requests.
The product of the limit for each pivot in a RunPivotReportRequest
must not exceed 100,000. For example, a two pivot request with limit:
1000 in each pivot will fail because the product is 1,000,000.
(::Array<::Google::Analytics::Data::V1beta::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.
value (::Array<::Google::Analytics::Data::V1beta::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::V1beta::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::Pivot (v0.4.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.4.3 (latest)](/ruby/docs/reference/google-analytics-data-v1beta/latest/Google-Analytics-Data-V1beta-Pivot)\n- [0.4.2](/ruby/docs/reference/google-analytics-data-v1beta/0.4.2/Google-Analytics-Data-V1beta-Pivot) \nReference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::Pivot.\n\nDescribes the visible dimension columns and rows in the report response. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #field_names\n\n def field_names() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #field_names=\n\n def field_names=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- 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. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #limit\n\n def limit() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests.\n\n\n The product of the `limit` for each `pivot` in a `RunPivotReportRequest`\n must not exceed 100,000. For example, a two pivot request with `limit:\n 1000` in each pivot will fail because the product is `1,000,000`.\n\n### #limit=\n\n def limit=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests.\n\n\n The product of the `limit` for each `pivot` in a `RunPivotReportRequest`\n must not exceed 100,000. For example, a two pivot request with `limit:\n1000` in each pivot will fail because the product is `1,000,000`. \n**Returns**\n\n- (::Integer) --- The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests.\n\n\n The product of the `limit` for each `pivot` in a `RunPivotReportRequest`\n must not exceed 100,000. For example, a two pivot request with `limit:\n 1000` in each pivot will fail because the product is `1,000,000`.\n\n### #metric_aggregations\n\n def metric_aggregations() -\u003e ::Array\u003c::Google::Analytics::Data::V1beta::MetricAggregation\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Analytics::Data::V1beta::MetricAggregation](./Google-Analytics-Data-V1beta-MetricAggregation)\\\u003e) --- Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.\n\n### #metric_aggregations=\n\n def metric_aggregations=(value) -\u003e ::Array\u003c::Google::Analytics::Data::V1beta::MetricAggregation\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Analytics::Data::V1beta::MetricAggregation](./Google-Analytics-Data-V1beta-MetricAggregation)\\\u003e) --- Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations. \n**Returns**\n\n- (::Array\\\u003c[::Google::Analytics::Data::V1beta::MetricAggregation](./Google-Analytics-Data-V1beta-MetricAggregation)\\\u003e) --- Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.\n\n### #offset\n\n def offset() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The row count of the start row. The first row is counted as row 0.\n\n### #offset=\n\n def offset=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The row count of the start row. The first row is counted as row 0. \n**Returns**\n\n- (::Integer) --- The row count of the start row. The first row is counted as row 0.\n\n### #order_bys\n\n def order_bys() -\u003e ::Array\u003c::Google::Analytics::Data::V1beta::OrderBy\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Analytics::Data::V1beta::OrderBy](./Google-Analytics-Data-V1beta-OrderBy)\\\u003e) --- 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.\n\n### #order_bys=\n\n def order_bys=(value) -\u003e ::Array\u003c::Google::Analytics::Data::V1beta::OrderBy\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Analytics::Data::V1beta::OrderBy](./Google-Analytics-Data-V1beta-OrderBy)\\\u003e) --- 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. \n**Returns**\n\n- (::Array\\\u003c[::Google::Analytics::Data::V1beta::OrderBy](./Google-Analytics-Data-V1beta-OrderBy)\\\u003e) --- 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."]]
