google-analytics-data-v1beta 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d361901325beca50c3db3d44d2110e75312b33708aa639c3a5c7a5581e28a87
-  data.tar.gz: 5ac4d0717a3e89ff33ba31b52a9a8c5b910bdb26785b570fd938eaedeb084f70
+  metadata.gz: '059c6b332489b0cbb18e6c74e9ddb315d7f82adb8dbbe4a68df85ee11c183d78'
+  data.tar.gz: a3e25aa05bbed95b21a39fce150a146e86f20c2ec7f4c82473db66c12177ea27
 SHA512:
-  metadata.gz: 79546585bba50ca3798b5323ad471b95a1a3abfe1e024d8dd5b7f1c3d57cef4cc428b36857b4dbc0e3b8a811078a0eae5c4789e9b40e6f74fc149dec11183910
-  data.tar.gz: 279a03e5fa854ab7f3a3bab921dc4e8dfbb1d6b9ba31bd064dc6dd524fafd8aab0f67bf435c9fa26639e78463cb6223cb6c34b5e7cc46ff69972acc779e0d41f
+  metadata.gz: a4daa847f618a432dc22512099eca529df77c9e9fa569c160c8482e605a60cfb79d705affda9b2449089247fe5f3b84094e7a916d1a91ccdfc6402e10e892014
+  data.tar.gz: faac7c705db32dcb11fe6c986f7d3b20cc07084b4caef0e7829cbfadbeb0403cf55e98711101d80466b2fe76ca8c3641225417f3be4aab4e13f96a592d9a8d76

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

@@ -277,9 +277,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -394,9 +396,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -474,9 +478,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -554,9 +560,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -641,9 +649,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -751,9 +761,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -853,9 +865,11 @@ module Google
                 gapic_version: ::Google::Analytics::Data::V1beta::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "property" => request.property
-              }
+              header_params = {}
+              if request.property
+                header_params["property"] = request.property
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

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

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/analytics/data/v1beta/analytics_data_api.proto
 
-require 'google/protobuf'
-
 require 'google/analytics/data/v1beta/data_pb'
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/analytics/data/v1beta/analytics_data_api.proto", :syntax => :proto3) do
     add_message "google.analytics.data.v1beta.CheckCompatibilityRequest" do

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

@@ -27,7 +27,7 @@ module Google
           # Google Analytics reporting data service.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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

@@ -154,6 +154,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.analytics.data.v1beta.ResponseMetaData" do
       optional :data_loss_from_other_row, :bool, 3
+      proto3_optional :schema_restriction_response, :message, 4, "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse"
+      proto3_optional :currency_code, :string, 5
+      proto3_optional :time_zone, :string, 6
+      proto3_optional :empty_reason, :string, 7
+    end
+    add_message "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse" do
+      repeated :active_metric_restrictions, :message, 1, "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction"
+    end
+    add_message "google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction" do
+      proto3_optional :metric_name, :string, 1
+      repeated :restricted_metric_types, :enum, 2, "google.analytics.data.v1beta.RestrictedMetricType"
     end
     add_message "google.analytics.data.v1beta.DimensionHeader" do
       optional :name, :string, 1
@@ -216,8 +227,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :type, :enum, 5, "google.analytics.data.v1beta.MetricType"
       optional :expression, :string, 6
       optional :custom_definition, :bool, 7
+      repeated :blocked_reasons, :enum, 8, "google.analytics.data.v1beta.MetricMetadata.BlockedReason"
       optional :category, :string, 10
     end
+    add_enum "google.analytics.data.v1beta.MetricMetadata.BlockedReason" do
+      value :BLOCKED_REASON_UNSPECIFIED, 0
+      value :NO_REVENUE_METRICS, 1
+      value :NO_COST_METRICS, 2
+    end
     add_message "google.analytics.data.v1beta.DimensionCompatibility" do
       proto3_optional :dimension_metadata, :message, 1, "google.analytics.data.v1beta.DimensionMetadata"
       proto3_optional :compatibility, :enum, 2, "google.analytics.data.v1beta.Compatibility"
@@ -248,6 +265,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :TYPE_METERS, 12
       value :TYPE_KILOMETERS, 13
     end
+    add_enum "google.analytics.data.v1beta.RestrictedMetricType" do
+      value :RESTRICTED_METRIC_TYPE_UNSPECIFIED, 0
+      value :COST_DATA, 1
+      value :REVENUE_DATA, 2
+    end
     add_enum "google.analytics.data.v1beta.Compatibility" do
       value :COMPATIBILITY_UNSPECIFIED, 0
       value :COMPATIBLE, 1
@@ -289,6 +311,8 @@ module Google
         CohortsRange::Granularity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.CohortsRange.Granularity").enummodule
         CohortReportSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.CohortReportSettings").msgclass
         ResponseMetaData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.ResponseMetaData").msgclass
+        ResponseMetaData::SchemaRestrictionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse").msgclass
+        ResponseMetaData::SchemaRestrictionResponse::ActiveMetricRestriction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction").msgclass
         DimensionHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionHeader").msgclass
         MetricHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricHeader").msgclass
         PivotHeader = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.PivotHeader").msgclass
@@ -301,10 +325,12 @@ module Google
         QuotaStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.QuotaStatus").msgclass
         DimensionMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionMetadata").msgclass
         MetricMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricMetadata").msgclass
+        MetricMetadata::BlockedReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricMetadata.BlockedReason").enummodule
         DimensionCompatibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionCompatibility").msgclass
         MetricCompatibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricCompatibility").msgclass
         MetricAggregation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricAggregation").enummodule
         MetricType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MetricType").enummodule
+        RestrictedMetricType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.RestrictedMetricType").enummodule
         Compatibility = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.Compatibility").enummodule
       end
     end

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

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1beta
-        VERSION = "0.3.0"
+        VERSION = "0.4.0"
       end
     end
   end

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

@@ -618,9 +618,61 @@ module Google
         #   @return [::Boolean]
         #     If true, indicates some buckets of dimension combinations are rolled into
         #     "(other)" row. This can happen for high cardinality reports.
+        # @!attribute [rw] schema_restriction_response
+        #   @return [::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse]
+        #     Describes the schema restrictions actively enforced in creating this
+        #     report. To learn more, see [Access and data-restriction
+        #     management](https://support.google.com/analytics/answer/10851388).
+        # @!attribute [rw] currency_code
+        #   @return [::String]
+        #     The currency code used in this report. Intended to be used in formatting
+        #     currency metrics like `purchaseRevenue` for visualization. If currency_code
+        #     was specified in the request, this response parameter will echo the request
+        #     parameter; otherwise, this response parameter is the property's current
+        #     currency_code.
+        #
+        #     Currency codes are string encodings of currency types from the ISO 4217
+        #     standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
+        #     "EUR", "JPY". To learn more, see
+        #     https://support.google.com/analytics/answer/9796179.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     The property's current timezone. Intended to be used to interpret
+        #     time-based dimensions like `hour` and `minute`. 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] empty_reason
+        #   @return [::String]
+        #     If empty reason is specified, the report is empty for this reason.
         class ResponseMetaData
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The schema restrictions actively enforced in creating this report. To learn
+          # more, see [Access and data-restriction
+          # management](https://support.google.com/analytics/answer/10851388).
+          # @!attribute [rw] active_metric_restrictions
+          #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::ActiveMetricRestriction>]
+          #     All restrictions actively enforced in creating the report. For example,
+          #     `purchaseRevenue` always has the restriction type `REVENUE_DATA`.
+          #     However, this active response restriction is only populated if the user's
+          #     custom role disallows access to `REVENUE_DATA`.
+          class SchemaRestrictionResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A metric actively restricted in creating the report.
+            # @!attribute [rw] metric_name
+            #   @return [::String]
+            #     The name of the restricted metric.
+            # @!attribute [rw] restricted_metric_types
+            #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
+            #     The reason for this metric's restriction.
+            class ActiveMetricRestriction
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
         end
 
         # Describes a dimension column in the report. Dimensions requested in a report
@@ -858,6 +910,16 @@ module Google
         # @!attribute [rw] custom_definition
         #   @return [::Boolean]
         #     True if the metric is a custom metric for this property.
+        # @!attribute [rw] blocked_reasons
+        #   @return [::Array<::Google::Analytics::Data::V1beta::MetricMetadata::BlockedReason>]
+        #     If reasons are specified, your access is blocked to this metric for this
+        #     property. API requests from you to this property for this metric will
+        #     succeed; however, the report will contain only zeros for this metric. API
+        #     requests with metric filters on blocked metrics will fail. If reasons are
+        #     empty, you have access to this metric.
+        #
+        #     To learn more, see [Access and data-restriction
+        #     management](https://support.google.com/analytics/answer/10851388).
         # @!attribute [rw] category
         #   @return [::String]
         #     The display name of the category that this metrics belongs to. Similar
@@ -865,6 +927,20 @@ module Google
         class MetricMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Justifications for why this metric is blocked.
+          module BlockedReason
+            # Will never be specified in API response.
+            BLOCKED_REASON_UNSPECIFIED = 0
+
+            # If present, your access is blocked to revenue related metrics for this
+            # property, and this metric is revenue related.
+            NO_REVENUE_METRICS = 1
+
+            # If present, your access is blocked to cost related metrics for this
+            # property, and this metric is cost related.
+            NO_COST_METRICS = 2
+          end
         end
 
         # The compatibility for a single dimension.
@@ -957,6 +1033,19 @@ module Google
           TYPE_KILOMETERS = 13
         end
 
+        # Categories of data that you may be restricted from viewing on certain GA4
+        # properties.
+        module RestrictedMetricType
+          # Unspecified type.
+          RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0
+
+          # Cost metrics such as `adCost`.
+          COST_DATA = 1
+
+          # Revenue metrics such as `purchaseRevenue`.
+          REVENUE_DATA = 2
+        end
+
         # The compatibility types for a single dimension or metric.
         module Compatibility
           # Unspecified compatibility.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-analytics-data-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common