google-analytics-data-v1beta 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0216299e3a52f758f918d01a4e0c33ad953ea4d9a3c0fa01cbd96b3c453e3332'
-  data.tar.gz: b827ebeed2b1b11cb5ef153a45277c5b41471eb02bdf8ff3e6113332789c0f1d
+  metadata.gz: ef5116aed6f9d5fa8ca303079895797ee0a991ec330f8859868263689174b890
+  data.tar.gz: 04f1bc9a21cde97026cad035d37dda4ecbfdc0cb382e6ed25d62cd4aa3a04f22
 SHA512:
-  metadata.gz: e508d9f2536c3eea84045c0850c4a8fd4629a484915adf5fd894515453d74c3598ee18e84b1e70fc60e1cdbb22b0c93e8e8a8d4ab099f98339caab2da56bcb7c
-  data.tar.gz: 5812899ff083dd34e880c399b71125d4c4675f733e732002d1afbd47c39ab4b476bd07a4b94371fa9ea85c57372996c15dc865cf084f7e67f4317bafe32b65cc
+  metadata.gz: 803c1ac50c49e575e3cc33ee723e93a5279df0fdf34974b1b55ef63c8c6c05f524d095dc5638a6dae30c71f9c5e496de78b4d255db8c9bb9a8958aa3ecc684ed
+  data.tar.gz: a47733f2c3909f1ebeb26bdc70bde2be0b98a640b642eec1bceab762d8f33492d853cb1a4314472d194ce86cb10debc967a68a0cfe9ef03ed471846ae089edce

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Google Analytics Data V1beta API
 
-Accesses report data in Google Analytics.
+Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.
 
 The Google Analytics Data API provides programmatic methods to access report data in Google Analytics 4 (GA4) properties. Google Analytics 4 helps you understand how people use your web, iOS, or Android app.
 

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

@@ -211,7 +211,7 @@ module Google
             #     response rows for both date ranges. In a cohort request, this `dateRanges`
             #     must be unspecified.
             #   @param dimension_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
-            #     Dimension filters allow you to ask for only specific dimension values in
+            #     Dimension filters let you ask for only specific dimension values in
             #     the report. 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.
@@ -230,7 +230,7 @@ module Google
             #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
             #   @param limit [::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
+            #     API returns a maximum of 250,000 rows per request, no matter how many you
             #     ask for. `limit` must be positive.
             #
             #     The API can also return fewer rows than the requested `limit`, if there
@@ -256,6 +256,13 @@ module Google
             #     If false or unspecified, each row with all metrics equal to 0 will not be
             #     returned. If true, these rows will be returned if they are not separately
             #     removed by a filter.
+            #
+            #     Regardless of this `keep_empty_rows` setting, only data recorded by the
+            #     Google Analytics (GA4) property can be displayed in a report.
+            #
+            #     For example if a property never logs a `purchase` event, then a query for
+            #     the `eventName` dimension and  `eventCount` metric will not have a row
+            #     eventName: "purchase" and eventCount: 0.
             #   @param return_property_quota [::Boolean]
             #     Toggles whether to return the current state of this Analytics Property's
             #     quota. Quota is returned in [PropertyQuota](#PropertyQuota).
@@ -390,6 +397,13 @@ module Google
             #     If false or unspecified, each row with all metrics equal to 0 will not be
             #     returned. If true, these rows will be returned if they are not separately
             #     removed by a filter.
+            #
+            #     Regardless of this `keep_empty_rows` setting, only data recorded by the
+            #     Google Analytics (GA4) property can be displayed in a report.
+            #
+            #     For example if a property never logs a `purchase` event, then a query for
+            #     the `eventName` dimension and  `eventCount` metric will not have a row
+            #     eventName: "purchase" and eventCount: 0.
             #   @param return_property_quota [::Boolean]
             #     Toggles whether to return the current state of this Analytics Property's
             #     quota. Quota is returned in [PropertyQuota](#PropertyQuota).
@@ -800,7 +814,7 @@ module Google
             #     SQL having-clause. Dimensions cannot be used in this filter.
             #   @param limit [::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
+            #     API returns a maximum of 250,000 rows per request, no matter how many you
             #     ask for. `limit` must be positive.
             #
             #     The API can also return fewer rows than the requested `limit`, if there
@@ -921,10 +935,6 @@ module Google
             #     `property` should be the same value as in your `runReport` request.
             #
             #     Example: properties/1234
-            #
-            #     Set the Property ID to 0 for compatibility checking on dimensions and
-            #     metrics common to all properties. In this special mode, this method will
-            #     not return custom dimensions and metrics.
             #   @param dimensions [::Array<::Google::Analytics::Data::V1beta::Dimension, ::Hash>]
             #     The dimensions in this report. `dimensions` should be the same value as in
             #     your `runReport` request.

data/lib/google/analytics/data/v1beta/analytics_data/rest/client.rb

@@ -202,7 +202,7 @@ module Google
               #     response rows for both date ranges. In a cohort request, this `dateRanges`
               #     must be unspecified.
               #   @param dimension_filter [::Google::Analytics::Data::V1beta::FilterExpression, ::Hash]
-              #     Dimension filters allow you to ask for only specific dimension values in
+              #     Dimension filters let you ask for only specific dimension values in
               #     the report. 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.
@@ -221,7 +221,7 @@ module Google
               #     [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
               #   @param limit [::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
+              #     API returns a maximum of 250,000 rows per request, no matter how many you
               #     ask for. `limit` must be positive.
               #
               #     The API can also return fewer rows than the requested `limit`, if there
@@ -247,6 +247,13 @@ module Google
               #     If false or unspecified, each row with all metrics equal to 0 will not be
               #     returned. If true, these rows will be returned if they are not separately
               #     removed by a filter.
+              #
+              #     Regardless of this `keep_empty_rows` setting, only data recorded by the
+              #     Google Analytics (GA4) property can be displayed in a report.
+              #
+              #     For example if a property never logs a `purchase` event, then a query for
+              #     the `eventName` dimension and  `eventCount` metric will not have a row
+              #     eventName: "purchase" and eventCount: 0.
               #   @param return_property_quota [::Boolean]
               #     Toggles whether to return the current state of this Analytics Property's
               #     quota. Quota is returned in [PropertyQuota](#PropertyQuota).
@@ -358,6 +365,13 @@ module Google
               #     If false or unspecified, each row with all metrics equal to 0 will not be
               #     returned. If true, these rows will be returned if they are not separately
               #     removed by a filter.
+              #
+              #     Regardless of this `keep_empty_rows` setting, only data recorded by the
+              #     Google Analytics (GA4) property can be displayed in a report.
+              #
+              #     For example if a property never logs a `purchase` event, then a query for
+              #     the `eventName` dimension and  `eventCount` metric will not have a row
+              #     eventName: "purchase" and eventCount: 0.
               #   @param return_property_quota [::Boolean]
               #     Toggles whether to return the current state of this Analytics Property's
               #     quota. Quota is returned in [PropertyQuota](#PropertyQuota).
@@ -676,7 +690,7 @@ module Google
               #     SQL having-clause. Dimensions cannot be used in this filter.
               #   @param limit [::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
+              #     API returns a maximum of 250,000 rows per request, no matter how many you
               #     ask for. `limit` must be positive.
               #
               #     The API can also return fewer rows than the requested `limit`, if there
@@ -774,10 +788,6 @@ module Google
               #     `property` should be the same value as in your `runReport` request.
               #
               #     Example: properties/1234
-              #
-              #     Set the Property ID to 0 for compatibility checking on dimensions and
-              #     metrics common to all properties. In this special mode, this method will
-              #     not return custom dimensions and metrics.
               #   @param dimensions [::Array<::Google::Analytics::Data::V1beta::Dimension, ::Hash>]
               #     The dimensions in this report. `dimensions` should be the same value as in
               #     your `runReport` request.

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

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1beta
-        VERSION = "0.8.0"
+        VERSION = "0.8.1"
       end
     end
   end

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

@@ -33,10 +33,6 @@ module Google
         #     `property` should be the same value as in your `runReport` request.
         #
         #     Example: properties/1234
-        #
-        #     Set the Property ID to 0 for compatibility checking on dimensions and
-        #     metrics common to all properties. In this special mode, this method will
-        #     not return custom dimensions and metrics.
         # @!attribute [rw] dimensions
         #   @return [::Array<::Google::Analytics::Data::V1beta::Dimension>]
         #     The dimensions in this report. `dimensions` should be the same value as in
@@ -116,7 +112,7 @@ module Google
         #     must be unspecified.
         # @!attribute [rw] dimension_filter
         #   @return [::Google::Analytics::Data::V1beta::FilterExpression]
-        #     Dimension filters allow you to ask for only specific dimension values in
+        #     Dimension filters let you ask for only specific dimension values in
         #     the report. 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.
@@ -138,7 +134,7 @@ module Google
         # @!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
+        #     API returns a maximum of 250,000 rows per request, no matter how many you
         #     ask for. `limit` must be positive.
         #
         #     The API can also return fewer rows than the requested `limit`, if there
@@ -169,6 +165,13 @@ module Google
         #     If false or unspecified, each row with all metrics equal to 0 will not be
         #     returned. If true, these rows will be returned if they are not separately
         #     removed by a filter.
+        #
+        #     Regardless of this `keep_empty_rows` setting, only data recorded by the
+        #     Google Analytics (GA4) property can be displayed in a report.
+        #
+        #     For example if a property never logs a `purchase` event, then a query for
+        #     the `eventName` dimension and  `eventCount` metric will not have a row
+        #     eventName: "purchase" and eventCount: 0.
         # @!attribute [rw] return_property_quota
         #   @return [::Boolean]
         #     Toggles whether to return the current state of this Analytics Property's
@@ -280,6 +283,13 @@ module Google
         #     If false or unspecified, each row with all metrics equal to 0 will not be
         #     returned. If true, these rows will be returned if they are not separately
         #     removed by a filter.
+        #
+        #     Regardless of this `keep_empty_rows` setting, only data recorded by the
+        #     Google Analytics (GA4) property can be displayed in a report.
+        #
+        #     For example if a property never logs a `purchase` event, then a query for
+        #     the `eventName` dimension and  `eventCount` metric will not have a row
+        #     eventName: "purchase" and eventCount: 0.
         # @!attribute [rw] return_property_quota
         #   @return [::Boolean]
         #     Toggles whether to return the current state of this Analytics Property's
@@ -475,7 +485,7 @@ module Google
         # @!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
+        #     API returns a maximum of 250,000 rows per request, no matter how many you
         #     ask for. `limit` must be positive.
         #
         #     The API can also return fewer rows than the requested `limit`, if there

data/proto_docs/google/analytics/data/v1beta/data.rb

@@ -21,8 +21,8 @@ module Google
   module Analytics
     module Data
       module V1beta
-        # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
-        # are allowed up to 4 date ranges.
+        # A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
+        # Requests are allowed up to 4 date ranges.
         # @!attribute [rw] start_date
         #   @return [::String]
         #     The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
@@ -46,8 +46,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
-        # endMinutesAgo. Requests are allowed up to 2 minute ranges.
+        # A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
+        # `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
         # @!attribute [rw] start_minutes_ago
         #   @return [::Integer]
         #     The inclusive start minute for the query as a number of minutes before now.
@@ -466,7 +466,7 @@ module Google
         #     single pivot requests.
         #
         #     The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
-        #     must not exceed 100,000. For example, a two pivot request with `limit:
+        #     must not exceed 250,000. For example, a two pivot request with `limit:
         #     1000` in each pivot will fail because the product is `1,000,000`.
         # @!attribute [rw] metric_aggregations
         #   @return [::Array<::Google::Analytics::Data::V1beta::MetricAggregation>]
@@ -622,6 +622,18 @@ module Google
         #   @return [::Boolean]
         #     If true, indicates some buckets of dimension combinations are rolled into
         #     "(other)" row. This can happen for high cardinality reports.
+        #
+        #     The metadata parameter dataLossFromOtherRow is populated based on the
+        #     aggregated data table used in the report. The parameter will be accurately
+        #     populated regardless of the filters and limits in the report.
+        #
+        #     For example, the (other) row could be dropped from the report because the
+        #     request contains a filter on sessionSource = google. This parameter will
+        #     still be populated if data loss from other row was present in the input
+        #     aggregate data used to generate this report.
+        #
+        #     To learn more, see [About the (other) row and data
+        #     sampling](https://support.google.com/analytics/answer/13208658#reports).
         # @!attribute [rw] schema_restriction_response
         #   @return [::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse]
         #     Describes the schema restrictions actively enforced in creating this
@@ -824,13 +836,13 @@ module Google
         # Exhausted errors.
         # @!attribute [rw] tokens_per_day
         #   @return [::Google::Analytics::Data::V1beta::QuotaStatus]
-        #     Standard Analytics Properties can use up to 25,000 tokens per day;
-        #     Analytics 360 Properties can use 250,000 tokens per day. Most requests
+        #     Standard Analytics Properties can use up to 200,000 tokens per day;
+        #     Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
         #     consume fewer than 10 tokens.
         # @!attribute [rw] tokens_per_hour
         #   @return [::Google::Analytics::Data::V1beta::QuotaStatus]
-        #     Standard Analytics Properties can use up to 5,000 tokens per hour;
-        #     Analytics 360 Properties can use 50,000 tokens per hour. An API request
+        #     Standard Analytics Properties can use up to 40,000 tokens per hour;
+        #     Analytics 360 Properties can use 400,000 tokens per hour. An API request
         #     consumes a single number of tokens, and that number is deducted from all of
         #     the hourly, daily, and per project hourly quotas.
         # @!attribute [rw] concurrent_requests
@@ -850,9 +862,9 @@ module Google
         #     thresholded dimensions.
         # @!attribute [rw] tokens_per_project_per_hour
         #   @return [::Google::Analytics::Data::V1beta::QuotaStatus]
-        #     Analytics Properties can use up to 25% of their tokens per project per
-        #     hour. This amounts to standard Analytics Properties can use up to 1,250
-        #     tokens per project per hour, and Analytics 360 Properties can use 12,500
+        #     Analytics Properties can use up to 35% of their tokens per project per
+        #     hour. This amounts to standard Analytics Properties can use up to 14,000
+        #     tokens per project per hour, and Analytics 360 Properties can use 140,000
         #     tokens per project per hour. An API request consumes a single number of
         #     tokens, and that number is deducted from all of the hourly, daily, and per
         #     project hourly quotas.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-data-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -214,5 +214,10 @@ requirements: []
 rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
-summary: Accesses report data in Google Analytics.
+summary: 'Accesses report data in Google Analytics. Warning: Creating multiple Customer
+  Applications, Accounts, or Projects to simulate or act as a single Customer Application,
+  Account, or Project (respectively) or to circumvent Service-specific usage limits
+  or quotas is a direct violation of Google Cloud Platform Terms of Service as well
+  as Google APIs Terms of Service. These actions can result in immediate termination
+  of your GCP project(s) without any warning.'
 test_files: []