proto_docs/google/analytics/data/v1alpha/data.rb in google-analytics-data-v1alpha-0.5.0 vs proto_docs/google/analytics/data/v1alpha/data.rb in google-analytics-data-v1alpha-0.6.0
- old
+ new
@@ -49,11 +49,11 @@
# The unique identifier of the property whose events are tracked.
# @!attribute [rw] property_id
# @return [::String]
# A Google Analytics GA4 property id. To learn more, see [where to find your
# Property
- # ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
+ # ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
class Entity
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
@@ -62,11 +62,11 @@
# responses are strings; for example, city could be "Paris" or "New York".
# Requests are allowed up to 8 dimensions.
# @!attribute [rw] name
# @return [::String]
# The name of the dimension. See the [API
- # Dimensions](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#dimensions)
+ # Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
# for the list of dimension names.
#
# If `dimensionExpression` is specified, `name` can be any string that you
# would like. For example if a `dimensionExpression` concatenates `country`
# and `city`, you could call that dimension `countryAndCity`.
@@ -134,11 +134,11 @@
# `eventCount` is the total number of events. Requests are allowed up to 10
# metrics.
# @!attribute [rw] name
# @return [::String]
# The name of the metric. See the [API
- # Metrics](https://developers.google.com/analytics/trusted-testing/analytics-data/api-schema#metrics)
+ # Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
# for the list of metric names.
#
# If `expression` is specified, `name` can be any string that you would like.
# For example if `expression` is `screenPageViews/sessions`, you could call
# that metric's name = `viewsPerSession`.
@@ -445,99 +445,145 @@
class Pivot
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
- # Specification for a cohort report.
+ # Specification of cohorts for a cohort report.
+ # Cohort reports can be used for example to create a time series of user
+ # retention for the cohort. For example, you could select the cohort of users
+ # that were acquired in the first week of September and follow that cohort for
+ # the next six weeks. Selecting the users acquired in the first week of
+ # September cohort is specified in the `cohort` object. Following that
+ # cohort for the next six weeks is specified in the `cohortsRange` object.
+ #
+ # The report response could show a weekly time series where say your app has
+ # retained 60% of this cohort after three weeks and 25% of this cohort after
+ # six weeks. These two percentages can be calculated by the metric
+ # `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.
# @!attribute [rw] cohorts
# @return [::Array<::Google::Analytics::Data::V1alpha::Cohort>]
- # The definition for the cohorts.
+ # Defines the selection criteria to group users into cohorts.
+ #
+ # Most cohort reports define only a single cohort. If multiple cohorts are
+ # specified, each cohort can be recognized in the report by their name.
# @!attribute [rw] cohorts_range
# @return [::Google::Analytics::Data::V1alpha::CohortsRange]
- # The data ranges of cohorts.
+ # Cohort reports follow cohorts over an extended reporting date range. This
+ # range specifies an offset duration to follow the cohorts over.
# @!attribute [rw] cohort_report_settings
# @return [::Google::Analytics::Data::V1alpha::CohortReportSettings]
- # Settings of a cohort report.
+ # Optional settings for a cohort report.
class CohortSpec
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
- # Defines a cohort. A cohort is a group of users who share a common
- # characteristic. For example, all users with the same acquisition date
+ # Defines a cohort selection criteria. A cohort is a group of users who share
+ # a common characteristic. For example, users with the same `firstTouchDate`
# belong to the same cohort.
# @!attribute [rw] name
# @return [::String]
# Assigns a name to this cohort. The dimension `cohort` is valued to this
# name in a report response. If set, cannot begin with `cohort_` or
# `RESERVED_`. If not set, cohorts are named by their zero based index
# `cohort_0`, `cohort_1`, etc.
# @!attribute [rw] dimension
# @return [::String]
- # The dimension used by cohort. Only supports `firstTouchDate` for retention
- # report.
+ # Dimension used by the cohort. Required and only supports `firstTouchDate`.
# @!attribute [rw] date_range
# @return [::Google::Analytics::Data::V1alpha::DateRange]
- # The cohort selects users whose first visit date is between start date
- # and end date defined in the `dateRange`. In a cohort request, this
- # `dateRange` is required and the `dateRanges` in the `RunReportRequest` or
- # `RunPivotReportRequest` must be unspecified.
+ # The cohort selects users whose first touch date is between start date and
+ # end date defined in the `dateRange`. This `dateRange` does not specify the
+ # full date range of event data that is present in a cohort report. In a
+ # cohort report, this `dateRange` is extended by the granularity and offset
+ # present in the `cohortsRange`; event data for the extended reporting date
+ # range is present in a cohort report.
#
- # The date range should be aligned with the cohort's granularity. If
- # CohortsRange uses daily granularity, the date range can be aligned to any
- # day. If CohortsRange uses weekly granularity, the date range should be
- # aligned to the week boundary, starting at Sunday and ending Saturday. If
- # CohortsRange uses monthly granularity, the date range should be aligned to
- # the month, starting at the first and ending on the last day of the month.
+ # In a cohort request, this `dateRange` is required and the `dateRanges` in
+ # the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
+ #
+ # This `dateRange` should generally be aligned with the cohort's granularity.
+ # If `CohortsRange` uses daily granularity, this `dateRange` can be a single
+ # day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
+ # aligned to a week boundary, starting at Sunday and ending Saturday. If
+ # `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
+ # a month, starting at the first and ending on the last day of the month.
class Cohort
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
- # Settings of a cohort report.
- # @!attribute [rw] accumulate
- # @return [::Boolean]
- # If true, accumulates the result from first visit day to the end day. Not
- # supported in `RunReportRequest`.
- class CohortReportSettings
- include ::Google::Protobuf::MessageExts
- extend ::Google::Protobuf::MessageExts::ClassMethods
- end
-
- # Describes date range for a cohort report.
+ # Configures the extended reporting date range for a cohort report. Specifies
+ # an offset duration to follow the cohorts over.
# @!attribute [rw] granularity
# @return [::Google::Analytics::Data::V1alpha::CohortsRange::Granularity]
- # Reporting date range for each cohort is calculated based on these three
- # fields.
+ # The granularity used to interpret the `startOffset` and `endOffset` for the
+ # extended reporting date range for a cohort report.
# @!attribute [rw] start_offset
# @return [::Integer]
- # For daily cohorts, this will be the start day offset.
- # For weekly cohorts, this will be the week offset.
+ # `startOffset` specifies the start date of the extended reporting date range
+ # for a cohort report. `startOffset` is commonly set to 0 so that reports
+ # contain data from the acquisition of the cohort forward.
+ #
+ # If `granularity` is `DAILY`, the `startDate` of the extended reporting date
+ # range is `startDate` of the cohort plus `startOffset` days.
+ #
+ # If `granularity` is `WEEKLY`, the `startDate` of the extended reporting
+ # date range is `startDate` of the cohort plus `startOffset * 7` days.
+ #
+ # If `granularity` is `MONTHLY`, the `startDate` of the extended reporting
+ # date range is `startDate` of the cohort plus `startOffset * 30` days.
# @!attribute [rw] end_offset
# @return [::Integer]
- # For daily cohorts, this will be the end day offset.
- # For weekly cohorts, this will be the week offset.
+ # `endOffset` specifies the end date of the extended reporting date range
+ # for a cohort report. `endOffset` can be any positive integer but is
+ # commonly set to 5 to 10 so that reports contain data on the cohort for the
+ # next several granularity time periods.
+ #
+ # If `granularity` is `DAILY`, the `endDate` of the extended reporting date
+ # range is `endDate` of the cohort plus `endOffset` days.
+ #
+ # If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date
+ # range is `endDate` of the cohort plus `endOffset * 7` days.
+ #
+ # If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date
+ # range is `endDate` of the cohort plus `endOffset * 30` days.
class CohortsRange
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
- # Reporting granularity for the cohorts.
+ # The granularity used to interpret the `startOffset` and `endOffset` for the
+ # extended reporting date range for a cohort report.
module Granularity
- # Unspecified.
+ # Should never be specified.
GRANULARITY_UNSPECIFIED = 0
- # Daily
+ # Daily granularity. Commonly used if the cohort's `dateRange` is a single
+ # day and the request contains `cohortNthDay`.
DAILY = 1
- # Weekly
+ # Weekly granularity. Commonly used if the cohort's `dateRange` is a week
+ # in duration (starting on Sunday and ending on Saturday) and the request
+ # contains `cohortNthWeek`.
WEEKLY = 2
- # Monthly
+ # Monthly granularity. Commonly used if the cohort's `dateRange` is a month
+ # in duration and the request contains `cohortNthMonth`.
MONTHLY = 3
end
end
+ # Optional settings of a cohort report.
+ # @!attribute [rw] accumulate
+ # @return [::Boolean]
+ # If true, accumulates the result from first touch day to the end day. Not
+ # supported in `RunReportRequest`.
+ class CohortReportSettings
+ include ::Google::Protobuf::MessageExts
+ extend ::Google::Protobuf::MessageExts::ClassMethods
+ end
+
# Response's metadata carrying additional information about the report content.
# @!attribute [rw] data_loss_from_other_row
# @return [::Boolean]
# If true, indicates some buckets of dimension combinations are rolled into
# "(other)" row. This can happen for high cardinality reports.
@@ -732,10 +778,13 @@
# @return [::Array<::String>]
# Still usable but deprecated names for this dimension. If populated, this
# dimension is available by either `apiName` or one of `deprecatedApiNames`
# for a period of time. After the deprecation period, the dimension will be
# available only by `apiName`.
+ # @!attribute [rw] custom_definition
+ # @return [::Boolean]
+ # True if the dimension is a custom dimension for this property.
class DimensionMetadata
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
@@ -763,9 +812,12 @@
# @!attribute [rw] expression
# @return [::String]
# The mathematical expression for this derived metric. Can be used in
# [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
# are not expressions, and for non-expressions, this field is empty.
+ # @!attribute [rw] custom_definition
+ # @return [::Boolean]
+ # True if the metric is a custom metric for this property.
class MetricMetadata
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end