google-analytics-data-v1alpha 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e855e82e44e32830f8170a32d2675893ff52d9417bd318dd4984eb3a2129784
-  data.tar.gz: 183e42b1ca3b3128e6aac9b7956f7f1021bf5c76ae66008877e83b3ab2b21501
+  metadata.gz: 46a4a35fe96d97d0e55469823d63d565fad0d23c91ec695e4900dd026dac33c2
+  data.tar.gz: 4fb8b75aa1d11f18617f9667010111ac548a77cd304e1d9e4522e9f3e395138d
 SHA512:
-  metadata.gz: e1b6a4a2b53daa127d558dbe8ff7c2f182a418e92bedb9ac028d2a52a76b674ae5c91004237c9485a937871e65100b5401709f9320db2ed28c2bb91b7be9eada
-  data.tar.gz: e477689c2bf4e53211f46c26497ecda51112f17265593a035ffcdb97bd5c5c0637742b30e21d8eedb2ea637a89a04952bf4ec9aa47d242ab73d94d6dc2d66dcb
+  metadata.gz: 88e10c1f978a46c7e3417bc54941af2a6dc1d8c04b01ec296dc0b868f01b606dfa7c37206a2ce71a12051364c43650e78e47e7863042d88552ccf375a0683771
+  data.tar.gz: ae84293ce9806270947f602b06f98b16cfae7435ad075a7672ef7de96e111cda55793e309971c7c79c5a4bb9e2aad2af593625f59691d4356b31f7e3d37a1ccc

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

@@ -199,9 +199,15 @@ module Google
             #     must be unspecified.
             #   @param offset [::Integer]
             #     The row count of the start row. The first row is counted as row 0.
+            #
+            #     To learn more about this pagination parameter, see
+            #     [Pagination](basics#pagination).
             #   @param limit [::Integer]
             #     The number of rows to return. If unspecified, 10 rows are returned. If
             #     -1, all rows are returned.
+            #
+            #     To learn more about this pagination parameter, see
+            #     [Pagination](basics#pagination).
             #   @param metric_aggregations [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
             #     Aggregation of metrics. Aggregated metric values will be shown in rows
             #     where the dimension_values are set to "RESERVED_(MetricAggregation)".
@@ -502,67 +508,10 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
-            ##
-            # Returns metadata for dimensions and metrics available in reporting methods.
-            # Used to explore the dimensions and metrics. Dimensions and metrics will be
-            # mostly added over time, but renames and deletions may occur.
-            #
-            # This method returns Universal Metadata. Universal Metadata are dimensions
-            # and metrics applicable to any property such as `country` and `totalUsers`.
-            #
-            # @overload get_universal_metadata(request, options = nil)
-            #   Pass arguments to `get_universal_metadata` via a request object, either of type
-            #   {::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest} or an equivalent Hash.
-            #
-            #   @param request [::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest, ::Hash]
-            #     A request object representing the call parameters. Required. To specify no
-            #     parameters, or to keep all the default parameter values, pass an empty Hash.
-            #   @param options [::Gapic::CallOptions, ::Hash]
-            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
-            #
-            # @yield [response, operation] Access the result along with the RPC operation
-            # @yieldparam response [::Google::Analytics::Data::V1alpha::UniversalMetadata]
-            # @yieldparam operation [::GRPC::ActiveCall::Operation]
-            #
-            # @return [::Google::Analytics::Data::V1alpha::UniversalMetadata]
-            #
-            # @raise [::Google::Cloud::Error] if the RPC is aborted.
-            #
-            def get_universal_metadata request, options = nil
-              raise ::ArgumentError, "request must be provided" if request.nil?
-
-              request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest
-
-              # Converts hash and nil to an options object
-              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
-
-              # Customize the options with defaults
-              metadata = @config.rpcs.get_universal_metadata.metadata.to_h
-
-              # Set x-goog-api-client and x-goog-user-project headers
-              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
-                lib_name: @config.lib_name, lib_version: @config.lib_version,
-                gapic_version: ::Google::Analytics::Data::V1alpha::VERSION
-              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-              options.apply_defaults timeout:      @config.rpcs.get_universal_metadata.timeout,
-                                     metadata:     metadata,
-                                     retry_policy: @config.rpcs.get_universal_metadata.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
-                                     retry_policy: @config.retry_policy
-
-              @analytics_data_stub.call_rpc :get_universal_metadata, request, options: options do |response, operation|
-                yield response, operation if block_given?
-                return response
-              end
-            rescue ::GRPC::BadStatus => e
-              raise ::Google::Cloud::Error.from_error(e)
-            end
-
             ##
             # Returns metadata for dimensions and metrics available in reporting methods.
             # Used to explore the dimensions and metrics. In this method, a Google
-            # Analytics 4 (GA4) Property Identifier is specified in the request, and
+            # Analytics GA4 Property Identifier is specified in the request, and
             # the metadata response includes Custom dimensions and metrics as well as
             # Universal metadata.
             #
@@ -589,10 +538,16 @@ module Google
             #   @param name [::String]
             #     Required. The resource name of the metadata to retrieve. This name field is
             #     specified in the URL path and not URL parameters. Property is a numeric
-            #     Google Analytics 4 (GA4) Property identifier.
+            #     Google Analytics GA4 Property identifier. To learn more, see [where to find
+            #     your Property
+            #     ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
             #
             #     Example: properties/1234/metadata
             #
+            #     Set the Property ID to 0 for dimensions and metrics common to all
+            #     properties. In this special mode, this method will not return custom
+            #     dimensions and metrics.
+            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Analytics::Data::V1alpha::Metadata]
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -890,11 +845,6 @@ module Google
                 #
                 attr_reader :batch_run_pivot_reports
                 ##
-                # RPC-specific configuration for `get_universal_metadata`
-                # @return [::Gapic::Config::Method]
-                #
-                attr_reader :get_universal_metadata
-                ##
                 # RPC-specific configuration for `get_metadata`
                 # @return [::Gapic::Config::Method]
                 #
@@ -915,8 +865,6 @@ module Google
                   @batch_run_reports = ::Gapic::Config::Method.new batch_run_reports_config
                   batch_run_pivot_reports_config = parent_rpcs&.batch_run_pivot_reports if parent_rpcs&.respond_to? :batch_run_pivot_reports
                   @batch_run_pivot_reports = ::Gapic::Config::Method.new batch_run_pivot_reports_config
-                  get_universal_metadata_config = parent_rpcs&.get_universal_metadata if parent_rpcs&.respond_to? :get_universal_metadata
-                  @get_universal_metadata = ::Gapic::Config::Method.new get_universal_metadata_config
                   get_metadata_config = parent_rpcs&.get_metadata if parent_rpcs&.respond_to? :get_metadata
                   @get_metadata = ::Gapic::Config::Method.new get_metadata_config
                   run_realtime_report_config = parent_rpcs&.run_realtime_report if parent_rpcs&.respond_to? :run_realtime_report

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

@@ -78,12 +78,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.analytics.data.v1alpha.BatchRunPivotReportsResponse" do
       repeated :pivot_reports, :message, 1, "google.analytics.data.v1alpha.RunPivotReportResponse"
     end
-    add_message "google.analytics.data.v1alpha.GetUniversalMetadataRequest" do
-    end
-    add_message "google.analytics.data.v1alpha.UniversalMetadata" do
-      repeated :dimensions, :message, 1, "google.analytics.data.v1alpha.DimensionMetadata"
-      repeated :metrics, :message, 2, "google.analytics.data.v1alpha.MetricMetadata"
-    end
     add_message "google.analytics.data.v1alpha.GetMetadataRequest" do
       optional :name, :string, 1
     end
@@ -124,8 +118,6 @@ module Google
         BatchRunReportsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.BatchRunReportsResponse").msgclass
         BatchRunPivotReportsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.BatchRunPivotReportsRequest").msgclass
         BatchRunPivotReportsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.BatchRunPivotReportsResponse").msgclass
-        GetUniversalMetadataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.GetUniversalMetadataRequest").msgclass
-        UniversalMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.UniversalMetadata").msgclass
         GetMetadataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.GetMetadataRequest").msgclass
         RunRealtimeReportRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.RunRealtimeReportRequest").msgclass
         RunRealtimeReportResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1alpha.RunRealtimeReportResponse").msgclass

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

@@ -54,15 +54,8 @@ module Google
             # Entity.
             rpc :BatchRunPivotReports, ::Google::Analytics::Data::V1alpha::BatchRunPivotReportsRequest, ::Google::Analytics::Data::V1alpha::BatchRunPivotReportsResponse
             # Returns metadata for dimensions and metrics available in reporting methods.
-            # Used to explore the dimensions and metrics. Dimensions and metrics will be
-            # mostly added over time, but renames and deletions may occur.
-            #
-            # This method returns Universal Metadata. Universal Metadata are dimensions
-            # and metrics applicable to any property such as `country` and `totalUsers`.
-            rpc :GetUniversalMetadata, ::Google::Analytics::Data::V1alpha::GetUniversalMetadataRequest, ::Google::Analytics::Data::V1alpha::UniversalMetadata
-            # Returns metadata for dimensions and metrics available in reporting methods.
             # Used to explore the dimensions and metrics. In this method, a Google
-            # Analytics 4 (GA4) Property Identifier is specified in the request, and
+            # Analytics GA4 Property Identifier is specified in the request, and
             # the metadata response includes Custom dimensions and metrics as well as
             # Universal metadata.
             #

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

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

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

@@ -57,10 +57,16 @@ module Google
         # @!attribute [rw] offset
         #   @return [::Integer]
         #     The row count of the start row. The first row is counted as row 0.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](basics#pagination).
         # @!attribute [rw] limit
         #   @return [::Integer]
         #     The number of rows to return. If unspecified, 10 rows are returned. If
         #     -1, all rows are returned.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](basics#pagination).
         # @!attribute [rw] metric_aggregations
         #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricAggregation>]
         #     Aggregation of metrics. Aggregated metric values will be shown in rows
@@ -126,6 +132,9 @@ module Google
         #     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.
+        #
+        #     To learn more about this pagination parameter, see
+        #     [Pagination](basics#pagination).
         # @!attribute [rw] metadata
         #   @return [::Google::Analytics::Data::V1alpha::ResponseMetaData]
         #     Metadata for the report.
@@ -310,32 +319,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for the universal dimension and metric metadata.
-        class GetUniversalMetadataRequest
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # The dimensions and metrics currently accepted in reporting methods.
-        # @!attribute [rw] dimensions
-        #   @return [::Array<::Google::Analytics::Data::V1alpha::DimensionMetadata>]
-        #     The dimensions descriptions.
-        # @!attribute [rw] metrics
-        #   @return [::Array<::Google::Analytics::Data::V1alpha::MetricMetadata>]
-        #     The metric descriptions.
-        class UniversalMetadata
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
         # Request for a property's dimension and metric metadata.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the metadata to retrieve. This name field is
         #     specified in the URL path and not URL parameters. Property is a numeric
-        #     Google Analytics 4 (GA4) Property identifier.
+        #     Google Analytics GA4 Property identifier. To learn more, see [where to find
+        #     your Property
+        #     ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
         #
         #     Example: properties/1234/metadata
+        #
+        #     Set the Property ID to 0 for dimensions and metrics common to all
+        #     properties. In this special mode, this method will not return custom
+        #     dimensions and metrics.
         class GetMetadataRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -22,8 +22,7 @@ module Google
     module Data
       module V1alpha
         # 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.
+        # 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

metadata

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