google-analytics-data-v1beta 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d361901325beca50c3db3d44d2110e75312b33708aa639c3a5c7a5581e28a87
-  data.tar.gz: 5ac4d0717a3e89ff33ba31b52a9a8c5b910bdb26785b570fd938eaedeb084f70
+  metadata.gz: e1f7897ecf6be76a1671e10114f3879e4beb7e73cc6f1fad9194f125f5b502c9
+  data.tar.gz: 9e8a3d5a72ec8a500d678f3c492eb88d0c1fb5cb7e8f4a40639f24da56d83564
 SHA512:
-  metadata.gz: 79546585bba50ca3798b5323ad471b95a1a3abfe1e024d8dd5b7f1c3d57cef4cc428b36857b4dbc0e3b8a811078a0eae5c4789e9b40e6f74fc149dec11183910
-  data.tar.gz: 279a03e5fa854ab7f3a3bab921dc4e8dfbb1d6b9ba31bd064dc6dd524fafd8aab0f67bf435c9fa26639e78463cb6223cb6c34b5e7cc46ff69972acc779e0d41f
+  metadata.gz: e5a3096f03815db99beed6086bab0f7ef9b54612be12de4dbb434f851bd0886bbaa01ae7a8dd1500a8a320866e4f447a5666354894cdd3ca9a4f00e930c14779
+  data.tar.gz: d9c3e0d95e7848005273c6430811e41d99439b7684a7b513848dc12c653341a4588ce57245d59b7b9274acb3a82c55341e0497ac9db3059d6c4a0657d6d17d43

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Google Analytics Data V1beta API
+--title="Google Analytics Data V1beta API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

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

@@ -260,6 +260,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::RunReportRequest.new
+            #
+            #   # Call the run_report method.
+            #   result = client.run_report request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::RunReportResponse.
+            #   p result
+            #
             def run_report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -277,9 +292,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
 
@@ -377,6 +394,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::RunPivotReportRequest.new
+            #
+            #   # Call the run_pivot_report method.
+            #   result = client.run_pivot_report request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::RunPivotReportResponse.
+            #   p result
+            #
             def run_pivot_report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -394,9 +426,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
 
@@ -457,6 +491,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::BatchRunReportsRequest.new
+            #
+            #   # Call the batch_run_reports method.
+            #   result = client.batch_run_reports request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::BatchRunReportsResponse.
+            #   p result
+            #
             def batch_run_reports request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -474,9 +523,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
 
@@ -537,6 +588,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::BatchRunPivotReportsRequest.new
+            #
+            #   # Call the batch_run_pivot_reports method.
+            #   result = client.batch_run_pivot_reports request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::BatchRunPivotReportsResponse.
+            #   p result
+            #
             def batch_run_pivot_reports request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -554,9 +620,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
 
@@ -624,6 +692,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::GetMetadataRequest.new
+            #
+            #   # Call the get_metadata method.
+            #   result = client.get_metadata request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::Metadata.
+            #   p result
+            #
             def get_metadata request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -641,9 +724,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
 
@@ -734,6 +819,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::RunRealtimeReportRequest.new
+            #
+            #   # Call the run_realtime_report method.
+            #   result = client.run_realtime_report request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::RunRealtimeReportResponse.
+            #   p result
+            #
             def run_realtime_report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -751,9 +851,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
 
@@ -836,6 +938,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/analytics/data/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Analytics::Data::V1beta::AnalyticsData::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Analytics::Data::V1beta::CheckCompatibilityRequest.new
+            #
+            #   # Call the check_compatibility method.
+            #   result = client.check_compatibility request
+            #
+            #   # The returned object is of type Google::Analytics::Data::V1beta::CheckCompatibilityResponse.
+            #   p result
+            #
             def check_compatibility request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -853,9 +970,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.3"
       end
     end
   end

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

@@ -94,7 +94,7 @@ module Google
         #     would like within the allowed character set. For example if a
         #     `dimensionExpression` concatenates `country` and `city`, you could call
         #     that dimension `countryAndCity`. Dimension names that you choose must match
-        #     the regular expression "^[a-zA-Z0-9_]$".
+        #     the regular expression `^[a-zA-Z0-9_]$`.
         #
         #     Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
         #     `dimensionExpression`, and `pivots`.
@@ -168,7 +168,7 @@ module Google
         #     within the allowed character set. For example if `expression` is
         #     `screenPageViews/sessions`, you could call that metric's name =
         #     `viewsPerSession`. Metric names that you choose must match the regular
-        #     expression "^[a-zA-Z0-9_]$".
+        #     expression `^[a-zA-Z0-9_]$`.
         #
         #     Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
         #     `expression`.
@@ -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.

data/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

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.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Analytics Data V1beta API