Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::Pivot (v0.4.3)

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.

#metric_aggregations

defmetric_aggregations()->::Array<::Google::Analytics::Data::V1beta::MetricAggregation>
Returns

#metric_aggregations=

defmetric_aggregations=(value)->::Array<::Google::Analytics::Data::V1beta::MetricAggregation>
Parameter
Returns

#offset

defoffset()->::Integer
Returns
  • (::Integer) — The row count of the start row. The first row is counted as row 0.

#offset=

defoffset=(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

deforder_bys()->::Array<::Google::Analytics::Data::V1beta::OrderBy>
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.

#order_bys=

deforder_bys=(value)->::Array<::Google::Analytics::Data::V1beta::OrderBy>
Parameter
  • 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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.