Class Google::Analytics::Data::V1beta::RunReportRequest

The request to generate a report.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cohort_spec

defcohort_spec()->::Google::Analytics::Data::V1beta::CohortSpec
Returns

#cohort_spec=

defcohort_spec=(value)->::Google::Analytics::Data::V1beta::CohortSpec
Parameter
Returns

#currency_code

defcurrency_code()->::String
Returns
  • (::String) — A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

#currency_code=

defcurrency_code=(value)->::String
Parameter
  • value (::String) — A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.
Returns
  • (::String) — A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

#date_ranges

defdate_ranges()->::Array<::Google::Analytics::Data::V1beta::DateRange>
Returns
  • (::Array<::Google::Analytics::Data::V1beta::DateRange>) — Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this dateRanges must be unspecified.

#date_ranges=

defdate_ranges=(value)->::Array<::Google::Analytics::Data::V1beta::DateRange>
Parameter
  • value (::Array<::Google::Analytics::Data::V1beta::DateRange>) — Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this dateRanges must be unspecified.
Returns
  • (::Array<::Google::Analytics::Data::V1beta::DateRange>) — Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this dateRanges must be unspecified.

#dimension_filter

defdimension_filter()->::Google::Analytics::Data::V1beta::FilterExpression
Returns

#dimension_filter=

defdimension_filter=(value)->::Google::Analytics::Data::V1beta::FilterExpression
Parameter
Returns

#dimensions

defdimensions()->::Array<::Google::Analytics::Data::V1beta::Dimension>
Returns

#dimensions=

defdimensions=(value)->::Array<::Google::Analytics::Data::V1beta::Dimension>
Parameter
Returns

#keep_empty_rows

defkeep_empty_rows()->::Boolean
Returns
  • (::Boolean) — If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

#keep_empty_rows=

defkeep_empty_rows=(value)->::Boolean
Parameter
  • value (::Boolean) — If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
Returns
  • (::Boolean) — If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

#limit

deflimit()->::Integer
Returns
  • (::Integer) — The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

    The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

    To learn more about this pagination parameter, see Pagination.

#limit=

deflimit=(value)->::Integer
Parameter
  • value (::Integer) — The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

    The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

    To learn more about this pagination parameter, see Pagination.

Returns
  • (::Integer) — The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

    The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

    To learn more about this pagination parameter, see Pagination.

#metric_aggregations

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

#metric_aggregations=

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

#metric_filter

defmetric_filter()->::Google::Analytics::Data::V1beta::FilterExpression
Returns

#metric_filter=

defmetric_filter=(value)->::Google::Analytics::Data::V1beta::FilterExpression
Parameter
Returns

#metrics

defmetrics()->::Array<::Google::Analytics::Data::V1beta::Metric>
Returns

#metrics=

defmetrics=(value)->::Array<::Google::Analytics::Data::V1beta::Metric>
Parameter
Returns

#offset

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

    When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

    To learn more about this pagination parameter, see Pagination.

#offset=

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

    When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

    To learn more about this pagination parameter, see Pagination.

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

    When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

    To learn more about this pagination parameter, see Pagination.

#order_bys

deforder_bys()->::Array<::Google::Analytics::Data::V1beta::OrderBy>
Returns

#order_bys=

deforder_bys=(value)->::Array<::Google::Analytics::Data::V1beta::OrderBy>
Parameter
Returns

#property

defproperty()->::String
Returns
  • (::String) — A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

    Example: properties/1234

#property=

defproperty=(value)->::String
Parameter
  • value (::String) — A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

    Example: properties/1234

Returns
  • (::String) — A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

    Example: properties/1234

#return_property_quota

defreturn_property_quota()->::Boolean
Returns
  • (::Boolean) — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

#return_property_quota=

defreturn_property_quota=(value)->::Boolean
Parameter
  • value (::Boolean) — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.
Returns
  • (::Boolean) — Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

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.