google-apis-chromeuxreport_v1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c997bfddc1b756ff1c218a9b651f09dd45f262afb733e3f35ddba4e4403dc2c8
+  data.tar.gz: 9f269562dfc2f8ec54955c607a36251ed780d657d87649be4f7dd1c0a8cdaa52
+SHA512:
+  metadata.gz: 7bbf03608085b60df946ae82768c46b9bcaa9140e9128bd4a367b9f421a121cd7b23420e500301142f7db410cefd8bd1a686f723193117365cf3f0eabbb5daf6
+  data.tar.gz: c0c3bb5d5629772e4506bec5409e74c084177a9d2beb06b44831d100c944af298c93fe4917302427a39e47047e85f8c63655e0915458b6b41f92c5afaf42dadd

data/.yardopts

@@ -0,0 +1,13 @@
+--hide-void-return
+--no-private
+--verbose
+--title=google-apis-chromeuxreport_v1
+--markup-provider=redcarpet
+--markup=markdown
+--main OVERVIEW.md
+lib/google/apis/chromeuxreport_v1/*.rb
+lib/google/apis/chromeuxreport_v1.rb
+-
+OVERVIEW.md
+CHANGELOG.md
+LICENSE.md

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release history for google-apis-chromeuxreport_v1
+
+### v0.1.0 (2021-01-07)
+
+* Regenerated using generator version 0.1.1
+* Regenerated from discovery document revision 20200803
+

data/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                  Apache License
+                            Version 2.0, January 2004
+                         http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+       "License" shall mean the terms and conditions for use, reproduction,
+       and distribution as defined by Sections 1 through 9 of this document.
+
+       "Licensor" shall mean the copyright owner or entity authorized by
+       the copyright owner that is granting the License.
+
+       "Legal Entity" shall mean the union of the acting entity and all
+       other entities that control, are controlled by, or are under common
+       control with that entity. For the purposes of this definition,
+       "control" means (i) the power, direct or indirect, to cause the
+       direction or management of such entity, whether by contract or
+       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+       outstanding shares, or (iii) beneficial ownership of such entity.
+
+       "You" (or "Your") shall mean an individual or Legal Entity
+       exercising permissions granted by this License.
+
+       "Source" form shall mean the preferred form for making modifications,
+       including but not limited to software source code, documentation
+       source, and configuration files.
+
+       "Object" form shall mean any form resulting from mechanical
+       transformation or translation of a Source form, including but
+       not limited to compiled object code, generated documentation,
+       and conversions to other media types.
+
+       "Work" shall mean the work of authorship, whether in Source or
+       Object form, made available under the License, as indicated by a
+       copyright notice that is included in or attached to the work
+       (an example is provided in the Appendix below).
+
+       "Derivative Works" shall mean any work, whether in Source or Object
+       form, that is based on (or derived from) the Work and for which the
+       editorial revisions, annotations, elaborations, or other modifications
+       represent, as a whole, an original work of authorship. For the purposes
+       of this License, Derivative Works shall not include works that remain
+       separable from, or merely link (or bind by name) to the interfaces of,
+       the Work and Derivative Works thereof.
+
+       "Contribution" shall mean any work of authorship, including
+       the original version of the Work and any modifications or additions
+       to that Work or Derivative Works thereof, that is intentionally
+       submitted to Licensor for inclusion in the Work by the copyright owner
+       or by an individual or Legal Entity authorized to submit on behalf of
+       the copyright owner. For the purposes of this definition, "submitted"
+       means any form of electronic, verbal, or written communication sent
+       to the Licensor or its representatives, including but not limited to
+       communication on electronic mailing lists, source code control systems,
+       and issue tracking systems that are managed by, or on behalf of, the
+       Licensor for the purpose of discussing and improving the Work, but
+       excluding communication that is conspicuously marked or otherwise
+       designated in writing by the copyright owner as "Not a Contribution."
+
+       "Contributor" shall mean Licensor and any individual or Legal Entity
+       on behalf of whom a Contribution has been received by Licensor and
+       subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       copyright license to reproduce, prepare Derivative Works of,
+       publicly display, publicly perform, sublicense, and distribute the
+       Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       (except as stated in this section) patent license to make, have made,
+       use, offer to sell, sell, import, and otherwise transfer the Work,
+       where such license applies only to those patent claims licensable
+       by such Contributor that are necessarily infringed by their
+       Contribution(s) alone or by combination of their Contribution(s)
+       with the Work to which such Contribution(s) was submitted. If You
+       institute patent litigation against any entity (including a
+       cross-claim or counterclaim in a lawsuit) alleging that the Work
+       or a Contribution incorporated within the Work constitutes direct
+       or contributory patent infringement, then any patent licenses
+       granted to You under this License for that Work shall terminate
+       as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+       Work or Derivative Works thereof in any medium, with or without
+       modifications, and in Source or Object form, provided that You
+       meet the following conditions:
+
+       (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+       (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+       (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+       (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+       You may add Your own copyright statement to Your modifications and
+       may provide additional or different license terms and conditions
+       for use, reproduction, or distribution of Your modifications, or
+       for any such Derivative Works as a whole, provided Your use,
+       reproduction, and distribution of the Work otherwise complies with
+       the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+       any Contribution intentionally submitted for inclusion in the Work
+       by You to the Licensor shall be under the terms and conditions of
+       this License, without any additional terms or conditions.
+       Notwithstanding the above, nothing herein shall supersede or modify
+       the terms of any separate license agreement you may have executed
+       with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+       names, trademarks, service marks, or product names of the Licensor,
+       except as required for reasonable and customary use in describing the
+       origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+       agreed to in writing, Licensor provides the Work (and each
+       Contributor provides its Contributions) on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+       implied, including, without limitation, any warranties or conditions
+       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+       PARTICULAR PURPOSE. You are solely responsible for determining the
+       appropriateness of using or redistributing the Work and assume any
+       risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+       whether in tort (including negligence), contract, or otherwise,
+       unless required by applicable law (such as deliberate and grossly
+       negligent acts) or agreed to in writing, shall any Contributor be
+       liable to You for damages, including any direct, indirect, special,
+       incidental, or consequential damages of any character arising as a
+       result of this License or out of the use or inability to use the
+       Work (including but not limited to damages for loss of goodwill,
+       work stoppage, computer failure or malfunction, or any and all
+       other commercial damages or losses), even if such Contributor
+       has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+       the Work or Derivative Works thereof, You may choose to offer,
+       and charge a fee for, acceptance of support, warranty, indemnity,
+       or other liability obligations and/or rights consistent with this
+       License. However, in accepting such obligations, You may act only
+       on Your own behalf and on Your sole responsibility, not on behalf
+       of any other Contributor, and only if You agree to indemnify,
+       defend, and hold each Contributor harmless for any liability
+       incurred by, or claims asserted against, such Contributor by reason
+       of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+       To apply the Apache License to your work, attach the following
+       boilerplate notice, with the fields enclosed by brackets "[]"
+       replaced with your own identifying information. (Don't include
+       the brackets!)  The text should be enclosed in the appropriate
+       comment syntax for the file format. We also recommend that a
+       file or class name and description of purpose be included on the
+       same "printed page" as the copyright notice for easier
+       identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/OVERVIEW.md

@@ -0,0 +1,96 @@
+# Simple REST client for version V1 of the Chrome UX Report API
+
+This is a simple client library for version V1 of the Chrome UX Report API. It provides:
+
+* A client object that connects to the HTTP/JSON REST endpoint for the service.
+* Ruby objects for data structures related to the service.
+* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
+* Control of retry, pagination, and timeouts.
+
+Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
+
+## Getting started
+
+### Before you begin
+
+There are a few setup steps you need to complete before you can use this library:
+
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/chromeuxreport.googleapis.com) in the console.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-apis-chromeuxreport_v1', '~> 0.1'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install google-apis-chromeuxreport_v1
+```
+
+### Creating a client object
+
+Once the gem is installed, you can load the client code and instantiate a client.
+
+```ruby
+# Load the client
+require "google/apis/chromeuxreport_v1"
+
+# Create a client object
+client = Google::Apis::ChromeuxreportV1::ChromeUXReportService.new
+
+# Authenticate calls
+client.authentication = # ... use the googleauth gem to create credentials
+```
+
+See the class reference docs for information on the methods you can call from a client.
+
+## Documentation
+
+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.
+
+(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Chromeuxreport service in particular.)
+
+For reference information on specific calls in the Chrome UX Report API, see the {Google::Apis::ChromeuxreportV1::ChromeUXReportService class reference docs}.
+
+## Which client should I use?
+
+Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
+
+This library, `google-apis-chromeuxreport_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
+
+Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
+
+Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
+
+**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
+
+The [product documentation](https://developers.google.com/web/tools/chrome-user-experience-report/api/reference) may provide guidance regarding the preferred client library to use.
+
+## Supported Ruby versions
+
+This library is supported on Ruby 2.5+.
+
+Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
+
+## Support
+
+Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-apis-chromeuxreport_v1.rb

@@ -0,0 +1,15 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/apis/chromeuxreport_v1"

data/lib/google/apis/chromeuxreport_v1.rb

@@ -0,0 +1,34 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/chromeuxreport_v1/service.rb'
+require 'google/apis/chromeuxreport_v1/classes.rb'
+require 'google/apis/chromeuxreport_v1/representations.rb'
+require 'google/apis/chromeuxreport_v1/gem_version.rb'
+
+module Google
+  module Apis
+    # Chrome UX Report API
+    #
+    # The Chrome UX Report API lets you view real user experience data for millions
+    # of websites.
+    #
+    # @see https://developers.google.com/web/tools/chrome-user-experience-report/api/reference
+    module ChromeuxreportV1
+      # Version of the Chrome UX Report API this client connects to.
+      # This is NOT the gem version.
+      VERSION = 'V1'
+    end
+  end
+end

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

@@ -0,0 +1,308 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module ChromeuxreportV1
+      
+      # 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 Bin
+        include Google::Apis::Core::Hashable
+      
+        # The proportion of users that experienced this bin's value for the given metric.
+        # Corresponds to the JSON property `density`
+        # @return [Float]
+        attr_accessor :density
+      
+        # 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)
+          @density = args[:density] if args.key?(:density)
+          @end = args[:end] if args.key?(:end)
+          @start = args[:start] if args.key?(:start)
+        end
+      end
+      
+      # Key defines all the dimensions that identify this record as unique.
+      class Key
+        include Google::Apis::Core::Hashable
+      
+        # The effective connection type is the general connection class that all users
+        # experienced for this record. This field uses the values ["offline", "slow-2G",
+        # "2G", "3G", "4G"] as specified in: https://wicg.github.io/netinfo/#effective-
+        # connection-types If the effective connection type is unspecified, then
+        # aggregated data over all effective connection types will be returned.
+        # Corresponds to the JSON property `effectiveConnectionType`
+        # @return [String]
+        attr_accessor :effective_connection_type
+      
+        # 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. 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)
+          @effective_connection_type = args[:effective_connection_type] if args.key?(:effective_connection_type)
+          @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
+      
+      # A `metric` 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`.
+      class Metric
+        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.
+        # Corresponds to the JSON property `histogram`
+        # @return [Array<Google::Apis::ChromeuxreportV1::Bin>]
+        attr_accessor :histogram
+      
+        # 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 `percentiles`
+        # @return [Google::Apis::ChromeuxreportV1::Percentiles]
+        attr_accessor :percentiles
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @histogram = args[:histogram] if args.key?(:histogram)
+          @percentiles = args[:percentiles] if args.key?(:percentiles)
+        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 Percentiles
+        include Google::Apis::Core::Hashable
+      
+        # 75% of users experienced the given metric at or below this value.
+        # Corresponds to the JSON property `p75`
+        # @return [Object]
+        attr_accessor :p75
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @p75 = args[:p75] if args.key?(:p75)
+        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
+        include Google::Apis::Core::Hashable
+      
+        # The effective connection type is a query dimension that specifies the
+        # effective network class that the record's data should belong to. This field
+        # uses the values ["offline", "slow-2G", "2G", "3G", "4G"] as specified in:
+        # https://wicg.github.io/netinfo/#effective-connection-types Note: If no
+        # effective connection type is specified, then a special record with aggregated
+        # data over all effective connection types will be returned.
+        # Corresponds to the JSON property `effectiveConnectionType`
+        # @return [String]
+        attr_accessor :effective_connection_type
+      
+        # 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"]
+        # 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)
+          @effective_connection_type = args[:effective_connection_type] if args.key?(:effective_connection_type)
+          @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 `QueryRequest`. The
+      # returned response will have a record, and sometimes details on normalization
+      # actions taken on the request that were necessary to make the request
+      # successful.
+      class QueryResponse
+        include Google::Apis::Core::Hashable
+      
+        # Record is a single Chrome UX report data record. It contains use experience
+        # statistics for a single url pattern and set of dimensions.
+        # Corresponds to the JSON property `record`
+        # @return [Google::Apis::ChromeuxreportV1::Record]
+        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
+      
+      # Record is a single Chrome UX report data record. It contains use experience
+      # statistics for a single url pattern and set of dimensions.
+      class Record
+        include Google::Apis::Core::Hashable
+      
+        # Key defines all the dimensions that identify this record as unique.
+        # Corresponds to the JSON property `key`
+        # @return [Google::Apis::ChromeuxreportV1::Key]
+        attr_accessor :key
+      
+        # 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"]
+        # Corresponds to the JSON property `metrics`
+        # @return [Hash<String,Google::Apis::ChromeuxreportV1::Metric>]
+        attr_accessor :metrics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @key = args[:key] if args.key?(:key)
+          @metrics = args[:metrics] if args.key?(:metrics)
+        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
+      # known to fail. Complex actions like following redirects are not handled.
+      class UrlNormalization
+        include Google::Apis::Core::Hashable
+      
+        # The URL after any normalization actions. This is a valid user experience URL
+        # that could reasonably be looked up.
+        # Corresponds to the JSON property `normalizedUrl`
+        # @return [String]
+        attr_accessor :normalized_url
+      
+        # The original requested URL prior to any normalization actions.
+        # Corresponds to the JSON property `originalUrl`
+        # @return [String]
+        attr_accessor :original_url
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @normalized_url = args[:normalized_url] if args.key?(:normalized_url)
+          @original_url = args[:original_url] if args.key?(:original_url)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Apis
+    module ChromeuxreportV1
+      # Version of the google-apis-chromeuxreport_v1 gem
+      GEM_VERSION = "0.1.0"
+
+      # Version of the code generator used to generate this client
+      GENERATOR_VERSION = "0.1.1"
+
+      # Revision of the discovery document this client was generated from
+      REVISION = "20200803"
+    end
+  end
+end

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

@@ -0,0 +1,149 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module ChromeuxreportV1
+      
+      class Bin
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Key
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Metric
+        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 QueryRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class QueryResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Record
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class UrlNormalization
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Bin
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :density, as: 'density'
+          property :end, as: 'end'
+          property :start, as: 'start'
+        end
+      end
+      
+      class Key
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :effective_connection_type, as: 'effectiveConnectionType'
+          property :form_factor, as: 'formFactor'
+          property :origin, as: 'origin'
+          property :url, as: 'url'
+        end
+      end
+      
+      class Metric
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :histogram, as: 'histogram', class: Google::Apis::ChromeuxreportV1::Bin, decorator: Google::Apis::ChromeuxreportV1::Bin::Representation
+      
+          property :percentiles, as: 'percentiles', class: Google::Apis::ChromeuxreportV1::Percentiles, decorator: Google::Apis::ChromeuxreportV1::Percentiles::Representation
+      
+        end
+      end
+      
+      class Percentiles
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :p75, as: 'p75'
+        end
+      end
+      
+      class QueryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :effective_connection_type, as: 'effectiveConnectionType'
+          property :form_factor, as: 'formFactor'
+          collection :metrics, as: 'metrics'
+          property :origin, as: 'origin'
+          property :url, as: 'url'
+        end
+      end
+      
+      class QueryResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :record, as: 'record', class: Google::Apis::ChromeuxreportV1::Record, decorator: Google::Apis::ChromeuxreportV1::Record::Representation
+      
+          property :url_normalization_details, as: 'urlNormalizationDetails', class: Google::Apis::ChromeuxreportV1::UrlNormalization, decorator: Google::Apis::ChromeuxreportV1::UrlNormalization::Representation
+      
+        end
+      end
+      
+      class Record
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :key, as: 'key', class: Google::Apis::ChromeuxreportV1::Key, decorator: Google::Apis::ChromeuxreportV1::Key::Representation
+      
+          hash :metrics, as: 'metrics', class: Google::Apis::ChromeuxreportV1::Metric, decorator: Google::Apis::ChromeuxreportV1::Metric::Representation
+      
+        end
+      end
+      
+      class UrlNormalization
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :normalized_url, as: 'normalizedUrl'
+          property :original_url, as: 'originalUrl'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module ChromeuxreportV1
+      # Chrome UX Report API
+      #
+      # The Chrome UX Report API lets you view real user experience data for millions
+      #  of websites.
+      #
+      # @example
+      #    require 'google/apis/chromeuxreport_v1'
+      #
+      #    Chromeuxreport = Google::Apis::ChromeuxreportV1 # Alias the module
+      #    service = Chromeuxreport::ChromeUXReportService.new
+      #
+      # @see https://developers.google.com/web/tools/chrome-user-experience-report/api/reference
+      class ChromeUXReportService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  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.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://chromeuxreport.googleapis.com/', '',
+                client_name: 'google-apis-chromeuxreport_v1',
+                client_version: Google::Apis::ChromeuxreportV1::GEM_VERSION)
+          @batch_path = 'batch'
+        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.
+        # @param [Google::Apis::ChromeuxreportV1::QueryRequest] query_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::QueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromeuxreportV1::QueryResponse]
+        #
+        # @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_record(query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/records:queryRecord', options)
+          command.request_representation = Google::Apis::ChromeuxreportV1::QueryRequest::Representation
+          command.request_object = query_request_object
+          command.response_representation = Google::Apis::ChromeuxreportV1::QueryResponse::Representation
+          command.response_class = Google::Apis::ChromeuxreportV1::QueryResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: google-apis-chromeuxreport_v1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: This is the simple REST client for Chrome UX Report API V1. Simple REST
+  clients are Ruby client libraries that provide access to Google services via their
+  HTTP REST API endpoints. These libraries are generated and updated automatically
+  based on the discovery documents published by the service, and they handle most
+  concerns such as authentication, pagination, retry, timeouts, and logging. You can
+  use this client to access the Chrome UX Report API, but note that some services
+  may provide a separate modern client that is easier to use.
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- OVERVIEW.md
+- lib/google-apis-chromeuxreport_v1.rb
+- lib/google/apis/chromeuxreport_v1.rb
+- lib/google/apis/chromeuxreport_v1/classes.rb
+- lib/google/apis/chromeuxreport_v1/gem_version.rb
+- lib/google/apis/chromeuxreport_v1/representations.rb
+- lib/google/apis/chromeuxreport_v1/service.rb
+homepage: https://github.com/google/google-api-ruby-client
+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-chromeuxreport_v1/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-chromeuxreport_v1/v0.1.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-chromeuxreport_v1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Simple REST client for Chrome UX Report API V1
+test_files: []