google-api-client 0.46.2 → 0.51.0

data/generated/google/apis/analyticsdata_v1alpha.rb

@@ -22,10 +22,10 @@ module Google
     #
     # Accesses report data in Google Analytics.
     #
-    # @see https://developers.google.com/analytics/trusted-testing/analytics-data/
+    # @see https://developers.google.com/analytics/devguides/reporting/data/v1/
     module AnalyticsdataV1alpha
       VERSION = 'V1alpha'
-      REVISION = '20201013'
+      REVISION = '20201201'
 
       # View and manage your Google Analytics data
       AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'

data/generated/google/apis/analyticsdata_v1alpha/classes.rb

@@ -157,21 +157,19 @@ module Google
         end
       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 belong
-      # to the same cohort.
+      # 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.
       class Cohort
         include Google::Apis::Core::Hashable
       
         # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are
-        # allowed up to 4 date ranges, and the union of the ranges can cover up to 1
-        # year.
+        # allowed up to 4 date ranges.
         # Corresponds to the JSON property `dateRange`
         # @return [Google::Apis::AnalyticsdataV1alpha::DateRange]
         attr_accessor :date_range
       
-        # The dimension used by cohort. Only supports `firstTouchDate` for retention
-        # report.
+        # Dimension used by the cohort. Required and only supports `firstTouchDate`.
         # Corresponds to the JSON property `dimension`
         # @return [String]
         attr_accessor :dimension
@@ -196,11 +194,11 @@ module Google
         end
       end
       
-      # Settings of a cohort report.
+      # Optional settings of a cohort report.
       class CohortReportSettings
         include Google::Apis::Core::Hashable
       
-        # If true, accumulates the result from first visit day to the end day. Not
+        # If true, accumulates the result from first touch day to the end day. Not
         # supported in `RunReportRequest`.
         # Corresponds to the JSON property `accumulate`
         # @return [Boolean]
@@ -217,21 +215,34 @@ module Google
         end
       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.
       class CohortSpec
         include Google::Apis::Core::Hashable
       
-        # Settings of a cohort report.
+        # Optional settings of a cohort report.
         # Corresponds to the JSON property `cohortReportSettings`
         # @return [Google::Apis::AnalyticsdataV1alpha::CohortReportSettings]
         attr_accessor :cohort_report_settings
       
-        # 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.
         # Corresponds to the JSON property `cohorts`
         # @return [Array<Google::Apis::AnalyticsdataV1alpha::Cohort>]
         attr_accessor :cohorts
       
-        # 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.
         # Corresponds to the JSON property `cohortsRange`
         # @return [Google::Apis::AnalyticsdataV1alpha::CohortsRange]
         attr_accessor :cohorts_range
@@ -248,23 +259,39 @@ module Google
         end
       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.
       class CohortsRange
         include Google::Apis::Core::Hashable
       
-        # 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.
         # Corresponds to the JSON property `endOffset`
         # @return [Fixnum]
         attr_accessor :end_offset
       
-        # 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.
         # Corresponds to the JSON property `granularity`
         # @return [String]
         attr_accessor :granularity
       
-        # 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.
         # Corresponds to the JSON property `startOffset`
         # @return [Fixnum]
         attr_accessor :start_offset
@@ -312,8 +339,7 @@ module Google
       end
       
       # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are
-      # allowed up to 4 date ranges, and the union of the ranges can cover up to 1
-      # year.
+      # allowed up to 4 date ranges.
       class DateRange
         include Google::Apis::Core::Hashable
       
@@ -353,9 +379,10 @@ module Google
         end
       end
       
-      # Dimensions are attributes of your data. For example, the dimension City
-      # indicates the city, for example, "Paris" or "New York", from which an event
-      # originates. Requests are allowed up to 8 dimensions.
+      # Dimensions are attributes of your data. For example, the dimension city
+      # indicates the city from which an event originates. Dimension values in report
+      # responses are strings; for example, city could be "Paris" or "New York".
+      # Requests are allowed up to 8 dimensions.
       class Dimension
         include Google::Apis::Core::Hashable
       
@@ -366,7 +393,13 @@ module Google
         # @return [Google::Apis::AnalyticsdataV1alpha::DimensionExpression]
         attr_accessor :dimension_expression
       
-        # The name of the dimension.
+        # The name of the dimension. See the [API 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`. Dimensions are referenced by `name` in `dimensionFilter`, `
+        # orderBys`, `dimensionExpression`, and `pivots`.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -447,6 +480,12 @@ module Google
         # @return [String]
         attr_accessor :api_name
       
+        # True if the dimension is a custom dimension for this property.
+        # Corresponds to the JSON property `customDefinition`
+        # @return [Boolean]
+        attr_accessor :custom_definition
+        alias_method :custom_definition?, :custom_definition
+      
         # 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
@@ -473,6 +512,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @api_name = args[:api_name] if args.key?(:api_name)
+          @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
           @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
           @description = args[:description] if args.key?(:description)
           @ui_name = args[:ui_name] if args.key?(:ui_name)
@@ -527,7 +567,9 @@ module Google
       class Entity
         include Google::Apis::Core::Hashable
       
-        # A Google Analytics GA4 property id.
+        # A Google Analytics GA4 property id. To learn more, see [where to find your
+        # Property ID](https://developers.google.com/analytics/devguides/reporting/data/
+        # v1/property-id).
         # Corresponds to the JSON property `propertyId`
         # @return [String]
         attr_accessor :property_id
@@ -562,7 +604,10 @@ module Google
         # @return [Google::Apis::AnalyticsdataV1alpha::InListFilter]
         attr_accessor :in_list_filter
       
-        # A filter for null values.
+        # A filter for null values. If True, a null dimension value is matched by this
+        # filter. Null filter is commonly used inside a NOT filter expression. For
+        # example, a NOT expression of a null filter removes rows when a dimension is
+        # null.
         # Corresponds to the JSON property `nullFilter`
         # @return [Boolean]
         attr_accessor :null_filter
@@ -681,7 +726,7 @@ module Google
       class Metadata
         include Google::Apis::Core::Hashable
       
-        # The dimensions descriptions.
+        # The dimension descriptions.
         # Corresponds to the JSON property `dimensions`
         # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionMetadata>]
         attr_accessor :dimensions
@@ -708,26 +753,31 @@ module Google
         end
       end
       
-      # The quantitative measurements of a report. For example, the metric eventCount
+      # The quantitative measurements of a report. For example, the metric `eventCount`
       # is the total number of events. Requests are allowed up to 10 metrics.
       class Metric
         include Google::Apis::Core::Hashable
       
         # A mathematical expression for derived metrics. For example, the metric Event
-        # count per user is eventCount/totalUsers.
+        # count per user is `eventCount/totalUsers`.
         # Corresponds to the JSON property `expression`
         # @return [String]
         attr_accessor :expression
       
-        # Indicates if a metric is invisible. If a metric is invisible, the metric is
-        # not in the response, but can be used in filters, order_bys or being referred
-        # to in a metric expression.
+        # Indicates if a metric is invisible in the report response. If a metric is
+        # invisible, the metric will not produce a column in the response, but can be
+        # used in `metricFilter`, `orderBys`, or a metric `expression`.
         # Corresponds to the JSON property `invisible`
         # @return [Boolean]
         attr_accessor :invisible
         alias_method :invisible?, :invisible
       
-        # The name of the metric.
+        # The name of the metric. See the [API 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`. Metrics are referenced by `
+        # name` in `metricFilter`, `orderBys`, and metric `expression`.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -782,6 +832,12 @@ module Google
         # @return [String]
         attr_accessor :api_name
       
+        # True if the metric is a custom metric for this property.
+        # Corresponds to the JSON property `customDefinition`
+        # @return [Boolean]
+        attr_accessor :custom_definition
+        alias_method :custom_definition?, :custom_definition
+      
         # Still usable but deprecated names for this metric. If populated, this metric
         # is available by either `apiName` or one of `deprecatedApiNames` for a period
         # of time. After the deprecation period, the metric will be available only by `
@@ -820,6 +876,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @api_name = args[:api_name] if args.key?(:api_name)
+          @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
           @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
           @description = args[:description] if args.key?(:description)
           @expression = args[:expression] if args.key?(:expression)
@@ -1199,11 +1256,12 @@ module Google
         end
       end
       
-      # Report data for each row. For example if RunReportRequest contains: ```none
-      # dimensions ` name: "eventName" ` dimensions ` name: "countryId" ` metrics `
-      # name: "eventCount" ` ``` One row with 'in_app_purchase' as the eventName, 'us'
-      # as the countryId, and 15 as the eventCount, would be: ```none dimension_values
-      # ` name: 'in_app_purchase' name: 'us' ` metric_values ` int64_value: 15 ` ```
+      # Report data for each row. For example if RunReportRequest contains: ```none "
+      # dimensions": [ ` "name": "eventName" `, ` "name": "countryId" ` ], "metrics": [
+      # ` "name": "eventCount" ` ] ``` One row with 'in_app_purchase' as the
+      # eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "
+      # dimensionValues": [ ` "value": "in_app_purchase" `, ` "value": "JP" ` ], "
+      # metricValues": [ ` "value": "15" ` ] ```
       class Row
         include Google::Apis::Core::Hashable
       
@@ -1233,7 +1291,17 @@ module Google
       class RunPivotReportRequest
         include Google::Apis::Core::Hashable
       
-        # 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.
         # Corresponds to the JSON property `cohortSpec`
         # @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec]
         attr_accessor :cohort_spec
@@ -1395,11 +1463,156 @@ module Google
         end
       end
       
+      # The request to generate a realtime report.
+      class RunRealtimeReportRequest
+        include Google::Apis::Core::Hashable
+      
+        # To express dimension or metric filters. The fields in the same
+        # FilterExpression need to be either all dimensions or all metrics.
+        # Corresponds to the JSON property `dimensionFilter`
+        # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
+        attr_accessor :dimension_filter
+      
+        # The dimensions requested and displayed.
+        # Corresponds to the JSON property `dimensions`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::Dimension>]
+        attr_accessor :dimensions
+      
+        # The number of rows to return. If unspecified, 10 rows are returned. If -1, all
+        # rows are returned.
+        # Corresponds to the JSON property `limit`
+        # @return [Fixnum]
+        attr_accessor :limit
+      
+        # Aggregation of metrics. Aggregated metric values will be shown in rows where
+        # the dimension_values are set to "RESERVED_(MetricAggregation)".
+        # Corresponds to the JSON property `metricAggregations`
+        # @return [Array<String>]
+        attr_accessor :metric_aggregations
+      
+        # To express dimension or metric filters. The fields in the same
+        # FilterExpression need to be either all dimensions or all metrics.
+        # Corresponds to the JSON property `metricFilter`
+        # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression]
+        attr_accessor :metric_filter
+      
+        # The metrics requested and displayed.
+        # Corresponds to the JSON property `metrics`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::Metric>]
+        attr_accessor :metrics
+      
+        # Specifies how rows are ordered in the response.
+        # Corresponds to the JSON property `orderBys`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::OrderBy>]
+        attr_accessor :order_bys
+      
+        # Toggles whether to return the current state of this Analytics Property's
+        # Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+        # Corresponds to the JSON property `returnPropertyQuota`
+        # @return [Boolean]
+        attr_accessor :return_property_quota
+        alias_method :return_property_quota?, :return_property_quota
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter)
+          @dimensions = args[:dimensions] if args.key?(:dimensions)
+          @limit = args[:limit] if args.key?(:limit)
+          @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations)
+          @metric_filter = args[:metric_filter] if args.key?(:metric_filter)
+          @metrics = args[:metrics] if args.key?(:metrics)
+          @order_bys = args[:order_bys] if args.key?(:order_bys)
+          @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota)
+        end
+      end
+      
+      # The response realtime report table corresponding to a request.
+      class RunRealtimeReportResponse
+        include Google::Apis::Core::Hashable
+      
+        # Describes dimension columns. The number of DimensionHeaders and ordering of
+        # DimensionHeaders matches the dimensions present in rows.
+        # Corresponds to the JSON property `dimensionHeaders`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionHeader>]
+        attr_accessor :dimension_headers
+      
+        # If requested, the maximum values of metrics.
+        # Corresponds to the JSON property `maximums`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
+        attr_accessor :maximums
+      
+        # Describes metric columns. The number of MetricHeaders and ordering of
+        # MetricHeaders matches the metrics present in rows.
+        # Corresponds to the JSON property `metricHeaders`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::MetricHeader>]
+        attr_accessor :metric_headers
+      
+        # If requested, the minimum values of metrics.
+        # Corresponds to the JSON property `minimums`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
+        attr_accessor :minimums
+      
+        # Current state of all quotas for this Analytics Property. If any quota for a
+        # property is exhausted, all requests to that property will return Resource
+        # Exhausted errors.
+        # Corresponds to the JSON property `propertyQuota`
+        # @return [Google::Apis::AnalyticsdataV1alpha::PropertyQuota]
+        attr_accessor :property_quota
+      
+        # The total number of rows in the query result, regardless of the number of rows
+        # returned in the response. For example if a query returns 175 rows and includes
+        # limit = 50 in the API request, the response will contain row_count = 175 but
+        # only 50 rows.
+        # Corresponds to the JSON property `rowCount`
+        # @return [Fixnum]
+        attr_accessor :row_count
+      
+        # Rows of dimension value combinations and metric values in the report.
+        # Corresponds to the JSON property `rows`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
+        attr_accessor :rows
+      
+        # If requested, the totaled values of metrics.
+        # Corresponds to the JSON property `totals`
+        # @return [Array<Google::Apis::AnalyticsdataV1alpha::Row>]
+        attr_accessor :totals
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers)
+          @maximums = args[:maximums] if args.key?(:maximums)
+          @metric_headers = args[:metric_headers] if args.key?(:metric_headers)
+          @minimums = args[:minimums] if args.key?(:minimums)
+          @property_quota = args[:property_quota] if args.key?(:property_quota)
+          @row_count = args[:row_count] if args.key?(:row_count)
+          @rows = args[:rows] if args.key?(:rows)
+          @totals = args[:totals] if args.key?(:totals)
+        end
+      end
+      
       # The request to generate a report.
       class RunReportRequest
         include Google::Apis::Core::Hashable
       
-        # 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.
         # Corresponds to the JSON property `cohortSpec`
         # @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec]
         attr_accessor :cohort_spec
@@ -1444,7 +1657,9 @@ module Google
         alias_method :keep_empty_rows?, :keep_empty_rows
       
         # The number of rows to return. If unspecified, 10 rows are returned. If -1, all
-        # rows are returned.
+        # rows are returned. To learn more about this pagination parameter, see [
+        # Pagination](https://developers.google.com/analytics/devguides/reporting/data/
+        # v1/basics#pagination).
         # Corresponds to the JSON property `limit`
         # @return [Fixnum]
         attr_accessor :limit
@@ -1466,7 +1681,9 @@ module Google
         # @return [Array<Google::Apis::AnalyticsdataV1alpha::Metric>]
         attr_accessor :metrics
       
-        # The row count of the start row. The first row is counted as row 0.
+        # The row count of the start row. The first row is counted as row 0. To learn
+        # more about this pagination parameter, see [Pagination](https://developers.
+        # google.com/analytics/devguides/reporting/data/v1/basics#pagination).
         # Corresponds to the JSON property `offset`
         # @return [Fixnum]
         attr_accessor :offset
@@ -1547,7 +1764,9 @@ module Google
         # The total number of rows in the query result, regardless of the number of rows
         # returned in the response. For example if a query returns 175 rows and includes
         # limit = 50 in the API request, the response will contain row_count = 175 but
-        # only 50 rows.
+        # only 50 rows. To learn more about this pagination parameter, see [Pagination](
+        # https://developers.google.com/analytics/devguides/reporting/data/v1/basics#
+        # pagination).
         # Corresponds to the JSON property `rowCount`
         # @return [Fixnum]
         attr_accessor :row_count
@@ -1611,31 +1830,6 @@ module Google
           @value = args[:value] if args.key?(:value)
         end
       end
-      
-      # The dimensions and metrics currently accepted in reporting methods.
-      class UniversalMetadata
-        include Google::Apis::Core::Hashable
-      
-        # The dimensions descriptions.
-        # Corresponds to the JSON property `dimensions`
-        # @return [Array<Google::Apis::AnalyticsdataV1alpha::DimensionMetadata>]
-        attr_accessor :dimensions
-      
-        # The metric descriptions.
-        # Corresponds to the JSON property `metrics`
-        # @return [Array<Google::Apis::AnalyticsdataV1alpha::MetricMetadata>]
-        attr_accessor :metrics
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @dimensions = args[:dimensions] if args.key?(:dimensions)
-          @metrics = args[:metrics] if args.key?(:metrics)
-        end
-      end
     end
   end
 end