google-analytics-data-v1alpha 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a4a35fe96d97d0e55469823d63d565fad0d23c91ec695e4900dd026dac33c2
-  data.tar.gz: 4fb8b75aa1d11f18617f9667010111ac548a77cd304e1d9e4522e9f3e395138d
+  metadata.gz: 0df7ce139a07a0a04c8ab6eac58e9a9133854397c3341ffd7c4d92e72cc51a44
+  data.tar.gz: 1ae183bfc5af5c2860c392225a0730fc7b7e639b8c4e988f64ab149605b93c32
 SHA512:
-  metadata.gz: 88e10c1f978a46c7e3417bc54941af2a6dc1d8c04b01ec296dc0b868f01b606dfa7c37206a2ce71a12051364c43650e78e47e7863042d88552ccf375a0683771
-  data.tar.gz: ae84293ce9806270947f602b06f98b16cfae7435ad075a7672ef7de96e111cda55793e309971c7c79c5a4bb9e2aad2af593625f59691d4356b31f7e3d37a1ccc
+  metadata.gz: a4ddb36c9b77fa122d64ad7ee2f8dad8c417fded8388d3baf6fb53f442e136d4670d94483677acc070ba291bd16f3fbf0a1e0b137222be13c857d7d1208324f9
+  data.tar.gz: de5acb5b7ea89b169969ad9cbc0e49c0a6dfa8002ae25834bbe8a135a73ff976c8288d3b3765643df8408ce1c7478653fb2e6928389ee74c46a31343c75cd4d6

data/lib/google/analytics/data/v1alpha/analytics_data/client.rb

@@ -201,13 +201,13 @@ module Google
             #     The row count of the start row. The first row is counted as row 0.
             #
             #     To learn more about this pagination parameter, see
-            #     [Pagination](basics#pagination).
+            #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
             #   @param limit [::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](basics#pagination).
+            #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
             #   @param metric_aggregations [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
             #     Aggregation of metrics. Aggregated metric values will be shown in rows
             #     where the dimension_values are set to "RESERVED_(MetricAggregation)".
@@ -540,7 +540,7 @@ module Google
             #     specified in the URL path and not URL parameters. Property is a numeric
             #     Google Analytics GA4 Property identifier. 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).
             #
             #     Example: properties/1234/metadata
             #
@@ -617,7 +617,7 @@ module Google
             #     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](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
+            #     ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
             #
             #     Example: properties/1234
             #   @param dimensions [::Array<::Google::Analytics::Data::V1alpha::Dimension, ::Hash>]

data/lib/google/analytics/data/v1alpha/data_pb.rb

@@ -137,9 +137,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :dimension, :string, 2
       optional :date_range, :message, 3, "google.analytics.data.v1alpha.DateRange"
     end
-    add_message "google.analytics.data.v1alpha.CohortReportSettings" do
-      optional :accumulate, :bool, 1
-    end
     add_message "google.analytics.data.v1alpha.CohortsRange" do
       optional :granularity, :enum, 1, "google.analytics.data.v1alpha.CohortsRange.Granularity"
       optional :start_offset, :int32, 2
@@ -151,6 +148,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :WEEKLY, 2
       value :MONTHLY, 3
     end
+    add_message "google.analytics.data.v1alpha.CohortReportSettings" do
+      optional :accumulate, :bool, 1
+    end
     add_message "google.analytics.data.v1alpha.ResponseMetaData" do
       optional :data_loss_from_other_row, :bool, 3
     end
@@ -203,6 +203,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :ui_name, :string, 2
       optional :description, :string, 3
       repeated :deprecated_api_names, :string, 4
+      optional :custom_definition, :bool, 5
     end
     add_message "google.analytics.data.v1alpha.MetricMetadata" do
       optional :api_name, :string, 1
@@ -211,6 +212,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :deprecated_api_names, :string, 4
       optional :type, :enum, 5, "google.analytics.data.v1alpha.MetricType"
       optional :expression, :string, 6
+      optional :custom_definition, :bool, 7
     end
     add_enum "google.analytics.data.v1alpha.MetricAggregation" do
       value :METRIC_AGGREGATION_UNSPECIFIED, 0
@@ -266,9 +268,9 @@ module Google
         Pivot = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.Pivot").msgclass
         CohortSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortSpec").msgclass
         Cohort = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.Cohort").msgclass
-        CohortReportSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortReportSettings").msgclass
         CohortsRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortsRange").msgclass
         CohortsRange::Granularity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortsRange.Granularity").enummodule
+        CohortReportSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.CohortReportSettings").msgclass
         ResponseMetaData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.ResponseMetaData").msgclass
         DimensionHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.DimensionHeader").msgclass
         MetricHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.MetricHeader").msgclass

data/lib/google/analytics/data/v1alpha/version.rb

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1alpha
-        VERSION = "0.5.0"
+        VERSION = "0.6.0"
       end
     end
   end

data/proto_docs/google/analytics/data/v1alpha/analytics_data_api.rb

@@ -59,14 +59,14 @@ module Google
         #     The row count of the start row. The first row is counted as row 0.
         #
         #     To learn more about this pagination parameter, see
-        #     [Pagination](basics#pagination).
+        #     [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 rows are returned. If
         #     -1, all rows are returned.
         #
         #     To learn more about this pagination parameter, see
-        #     [Pagination](basics#pagination).
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
         # @!attribute [rw] metric_aggregations
         #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
         #     Aggregation of metrics. Aggregated metric values will be shown in rows
@@ -134,7 +134,7 @@ module Google
         #     = 175 but only 50 rows.
         #
         #     To learn more about this pagination parameter, see
-        #     [Pagination](basics#pagination).
+        #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
         # @!attribute [rw] metadata
         #   @return [::Google::Analytics::Data::V1alpha::ResponseMetaData]
         #     Metadata for the report.
@@ -326,7 +326,7 @@ module Google
         #     specified in the URL path and not URL parameters. Property is a numeric
         #     Google Analytics GA4 Property identifier. 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).
         #
         #     Example: properties/1234/metadata
         #
@@ -344,7 +344,7 @@ module Google
         #     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](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
+        #     ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
         #
         #     Example: properties/1234
         # @!attribute [rw] dimensions

data/proto_docs/google/analytics/data/v1alpha/data.rb

@@ -51,7 +51,7 @@ module Google
         #   @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
@@ -64,7 +64,7 @@ module Google
         # @!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
@@ -136,7 +136,7 @@ module Google
         # @!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.
@@ -447,23 +447,38 @@ module Google
           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]
@@ -473,69 +488,100 @@ module Google
         #     `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]
@@ -734,6 +780,9 @@ module Google
         #     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
@@ -765,6 +814,9 @@ module Google
         #     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-data-v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common