google-analytics-data-v1beta 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92cac32d4409a7bd6cc432476cebc95e4c489b15b582c4dfe0982c1d5fade41f
-  data.tar.gz: e3a5dff97864eea55e0b6f9f657e9a7120befe5a8d900580a4497b8ea428ed81
+  metadata.gz: c021234dd6f81ba0f39dbbb777517e6fab6c15dea6311094c80dd8447aa0531e
+  data.tar.gz: db84e46a4f4f7685a998f618ec3111b21b5acf247718485807cbe024c2e2e82d
 SHA512:
-  metadata.gz: 32339ae1e1b113282a98067656843d05dea03578a19bec145927f4ac26f73701885f974501275922e80d7efbe981df8d9a63c1bdefb20d071c398abcef9bd3f1
-  data.tar.gz: 47c3c8189703d95b46a6e25537d7a1613c9c81be30726a58a3f4efad6c236c3e9613c105cfe7757095312a6778f6454cbecff0618de7209429f07d8cd8fefad6
+  metadata.gz: d1d8d6dbabc2913006e761cc2901de043317fafe472bb5feb8e8f9be540fa597fabebc33fc66045baf354ae8a414d53a01f0cd20a1f3f67323d1e1a7e04b53bc
+  data.tar.gz: 2ccdcf5ff209db69140d5e7726f9beb2df795003ee8142430bbc5d571f6c68cef93c91133851b240e50209a965fa36069a0164529bb6fb555eac8e126c73c193

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-analytics-data-v1beta
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Analytics::Data::V1beta::AnalyticsData::Credentials}):
 
-1. `ANALYTICS_DATA_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `ANALYTICS_DATA_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `ANALYTICS_DATA_CREDENTIALS` - Path to JSON file, or JSON contents
+* `ANALYTICS_DATA_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/analytics/data/v1beta"
@@ -82,8 +82,8 @@ client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/analytics/data/v1beta"
@@ -93,7 +93,7 @@ client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new do |config
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/analytics/data/v1beta"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/analytics/data/v1beta"
 
 client = ::Google::Analytics::Data::V1beta::AnalyticsData::Client.new
-request = my_create_request
+request = ::Google::Analytics::Data::V1beta::RunReportRequest.new # (request fields as keyword arguments...)
 response = client.run_report request
 ```
 

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

@@ -67,10 +67,7 @@ module Google
 
                 default_config.timeout = 60.0
                 default_config.retry_policy = {
-                  initial_delay: 1.0,
-                  max_delay: 60.0,
-                  multiplier: 1.3,
-                  retry_codes: [2]
+                  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [2]
                 }
 
                 default_config.rpcs.run_report.timeout = 60.0
@@ -151,7 +148,7 @@ module Google
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -676,7 +673,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload run_realtime_report(property: nil, dimensions: nil, metrics: nil, dimension_filter: nil, metric_filter: nil, limit: nil, metric_aggregations: nil, order_bys: nil, return_property_quota: nil)
+            # @overload run_realtime_report(property: nil, dimensions: nil, metrics: nil, dimension_filter: nil, metric_filter: nil, limit: nil, metric_aggregations: nil, order_bys: nil, return_property_quota: nil, minute_ranges: nil)
             #   Pass arguments to `run_realtime_report` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -717,6 +714,12 @@ module Google
             #   @param return_property_quota [::Boolean]
             #     Toggles whether to return the current state of this Analytics Property's
             #     Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+            #   @param minute_ranges [::Array<::Google::Analytics::Data::V1beta::MinuteRange, ::Hash>]
+            #     The minute ranges of event data to read. If unspecified, one minute range
+            #     for the last 30 minutes will be used. If multiple minute ranges are
+            #     requested, each response row will contain a zero based minute range index.
+            #     If two minute ranges overlap, the event data for the overlapping minutes is
+            #     included in the response rows for both minute ranges.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Analytics::Data::V1beta::RunRealtimeReportResponse]

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

@@ -95,6 +95,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :metric_aggregations, :enum, 7, "google.analytics.data.v1beta.MetricAggregation"
       repeated :order_bys, :message, 8, "google.analytics.data.v1beta.OrderBy"
       optional :return_property_quota, :bool, 9
+      repeated :minute_ranges, :message, 10, "google.analytics.data.v1beta.MinuteRange"
     end
     add_message "google.analytics.data.v1beta.RunRealtimeReportResponse" do
       repeated :dimension_headers, :message, 1, "google.analytics.data.v1beta.DimensionHeader"

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

@@ -10,6 +10,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :end_date, :string, 2
       optional :name, :string, 3
     end
+    add_message "google.analytics.data.v1beta.MinuteRange" do
+      proto3_optional :start_minutes_ago, :int32, 1
+      proto3_optional :end_minutes_ago, :int32, 2
+      optional :name, :string, 3
+    end
     add_message "google.analytics.data.v1beta.Dimension" do
       optional :name, :string, 1
       optional :dimension_expression, :message, 2, "google.analytics.data.v1beta.DimensionExpression"
@@ -241,6 +246,7 @@ module Google
     module Data
       module V1beta
         DateRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DateRange").msgclass
+        MinuteRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.MinuteRange").msgclass
         Dimension = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.Dimension").msgclass
         DimensionExpression = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionExpression").msgclass
         DimensionExpression::CaseExpression = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.analytics.data.v1beta.DimensionExpression.CaseExpression").msgclass

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

@@ -21,7 +21,7 @@ module Google
   module Analytics
     module Data
       module V1beta
-        VERSION = "0.1.0"
+        VERSION = "0.2.0"
       end
     end
   end

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

@@ -441,6 +441,13 @@ module Google
         #   @return [::Boolean]
         #     Toggles whether to return the current state of this Analytics Property's
         #     Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+        # @!attribute [rw] minute_ranges
+        #   @return [::Array<::Google::Analytics::Data::V1beta::MinuteRange>]
+        #     The minute ranges of event data to read. If unspecified, one minute range
+        #     for the last 30 minutes will be used. If multiple minute ranges are
+        #     requested, each response row will contain a zero based minute range index.
+        #     If two minute ranges overlap, the event data for the overlapping minutes is
+        #     included in the response rows for both minute ranges.
         class RunRealtimeReportRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -46,10 +46,44 @@ 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.
+        # @!attribute [rw] start_minutes_ago
+        #   @return [::Integer]
+        #     The inclusive start minute for the query as a number of minutes before now.
+        #     For example, `"startMinutesAgo": 29` specifies the report should include
+        #     event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`.
+        #
+        #     If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
+        #     properties can request up to the last 30 minutes of event data
+        #     (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
+        #     the last 60 minutes of event data (`startMinutesAgo <= 59`).
+        # @!attribute [rw] end_minutes_ago
+        #   @return [::Integer]
+        #     The inclusive end minute for the query as a number of minutes before now.
+        #     Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
+        #     specifies the report should include event data from prior to 15 minutes
+        #     ago.
+        #
+        #     If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
+        #     properties can request any minute in the last 30 minutes of event data
+        #     (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
+        #     minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Assigns a name to this minute range. The dimension `dateRange` is valued to
+        #     this name in a report response. If set, cannot begin with `date_range_` or
+        #     `RESERVED_`. If not set, minute ranges are named by their zero based index
+        #     in the request: `date_range_0`, `date_range_1`, etc.
+        class MinuteRange
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Dimensions are attributes of your data. For example, the dimension city
         # indicates the city from which an event originates. Dimension values in report
         # responses are strings; for example, city could be "Paris" or "New York".
-        # Requests are allowed up to 8 dimensions.
+        # Requests are allowed up to 9 dimensions.
         # @!attribute [rw] name
         #   @return [::String]
         #     The name of the dimension. See the [API

data/proto_docs/google/api/field_behavior.rb

@@ -60,6 +60,12 @@ module Google
       # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

metadata

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