google-apis-analyticsdata_v1beta 0.6.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aebbab886c0e4d17faf9b94cba17139b5664973e852365d1d458a566d4d1da37
-  data.tar.gz: f542ea9bf8630ceb54ecb22a5839ef6b31a11622d65f700336af11b0f2181248
+  metadata.gz: 8161a68dacdecb39659fa2424218e74edde6ba2989e26b9f8de154f78195d9c6
+  data.tar.gz: 89b02d11526f136c8458f653f12f15d55dffa76bfc027fbc8bf0ecb369e4e609
 SHA512:
-  metadata.gz: 9f5745d90be012abe2a7b42574396d9d2f977c81c4836514796e07e84f9da85a0e7c5b32a79b48fcf63d2d69fc743089b42c0fbeb26c8dc79a4821cbb613d99a
-  data.tar.gz: 5607c47f1063b0698197a2283da9ab2fd564b3adf35dd10345445f3d7dd664dbe44c29462d32d6e01b0859e2fbb5dfce9a8df9216ecc7d02ef3177d9a1f88995
+  metadata.gz: 952b5e72783d4c9be55aa864a9d65fe4eef1fe09a734fbdbbe529dd60a1b76070da7bfb3c3e221aa94ed8d58ad45a733aa1934eb9d79e32f0f3e7a9a0ade1869
+  data.tar.gz: a630ca4945c5d665eb859d758c47d1adeb64636d0a4c0b56e284ba0c7734f85b8a0f9583ce2b582088ae239e34fe608d3422dfb7a30bab46daccc120514f334e

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release history for google-apis-analyticsdata_v1beta
 
+### v0.10.0 (2021-12-08)
+
+* Regenerated from discovery document revision 20211203
+
+### v0.9.0 (2021-11-11)
+
+* Regenerated from discovery document revision 20211108
+
+### v0.8.0 (2021-10-22)
+
+* Regenerated from discovery document revision 20211020
+* Unspecified changes
+
+### v0.7.0 (2021-08-31)
+
+* Regenerated from discovery document revision 20210827
+
 ### v0.6.0 (2021-08-26)
 
 * Regenerated from discovery document revision 20210824

data/OVERVIEW.md

@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
 
 More detailed descriptions of the Google simple REST clients are available in two documents.
 
- *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
- *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
+ *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
+ *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
 
 (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Analyticsdata service in particular.)
 

data/lib/google/apis/analyticsdata_v1beta/classes.rb

@@ -22,6 +22,31 @@ module Google
   module Apis
     module AnalyticsdataV1beta
       
+      # A metric actively restricted in creating the report.
+      class ActiveMetricRestriction
+        include Google::Apis::Core::Hashable
+      
+        # The name of the restricted metric.
+        # Corresponds to the JSON property `metricName`
+        # @return [String]
+        attr_accessor :metric_name
+      
+        # The reason for this metric's restriction.
+        # Corresponds to the JSON property `restrictedMetricTypes`
+        # @return [Array<String>]
+        attr_accessor :restricted_metric_types
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @metric_name = args[:metric_name] if args.key?(:metric_name)
+          @restricted_metric_types = args[:restricted_metric_types] if args.key?(:restricted_metric_types)
+        end
+      end
+      
       # The batch request containing multiple pivot report requests.
       class BatchRunPivotReportsRequest
         include Google::Apis::Core::Hashable
@@ -481,7 +506,7 @@ module Google
         # string that you 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_]$". Dimensions are referenced by `name` in `
+        # regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `
         # dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
         # Corresponds to the JSON property `name`
         # @return [String]
@@ -863,7 +888,7 @@ module Google
         # would like 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_]$". Metrics are referenced by `name` in `metricFilter`
+        # expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`
         # , `orderBys`, and metric `expression`.
         # Corresponds to the JSON property `name`
         # @return [String]
@@ -945,6 +970,16 @@ module Google
         # @return [String]
         attr_accessor :api_name
       
+        # 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).
+        # Corresponds to the JSON property `blockedReasons`
+        # @return [Array<String>]
+        attr_accessor :blocked_reasons
+      
         # The display name of the category that this metrics belongs to. Similar
         # dimensions and metrics are categorized together.
         # Corresponds to the JSON property `category`
@@ -995,6 +1030,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @api_name = args[:api_name] if args.key?(:api_name)
+          @blocked_reasons = args[:blocked_reasons] if args.key?(:blocked_reasons)
           @category = args[:category] if args.key?(:category)
           @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
           @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
@@ -1416,6 +1452,18 @@ module Google
       class ResponseMetaData
         include Google::Apis::Core::Hashable
       
+        # 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.
+        # Corresponds to the JSON property `currencyCode`
+        # @return [String]
+        attr_accessor :currency_code
+      
         # If true, indicates some buckets of dimension combinations are rolled into "(
         # other)" row. This can happen for high cardinality reports.
         # Corresponds to the JSON property `dataLossFromOtherRow`
@@ -1423,13 +1471,50 @@ module Google
         attr_accessor :data_loss_from_other_row
         alias_method :data_loss_from_other_row?, :data_loss_from_other_row
       
+        # If empty reason is specified, the report is empty for this reason.
+        # Corresponds to the JSON property `emptyReason`
+        # @return [String]
+        attr_accessor :empty_reason
+      
+        # 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).
+        # Corresponds to the JSON property `schemaRestrictionResponse`
+        # @return [Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse]
+        attr_accessor :schema_restriction_response
+      
+        # If `thresholdingApplied` is true, this report has thresholding applied and
+        # only returns data that meets the minimum aggregation thresholds. This boolean
+        # only indicates if thresholding was applied. It is possible for thresholding to
+        # be applied and no data is absent from the report, and this happens when all
+        # data is above the thresholds. To learn more, see [Data thresholds](https://
+        # support.google.com/analytics/answer/9383630) and [About Demographics and
+        # Interests](https://support.google.com/analytics/answer/2799357).
+        # Corresponds to the JSON property `thresholdingApplied`
+        # @return [Boolean]
+        attr_accessor :thresholding_applied
+        alias_method :thresholding_applied?, :thresholding_applied
+      
+        # 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".
+        # Corresponds to the JSON property `timeZone`
+        # @return [String]
+        attr_accessor :time_zone
+      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
+          @currency_code = args[:currency_code] if args.key?(:currency_code)
           @data_loss_from_other_row = args[:data_loss_from_other_row] if args.key?(:data_loss_from_other_row)
+          @empty_reason = args[:empty_reason] if args.key?(:empty_reason)
+          @schema_restriction_response = args[:schema_restriction_response] if args.key?(:schema_restriction_response)
+          @thresholding_applied = args[:thresholding_applied] if args.key?(:thresholding_applied)
+          @time_zone = args[:time_zone] if args.key?(:time_zone)
         end
       end
       
@@ -2037,6 +2122,30 @@ module Google
         end
       end
       
+      # 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).
+      class SchemaRestrictionResponse
+        include Google::Apis::Core::Hashable
+      
+        # 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`.
+        # Corresponds to the JSON property `activeMetricRestrictions`
+        # @return [Array<Google::Apis::AnalyticsdataV1beta::ActiveMetricRestriction>]
+        attr_accessor :active_metric_restrictions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @active_metric_restrictions = args[:active_metric_restrictions] if args.key?(:active_metric_restrictions)
+        end
+      end
+      
       # The filter for string
       class StringFilter
         include Google::Apis::Core::Hashable

data/lib/google/apis/analyticsdata_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AnalyticsdataV1beta
       # Version of the google-apis-analyticsdata_v1beta gem
-      GEM_VERSION = "0.6.0"
+      GEM_VERSION = "0.10.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210824"
+      REVISION = "20211203"
     end
   end
 end

data/lib/google/apis/analyticsdata_v1beta/representations.rb

@@ -22,6 +22,12 @@ module Google
   module Apis
     module AnalyticsdataV1beta
       
+      class ActiveMetricRestriction
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class BatchRunPivotReportsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -328,12 +334,26 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class SchemaRestrictionResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class StringFilter
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ActiveMetricRestriction
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :metric_name, as: 'metricName'
+          collection :restricted_metric_types, as: 'restrictedMetricTypes'
+        end
+      end
+      
       class BatchRunPivotReportsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -615,6 +635,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :api_name, as: 'apiName'
+          collection :blocked_reasons, as: 'blockedReasons'
           property :category, as: 'category'
           property :custom_definition, as: 'customDefinition'
           collection :deprecated_api_names, as: 'deprecatedApiNames'
@@ -751,7 +772,13 @@ module Google
       class ResponseMetaData
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :currency_code, as: 'currencyCode'
           property :data_loss_from_other_row, as: 'dataLossFromOtherRow'
+          property :empty_reason, as: 'emptyReason'
+          property :schema_restriction_response, as: 'schemaRestrictionResponse', class: Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse, decorator: Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse::Representation
+      
+          property :thresholding_applied, as: 'thresholdingApplied'
+          property :time_zone, as: 'timeZone'
         end
       end
       
@@ -904,6 +931,14 @@ module Google
         end
       end
       
+      class SchemaRestrictionResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :active_metric_restrictions, as: 'activeMetricRestrictions', class: Google::Apis::AnalyticsdataV1beta::ActiveMetricRestriction, decorator: Google::Apis::AnalyticsdataV1beta::ActiveMetricRestriction::Representation
+      
+        end
+      end
+      
       class StringFilter
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-analyticsdata_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
-  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.6.0
-  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-analyticsdata_v1beta
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.10.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta
 post_install_message: 
 rdoc_options: []
 require_paths: