google-apis-chromeuxreport_v1 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb5b09076cb07cfa61c1215fe3cc186aa7dae1e0317256b9aff2aaafbe6970cc
-  data.tar.gz: '08192fac46b4369a8943b27f9a7caf9301039363f08c57ae3aea9833be609fa9'
+  metadata.gz: 64fff11ebf66b6e1c010e6840bb527a9e5f305c4109a81cf5045ee6faf03d764
+  data.tar.gz: 28183830081fa24e34229ada484397bc7fb03729bd8731875b5859d32a2a1033
 SHA512:
-  metadata.gz: 3392c219539bb315732d802109b099dbf5c39b5bbca37b07662a1e65ae6c72241b7617b7a3844a27c591633cbb2dce9c3c00996ecd6918c42bae8b7a7d6bb395
-  data.tar.gz: dd2177de6b199d5b268cfed1e3feb94b5cf8fe66250189f23a9d581ee37c7368911bbfef3dfa7b6af049a214944b27de725238af5bd0b3763c413c231988717b
+  metadata.gz: 7313c8872580873d15c68585bbcaac0fd485530783feac7a60425b862b7a152d8d1ffa828c1e18ed09a6d8def32088803d04128ad443fb4c833a9844c851aaae
+  data.tar.gz: 2e38a61c033d836b23c0fda17637ae30f767eaff86ae47a9b5a985fe6b64ad3197d84aee0a66b09bc7b5aff8e80a79b8b6917521f2f79051086f4ec884504e3c

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-chromeuxreport_v1
 
+### v0.18.0 (2023-02-12)
+
+* Regenerated from discovery document revision 20230206
+
+### v0.17.0 (2023-01-22)
+
+* Regenerated from discovery document revision 20230117
+* Regenerated using generator version 0.11.1
+
 ### v0.16.0 (2022-10-30)
 
 * Regenerated using generator version 0.11.0

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

@@ -141,6 +141,83 @@ module Google
         end
       end
       
+      # Key defines all the dimensions that identify this record as unique.
+      class HistoryKey
+        include Google::Apis::Core::Hashable
+      
+        # The form factor is the device class that all users used to access the site for
+        # this record. If the form factor is unspecified, then aggregated data over all
+        # form factors will be returned.
+        # Corresponds to the JSON property `formFactor`
+        # @return [String]
+        attr_accessor :form_factor
+      
+        # Origin specifies the origin that this record is for. Note: When specifying an
+        # origin, data for loads under this origin over all pages are aggregated into
+        # origin level user experience data.
+        # Corresponds to the JSON property `origin`
+        # @return [String]
+        attr_accessor :origin
+      
+        # Url specifies a specific url that this record is for. This url should be
+        # normalized, following the normalization actions taken in the request to
+        # increase the chances of successful lookup. Note: When specifying a "url" only
+        # data for that specific url will be aggregated.
+        # Corresponds to the JSON property `url`
+        # @return [String]
+        attr_accessor :url
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @form_factor = args[:form_factor] if args.key?(:form_factor)
+          @origin = args[:origin] if args.key?(:origin)
+          @url = args[:url] if args.key?(:url)
+        end
+      end
+      
+      # HistoryRecord is a timeseries of Chrome UX Report data. It contains user
+      # experience statistics for a single url pattern and a set of dimensions.
+      class HistoryRecord
+        include Google::Apis::Core::Hashable
+      
+        # The collection periods indicate when each of the data points reflected in the
+        # time series data in metrics was collected. Note that all the time series share
+        # the same collection periods, and it is enforced in the CrUX pipeline that
+        # every time series has the same number of data points.
+        # Corresponds to the JSON property `collectionPeriods`
+        # @return [Array<Google::Apis::ChromeuxreportV1::CollectionPeriod>]
+        attr_accessor :collection_periods
+      
+        # Key defines all the dimensions that identify this record as unique.
+        # Corresponds to the JSON property `key`
+        # @return [Google::Apis::ChromeuxreportV1::HistoryKey]
+        attr_accessor :key
+      
+        # Metrics is the map of user experience time series data available for the
+        # record defined in the key field. Metrics are keyed on the metric name. Allowed
+        # key values: ["first_contentful_paint", "first_input_delay", "
+        # largest_contentful_paint", "cumulative_layout_shift", "
+        # experimental_time_to_first_byte", "experimental_interaction_to_next_paint"]
+        # Corresponds to the JSON property `metrics`
+        # @return [Hash<String,Google::Apis::ChromeuxreportV1::MetricTimeseries>]
+        attr_accessor :metrics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @collection_periods = args[:collection_periods] if args.key?(:collection_periods)
+          @key = args[:key] if args.key?(:key)
+          @metrics = args[:metrics] if args.key?(:metrics)
+        end
+      end
+      
       # Key defines all the dimensions that identify this record as unique.
       class Key
         include Google::Apis::Core::Hashable
@@ -217,6 +294,38 @@ module Google
         end
       end
       
+      # A `metric timeseries` is a set of user experience data for a single web
+      # performance metric, like "first contentful paint". It contains a summary
+      # histogram of real world Chrome usage as a series of `bins`, where each bin has
+      # density values for a particular time period.
+      class MetricTimeseries
+        include Google::Apis::Core::Hashable
+      
+        # The histogram of user experiences for a metric. The histogram will have at
+        # least one bin and the densities of all bins will add up to ~1, for each
+        # timeseries entry.
+        # Corresponds to the JSON property `histogramTimeseries`
+        # @return [Array<Google::Apis::ChromeuxreportV1::TimeseriesBin>]
+        attr_accessor :histogram_timeseries
+      
+        # Percentiles contains synthetic values of a metric at a given statistical
+        # percentile. These are used for estimating a metric's value as experienced by a
+        # percentage of users out of the total number of users.
+        # Corresponds to the JSON property `percentilesTimeseries`
+        # @return [Google::Apis::ChromeuxreportV1::TimeseriesPercentiles]
+        attr_accessor :percentiles_timeseries
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @histogram_timeseries = args[:histogram_timeseries] if args.key?(:histogram_timeseries)
+          @percentiles_timeseries = args[:percentiles_timeseries] if args.key?(:percentiles_timeseries)
+        end
+      end
+      
       # Percentiles contains synthetic values of a metric at a given statistical
       # percentile. These are used for estimating a metric's value as experienced by a
       # percentage of users out of the total number of users.
@@ -238,6 +347,85 @@ module Google
         end
       end
       
+      # Request payload sent by a physical web client. This request includes all
+      # necessary context to load a particular user experience history record.
+      class QueryHistoryRequest
+        include Google::Apis::Core::Hashable
+      
+        # The form factor is a query dimension that specifies the device class that the
+        # record's data should belong to. Note: If no form factor is specified, then a
+        # special record with aggregated data over all form factors will be returned.
+        # Corresponds to the JSON property `formFactor`
+        # @return [String]
+        attr_accessor :form_factor
+      
+        # The metrics that should be included in the response. If none are specified
+        # then any metrics found will be returned. Allowed values: ["
+        # first_contentful_paint", "first_input_delay", "largest_contentful_paint", "
+        # cumulative_layout_shift", "experimental_time_to_first_byte", "
+        # experimental_interaction_to_next_paint"]
+        # Corresponds to the JSON property `metrics`
+        # @return [Array<String>]
+        attr_accessor :metrics
+      
+        # The url pattern "origin" refers to a url pattern that is the origin of a
+        # website. Examples: "https://example.com", "https://cloud.google.com"
+        # Corresponds to the JSON property `origin`
+        # @return [String]
+        attr_accessor :origin
+      
+        # The url pattern "url" refers to a url pattern that is any arbitrary url.
+        # Examples: "https://example.com/", "https://cloud.google.com/why-google-cloud/"
+        # Corresponds to the JSON property `url`
+        # @return [String]
+        attr_accessor :url
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @form_factor = args[:form_factor] if args.key?(:form_factor)
+          @metrics = args[:metrics] if args.key?(:metrics)
+          @origin = args[:origin] if args.key?(:origin)
+          @url = args[:url] if args.key?(:url)
+        end
+      end
+      
+      # Response payload sent back to a physical web client. This response contains
+      # the record found based on the identiers present in a `QueryHistoryRequest`.
+      # The returned response will have a history record, and sometimes details on
+      # normalization actions taken on the request that were necessary to make the
+      # request successful.
+      class QueryHistoryResponse
+        include Google::Apis::Core::Hashable
+      
+        # HistoryRecord is a timeseries of Chrome UX Report data. It contains user
+        # experience statistics for a single url pattern and a set of dimensions.
+        # Corresponds to the JSON property `record`
+        # @return [Google::Apis::ChromeuxreportV1::HistoryRecord]
+        attr_accessor :record
+      
+        # Object representing the normalization actions taken to normalize a url to
+        # achieve a higher chance of successful lookup. These are simple automated
+        # changes that are taken when looking up the provided `url_patten` would be
+        # known to fail. Complex actions like following redirects are not handled.
+        # Corresponds to the JSON property `urlNormalizationDetails`
+        # @return [Google::Apis::ChromeuxreportV1::UrlNormalization]
+        attr_accessor :url_normalization_details
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @record = args[:record] if args.key?(:record)
+          @url_normalization_details = args[:url_normalization_details] if args.key?(:url_normalization_details)
+        end
+      end
+      
       # Request payload sent by a physical web client. This request includes all
       # necessary context to load a particular user experience record.
       class QueryRequest
@@ -347,7 +535,8 @@ module Google
         # Metrics is the map of user experience data available for the record defined in
         # the key field. Metrics are keyed on the metric name. Allowed key values: ["
         # first_contentful_paint", "first_input_delay", "largest_contentful_paint", "
-        # cumulative_layout_shift"]
+        # cumulative_layout_shift", "experimental_time_to_first_byte", "
+        # experimental_interaction_to_next_paint"]
         # Corresponds to the JSON property `metrics`
         # @return [Hash<String,Google::Apis::ChromeuxreportV1::Metric>]
         attr_accessor :metrics
@@ -364,6 +553,73 @@ module Google
         end
       end
       
+      # A bin is a discrete portion of data spanning from start to end, or if no end
+      # is given, then from start to +inf. A bin's start and end values are given in
+      # the value type of the metric it represents. For example, "first contentful
+      # paint" is measured in milliseconds and exposed as ints, therefore its metric
+      # bins will use int32s for its start and end types. However, "cumulative layout
+      # shift" is measured in unitless decimals and is exposed as a decimal encoded as
+      # a string, therefore its metric bins will use strings for its value type.
+      class TimeseriesBin
+        include Google::Apis::Core::Hashable
+      
+        # The proportion of users that experienced this bin's value for the given metric
+        # in a given collection period; the index for each of these entries corresponds
+        # to an entry in the CollectionPeriods field in the HistoryRecord message, which
+        # describes when the density was observed in the field. Thus, the length of this
+        # list of densities is equal to the length of the CollectionPeriods field in the
+        # HistoryRecord message.
+        # Corresponds to the JSON property `densities`
+        # @return [Array<Float>]
+        attr_accessor :densities
+      
+        # End is the end of the data bin. If end is not populated, then the bin has no
+        # end and is valid from start to +inf.
+        # Corresponds to the JSON property `end`
+        # @return [Object]
+        attr_accessor :end
+      
+        # Start is the beginning of the data bin.
+        # Corresponds to the JSON property `start`
+        # @return [Object]
+        attr_accessor :start
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @densities = args[:densities] if args.key?(:densities)
+          @end = args[:end] if args.key?(:end)
+          @start = args[:start] if args.key?(:start)
+        end
+      end
+      
+      # Percentiles contains synthetic values of a metric at a given statistical
+      # percentile. These are used for estimating a metric's value as experienced by a
+      # percentage of users out of the total number of users.
+      class TimeseriesPercentiles
+        include Google::Apis::Core::Hashable
+      
+        # 75% of users experienced the given metric at or below this value. The length
+        # of this list of densities is equal to the length of the CollectionPeriods
+        # field in the HistoryRecord message, which describes when the density was
+        # observed in the field.
+        # Corresponds to the JSON property `p75s`
+        # @return [Array<Object>]
+        attr_accessor :p75s
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @p75s = args[:p75s] if args.key?(:p75s)
+        end
+      end
+      
       # Object representing the normalization actions taken to normalize a url to
       # achieve a higher chance of successful lookup. These are simple automated
       # changes that are taken when looking up the provided `url_patten` would be

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module ChromeuxreportV1
       # Version of the google-apis-chromeuxreport_v1 gem
-      GEM_VERSION = "0.16.0"
+      GEM_VERSION = "0.18.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.11.0"
+      GENERATOR_VERSION = "0.11.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220919"
+      REVISION = "20230206"
     end
   end
 end

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

@@ -40,6 +40,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class HistoryKey
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class HistoryRecord
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Key
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -52,12 +64,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class MetricTimeseries
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Percentiles
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class QueryHistoryRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class QueryHistoryResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class QueryRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -76,6 +106,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TimeseriesBin
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class TimeseriesPercentiles
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class UrlNormalization
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -110,6 +152,27 @@ module Google
         end
       end
       
+      class HistoryKey
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :form_factor, as: 'formFactor'
+          property :origin, as: 'origin'
+          property :url, as: 'url'
+        end
+      end
+      
+      class HistoryRecord
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_periods, as: 'collectionPeriods', class: Google::Apis::ChromeuxreportV1::CollectionPeriod, decorator: Google::Apis::ChromeuxreportV1::CollectionPeriod::Representation
+      
+          property :key, as: 'key', class: Google::Apis::ChromeuxreportV1::HistoryKey, decorator: Google::Apis::ChromeuxreportV1::HistoryKey::Representation
+      
+          hash :metrics, as: 'metrics', class: Google::Apis::ChromeuxreportV1::MetricTimeseries, decorator: Google::Apis::ChromeuxreportV1::MetricTimeseries::Representation
+      
+        end
+      end
+      
       class Key
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -130,6 +193,16 @@ module Google
         end
       end
       
+      class MetricTimeseries
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :histogram_timeseries, as: 'histogramTimeseries', class: Google::Apis::ChromeuxreportV1::TimeseriesBin, decorator: Google::Apis::ChromeuxreportV1::TimeseriesBin::Representation
+      
+          property :percentiles_timeseries, as: 'percentilesTimeseries', class: Google::Apis::ChromeuxreportV1::TimeseriesPercentiles, decorator: Google::Apis::ChromeuxreportV1::TimeseriesPercentiles::Representation
+      
+        end
+      end
+      
       class Percentiles
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -137,6 +210,26 @@ module Google
         end
       end
       
+      class QueryHistoryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :form_factor, as: 'formFactor'
+          collection :metrics, as: 'metrics'
+          property :origin, as: 'origin'
+          property :url, as: 'url'
+        end
+      end
+      
+      class QueryHistoryResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :record, as: 'record', class: Google::Apis::ChromeuxreportV1::HistoryRecord, decorator: Google::Apis::ChromeuxreportV1::HistoryRecord::Representation
+      
+          property :url_normalization_details, as: 'urlNormalizationDetails', class: Google::Apis::ChromeuxreportV1::UrlNormalization, decorator: Google::Apis::ChromeuxreportV1::UrlNormalization::Representation
+      
+        end
+      end
+      
       class QueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -170,6 +263,22 @@ module Google
         end
       end
       
+      class TimeseriesBin
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :densities, as: 'densities'
+          property :end, as: 'end'
+          property :start, as: 'start'
+        end
+      end
+      
+      class TimeseriesPercentiles
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :p75s, as: 'p75s'
+        end
+      end
+      
       class UrlNormalization
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/chromeuxreport_v1/service.rb

@@ -50,6 +50,38 @@ module Google
           @batch_path = 'batch'
         end
         
+        # Queries the Chrome User Experience Report for a timeseries `history record`
+        # for a given site. Returns a `history record` that contains one or more `metric
+        # timeseries` corresponding to performance data about the requested site.
+        # @param [Google::Apis::ChromeuxreportV1::QueryHistoryRequest] query_history_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::ChromeuxreportV1::QueryHistoryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromeuxreportV1::QueryHistoryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def query_record_history_record(query_history_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/records:queryHistoryRecord', options)
+          command.request_representation = Google::Apis::ChromeuxreportV1::QueryHistoryRequest::Representation
+          command.request_object = query_history_request_object
+          command.response_representation = Google::Apis::ChromeuxreportV1::QueryHistoryResponse::Representation
+          command.response_class = Google::Apis::ChromeuxreportV1::QueryHistoryResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Queries the Chrome User Experience for a single `record` for a given site.
         # Returns a `record` that contains one or more `metrics` corresponding to
         # performance data about the requested site.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-chromeuxreport_v1
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chromeuxreport_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-chromeuxreport_v1/v0.16.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-chromeuxreport_v1/v0.18.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chromeuxreport_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Chrome UX Report API V1