Class: Google::Analytics::Admin::V1alpha::RunAccessReportRequest

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

Overview

The request for a Data Access Record Report.

Instance Attribute Summary collapse

Instance Attribute Details

#date_ranges ⇒ ::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange>

Returns Date ranges of access records 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 access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.

Returns:

  • (::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange>) —

    Date ranges of access records 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 access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#dimension_filter ⇒ ::Google::Analytics::Admin::V1alpha::AccessFilterExpression

Returns Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

Returns:



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#dimensions ⇒ ::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>

Returns The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

Returns:



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#entity ⇒ ::String

Returns The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.

Returns:

  • (::String) —

    The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.

    To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#expand_groups ⇒ ::Boolean

Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.

Returns:

  • (::Boolean) —

    Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#include_all_users ⇒ ::Boolean

Returns Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.

Returns:

  • (::Boolean) —

    Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#limit ⇒ ::Integer

Returns 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 may return fewer rows than the requested limit, if there aren't as many remaining rows 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 may return fewer rows than the requested limit, if there aren't as many remaining rows 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.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#metric_filter ⇒ ::Google::Analytics::Admin::V1alpha::AccessFilterExpression

Returns Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

Returns:

  • (::Google::Analytics::Admin::V1alpha::AccessFilterExpression) —

    Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#metrics ⇒ ::Array<::Google::Analytics::Admin::V1alpha::AccessMetric>

Returns The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

Returns:



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

class RunAccessReportRequest
  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. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries.

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. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries.

    To learn more about this pagination parameter, see Pagination.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#order_bys ⇒ ::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy>

Returns Specifies how rows are ordered in the response.

Returns:



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#return_entity_quota ⇒ ::Boolean

Returns Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

Returns:

  • (::Boolean) —

    Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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

#time_zone ⇒ ::String

Returns This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report.

Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

Returns:

  • (::String) —

    This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report.

    Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".



115
116
117
118
 
# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 115

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