Class: Google::Analytics::Data::V1alpha::RunReportRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb

Overview

The request to generate a report.

Instance Attribute Summary collapse

Instance Attribute Details

#cohort_spec ⇒ ::Google::Analytics::Data::V1alpha::CohortSpec

Returns Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#currency_code ⇒ ::String

Returns A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity'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 entity's default currency.



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date_ranges ⇒ ::Array<::Google::Analytics::Data::V1alpha::DateRange>

Returns 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::V1alpha::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.



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimension_filter ⇒ ::Google::Analytics::Data::V1alpha::FilterExpression

Returns The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimensions ⇒ ::Array<::Google::Analytics::Data::V1alpha::Dimension>

Returns The dimensions requested and displayed.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entity ⇒ ::Google::Analytics::Data::V1alpha::Entity

Returns A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#keep_empty_rows ⇒ ::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.



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#limit ⇒ ::Integer

Returns The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

To learn more about this pagination parameter, see Pagination.

Returns:

  • (::Integer) —

    The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.

    To learn more about this pagination parameter, see Pagination.



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metric_aggregations ⇒ ::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>

Returns Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metric_filter ⇒ ::Google::Analytics::Data::V1alpha::FilterExpression

Returns The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metrics ⇒ ::Array<::Google::Analytics::Data::V1alpha::Metric>

Returns The metrics requested and displayed.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#offset ⇒ ::Integer

Returns The row count of the start row. The first row is counted as row 0.

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.

    To learn more about this pagination parameter, see Pagination.



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_bys ⇒ ::Array<::Google::Analytics::Data::V1alpha::OrderBy>

Returns Specifies how rows are ordered in the response.

Returns:



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#return_property_quota ⇒ ::Boolean

Returns 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.



103
104
105
106
 
# File 'proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb', line 103

class RunReportRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end