proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb in google-analytics-admin-v1alpha-0.12.0 vs proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb in google-analytics-admin-v1alpha-0.13.0
- old
+ new
@@ -19,10 +19,119 @@
module Google
module Analytics
module Admin
module V1alpha
+ # The request for a Data Access Record Report.
+ # @!attribute [rw] entity
+ # @return [::String]
+ # The Data Access Report is requested for this property.
+ # For example if "123" is your GA4 property ID, then entity should be
+ # "properties/123".
+ # @!attribute [rw] dimensions
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension>]
+ # The dimensions requested and displayed in the response. Requests are
+ # allowed up to 9 dimensions.
+ # @!attribute [rw] metrics
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetric>]
+ # The metrics requested and displayed in the response. Requests are allowed
+ # up to 10 metrics.
+ # @!attribute [rw] date_ranges
+ # @return [::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.
+ # @!attribute [rw] dimension_filter
+ # @return [::Google::Analytics::Admin::V1alpha::AccessFilterExpression]
+ # Dimension filters allow you to 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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
+ # for examples. Metrics cannot be used in this filter.
+ # @!attribute [rw] metric_filter
+ # @return [::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.
+ # @!attribute [rw] offset
+ # @return [::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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ # @!attribute [rw] limit
+ # @return [::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](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ # @!attribute [rw] time_zone
+ # @return [::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".
+ # @!attribute [rw] order_bys
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy>]
+ # Specifies how rows are ordered in the response.
+ # @!attribute [rw] return_entity_quota
+ # @return [::Boolean]
+ # Toggles whether to return the current state of this Analytics Property's
+ # quota. Quota is returned in [AccessQuota](#AccessQuota).
+ class RunAccessReportRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # The customized Data Access Record Report response.
+ # @!attribute [rw] dimension_headers
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessDimensionHeader>]
+ # The header for a column in the report that corresponds to a specific
+ # dimension. The number of DimensionHeaders and ordering of DimensionHeaders
+ # matches the dimensions present in rows.
+ # @!attribute [rw] metric_headers
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessMetricHeader>]
+ # The header for a column in the report that corresponds to a specific
+ # metric. The number of MetricHeaders and ordering of MetricHeaders matches
+ # the metrics present in rows.
+ # @!attribute [rw] rows
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::AccessRow>]
+ # Rows of dimension value combinations and metric values in the report.
+ # @!attribute [rw] row_count
+ # @return [::Integer]
+ # The total number of rows in the query result. `rowCount` is independent of
+ # the number of rows returned in the response, the `limit` request
+ # parameter, and the `offset` request parameter. For example if a query
+ # returns 175 rows and includes `limit` of 50 in the API request, the
+ # response will contain `rowCount` of 175 but only 50 rows.
+ #
+ # To learn more about this pagination parameter, see
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ # @!attribute [rw] quota
+ # @return [::Google::Analytics::Admin::V1alpha::AccessQuota]
+ # The quota state for this Analytics property including this request.
+ class RunAccessReportResponse
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
# Request message for GetAccount RPC.
# @!attribute [rw] name
# @return [::String]
# Required. The name of the account to lookup.
# Format: accounts/\\{account}
@@ -1313,9 +1422,114 @@
# @!attribute [rw] name
# @return [::String]
# Required. The name of the DataStream to get.
# Example format: properties/1234/dataStreams/5678
class GetDataStreamRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for GetAudience RPC.
+ # @!attribute [rw] name
+ # @return [::String]
+ # Required. The name of the Audience to get.
+ # Example format: properties/1234/audiences/5678
+ class GetAudienceRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for ListAudiences RPC.
+ # @!attribute [rw] parent
+ # @return [::String]
+ # Required. Example format: properties/1234
+ # @!attribute [rw] page_size
+ # @return [::Integer]
+ # The maximum number of resources to return.
+ # If unspecified, at most 50 resources will be returned.
+ # The maximum value is 200 (higher values will be coerced to the maximum).
+ # @!attribute [rw] page_token
+ # @return [::String]
+ # A page token, received from a previous `ListAudiences` call. Provide this
+ # to retrieve the subsequent page.
+ #
+ # When paginating, all other parameters provided to `ListAudiences` must
+ # match the call that provided the page token.
+ class ListAudiencesRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Response message for ListAudiences RPC.
+ # @!attribute [rw] audiences
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::Audience>]
+ # List of Audiences.
+ # @!attribute [rw] next_page_token
+ # @return [::String]
+ # A token, which can be sent as `page_token` to retrieve the next page.
+ # If this field is omitted, there are no subsequent pages.
+ class ListAudiencesResponse
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for CreateAudience RPC.
+ # @!attribute [rw] parent
+ # @return [::String]
+ # Required. Example format: properties/1234
+ # @!attribute [rw] audience
+ # @return [::Google::Analytics::Admin::V1alpha::Audience]
+ # Required. The audience to create.
+ class CreateAudienceRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for UpdateAudience RPC.
+ # @!attribute [rw] audience
+ # @return [::Google::Analytics::Admin::V1alpha::Audience]
+ # Required. The audience to update.
+ # The audience's `name` field is used to identify the audience to be updated.
+ # @!attribute [rw] update_mask
+ # @return [::Google::Protobuf::FieldMask]
+ # Required. The list of fields to be updated. Field names must be in snake case
+ # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+ # the entire entity, use one path with the string "*" to match all fields.
+ class UpdateAudienceRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for ArchiveAudience RPC.
+ # @!attribute [rw] name
+ # @return [::String]
+ # Required. Example format: properties/1234/audiences/5678
+ class ArchiveAudienceRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for GetAttributionSettings RPC.
+ # @!attribute [rw] name
+ # @return [::String]
+ # Required. The name of the attribution settings to retrieve.
+ # Format: properties/\\{property}/attributionSettings
+ class GetAttributionSettingsRequest
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
+ # Request message for UpdateAttributionSettings RPC
+ # @!attribute [rw] attribution_settings
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
+ # Required. The attribution settings to update.
+ # The `name` field is used to identify the settings to be updated.
+ # @!attribute [rw] update_mask
+ # @return [::Google::Protobuf::FieldMask]
+ # Required. The list of fields to be updated. Field names must be in snake case
+ # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+ # the entire entity, use one path with the string "*" to match all fields.
+ class UpdateAttributionSettingsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
end