google-apis-pagespeedonline_v5 0.1.0

data/lib/google/apis/pagespeedonline_v5/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 PagespeedonlineV5
+      # Version of the google-apis-pagespeedonline_v5 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 = "20201130"
+    end
+  end
+end

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

@@ -0,0 +1,361 @@
+# 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 PagespeedonlineV5
+      
+      class AuditRefs
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Bucket
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Categories
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class CategoryGroupV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ConfigSettings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Environment
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class I18n
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class LighthouseAuditResultV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class LighthouseCategoryV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class LighthouseResultV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PagespeedApiLoadingExperienceV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PagespeedApiPagespeedResponseV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PagespeedVersion
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RendererFormattedStrings
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RuntimeError
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class StackPack
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Timing
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class UserPageLoadMetricV5
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AuditRefs
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :group, as: 'group'
+          property :id, as: 'id'
+          property :weight, as: 'weight'
+        end
+      end
+      
+      class Bucket
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :max, as: 'max'
+          property :min, as: 'min'
+          property :proportion, as: 'proportion'
+        end
+      end
+      
+      class Categories
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :accessibility, as: 'accessibility', class: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5::Representation
+      
+          property :best_practices, as: 'best-practices', class: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5::Representation
+      
+          property :performance, as: 'performance', class: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5::Representation
+      
+          property :pwa, as: 'pwa', class: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5::Representation
+      
+          property :seo, as: 'seo', class: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseCategoryV5::Representation
+      
+        end
+      end
+      
+      class CategoryGroupV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :description, as: 'description'
+          property :title, as: 'title'
+        end
+      end
+      
+      class ConfigSettings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :channel, as: 'channel'
+          property :emulated_form_factor, as: 'emulatedFormFactor'
+          property :locale, as: 'locale'
+          property :only_categories, as: 'onlyCategories'
+        end
+      end
+      
+      class Environment
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :benchmark_index, as: 'benchmarkIndex'
+          property :host_user_agent, as: 'hostUserAgent'
+          property :network_user_agent, as: 'networkUserAgent'
+        end
+      end
+      
+      class I18n
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :renderer_formatted_strings, as: 'rendererFormattedStrings', class: Google::Apis::PagespeedonlineV5::RendererFormattedStrings, decorator: Google::Apis::PagespeedonlineV5::RendererFormattedStrings::Representation
+      
+        end
+      end
+      
+      class LighthouseAuditResultV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :description, as: 'description'
+          hash :details, as: 'details'
+          property :display_value, as: 'displayValue'
+          property :error_message, as: 'errorMessage'
+          property :explanation, as: 'explanation'
+          property :id, as: 'id'
+          property :numeric_value, as: 'numericValue'
+          property :score, as: 'score'
+          property :score_display_mode, as: 'scoreDisplayMode'
+          property :title, as: 'title'
+          property :warnings, as: 'warnings'
+        end
+      end
+      
+      class LighthouseCategoryV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :audit_refs, as: 'auditRefs', class: Google::Apis::PagespeedonlineV5::AuditRefs, decorator: Google::Apis::PagespeedonlineV5::AuditRefs::Representation
+      
+          property :description, as: 'description'
+          property :id, as: 'id'
+          property :manual_description, as: 'manualDescription'
+          property :score, as: 'score'
+          property :title, as: 'title'
+        end
+      end
+      
+      class LighthouseResultV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :audits, as: 'audits', class: Google::Apis::PagespeedonlineV5::LighthouseAuditResultV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseAuditResultV5::Representation
+      
+          property :categories, as: 'categories', class: Google::Apis::PagespeedonlineV5::Categories, decorator: Google::Apis::PagespeedonlineV5::Categories::Representation
+      
+          hash :category_groups, as: 'categoryGroups', class: Google::Apis::PagespeedonlineV5::CategoryGroupV5, decorator: Google::Apis::PagespeedonlineV5::CategoryGroupV5::Representation
+      
+          property :config_settings, as: 'configSettings', class: Google::Apis::PagespeedonlineV5::ConfigSettings, decorator: Google::Apis::PagespeedonlineV5::ConfigSettings::Representation
+      
+          property :environment, as: 'environment', class: Google::Apis::PagespeedonlineV5::Environment, decorator: Google::Apis::PagespeedonlineV5::Environment::Representation
+      
+          property :fetch_time, as: 'fetchTime'
+          property :final_url, as: 'finalUrl'
+          property :i18n, as: 'i18n', class: Google::Apis::PagespeedonlineV5::I18n, decorator: Google::Apis::PagespeedonlineV5::I18n::Representation
+      
+          property :lighthouse_version, as: 'lighthouseVersion'
+          property :requested_url, as: 'requestedUrl'
+          collection :run_warnings, as: 'runWarnings'
+          property :runtime_error, as: 'runtimeError', class: Google::Apis::PagespeedonlineV5::RuntimeError, decorator: Google::Apis::PagespeedonlineV5::RuntimeError::Representation
+      
+          collection :stack_packs, as: 'stackPacks', class: Google::Apis::PagespeedonlineV5::StackPack, decorator: Google::Apis::PagespeedonlineV5::StackPack::Representation
+      
+          property :timing, as: 'timing', class: Google::Apis::PagespeedonlineV5::Timing, decorator: Google::Apis::PagespeedonlineV5::Timing::Representation
+      
+          property :user_agent, as: 'userAgent'
+        end
+      end
+      
+      class PagespeedApiLoadingExperienceV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :id, as: 'id'
+          property :initial_url, as: 'initial_url'
+          hash :metrics, as: 'metrics', class: Google::Apis::PagespeedonlineV5::UserPageLoadMetricV5, decorator: Google::Apis::PagespeedonlineV5::UserPageLoadMetricV5::Representation
+      
+          property :origin_fallback, as: 'origin_fallback'
+          property :overall_category, as: 'overall_category'
+        end
+      end
+      
+      class PagespeedApiPagespeedResponseV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analysis_utc_timestamp, as: 'analysisUTCTimestamp'
+          property :captcha_result, as: 'captchaResult'
+          property :id, as: 'id'
+          property :kind, as: 'kind'
+          property :lighthouse_result, as: 'lighthouseResult', class: Google::Apis::PagespeedonlineV5::LighthouseResultV5, decorator: Google::Apis::PagespeedonlineV5::LighthouseResultV5::Representation
+      
+          property :loading_experience, as: 'loadingExperience', class: Google::Apis::PagespeedonlineV5::PagespeedApiLoadingExperienceV5, decorator: Google::Apis::PagespeedonlineV5::PagespeedApiLoadingExperienceV5::Representation
+      
+          property :origin_loading_experience, as: 'originLoadingExperience', class: Google::Apis::PagespeedonlineV5::PagespeedApiLoadingExperienceV5, decorator: Google::Apis::PagespeedonlineV5::PagespeedApiLoadingExperienceV5::Representation
+      
+          property :version, as: 'version', class: Google::Apis::PagespeedonlineV5::PagespeedVersion, decorator: Google::Apis::PagespeedonlineV5::PagespeedVersion::Representation
+      
+        end
+      end
+      
+      class PagespeedVersion
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :major, as: 'major'
+          property :minor, as: 'minor'
+        end
+      end
+      
+      class RendererFormattedStrings
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :audit_group_expand_tooltip, as: 'auditGroupExpandTooltip'
+          property :crc_initial_navigation, as: 'crcInitialNavigation'
+          property :crc_longest_duration_label, as: 'crcLongestDurationLabel'
+          property :error_label, as: 'errorLabel'
+          property :error_missing_audit_info, as: 'errorMissingAuditInfo'
+          property :lab_data_title, as: 'labDataTitle'
+          property :ls_performance_category_description, as: 'lsPerformanceCategoryDescription'
+          property :manual_audits_group_title, as: 'manualAuditsGroupTitle'
+          property :not_applicable_audits_group_title, as: 'notApplicableAuditsGroupTitle'
+          property :opportunity_resource_column_label, as: 'opportunityResourceColumnLabel'
+          property :opportunity_savings_column_label, as: 'opportunitySavingsColumnLabel'
+          property :passed_audits_group_title, as: 'passedAuditsGroupTitle'
+          property :scorescale_label, as: 'scorescaleLabel'
+          property :toplevel_warnings_message, as: 'toplevelWarningsMessage'
+          property :variance_disclaimer, as: 'varianceDisclaimer'
+          property :warning_header, as: 'warningHeader'
+        end
+      end
+      
+      class RuntimeError
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :code, as: 'code'
+          property :message, as: 'message'
+        end
+      end
+      
+      class StackPack
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :descriptions, as: 'descriptions'
+          property :icon_data_url, as: 'iconDataURL'
+          property :id, as: 'id'
+          property :title, as: 'title'
+        end
+      end
+      
+      class Timing
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :total, as: 'total'
+        end
+      end
+      
+      class UserPageLoadMetricV5
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :category, as: 'category'
+          collection :distributions, as: 'distributions', class: Google::Apis::PagespeedonlineV5::Bucket, decorator: Google::Apis::PagespeedonlineV5::Bucket::Representation
+      
+          property :form_factor, as: 'formFactor'
+          property :median, as: 'median'
+          property :metric_id, as: 'metricId'
+          property :percentile, as: 'percentile'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# 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 PagespeedonlineV5
+      # PageSpeed Insights API
+      #
+      # The PageSpeed Insights API lets you analyze the performance of your website
+      #  with a simple API. It offers tailored suggestions for how you can optimize
+      #  your site, and lets you easily integrate PageSpeed Insights analysis into your
+      #  development tools and workflow.
+      #
+      # @example
+      #    require 'google/apis/pagespeedonline_v5'
+      #
+      #    Pagespeedonline = Google::Apis::PagespeedonlineV5 # Alias the module
+      #    service = Pagespeedonline::PagespeedInsightsService.new
+      #
+      # @see https://developers.google.com/speed/docs/insights/v5/about
+      class PagespeedInsightsService < 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://pagespeedonline.googleapis.com/', '',
+                client_name: 'google-apis-pagespeedonline_v5',
+                client_version: Google::Apis::PagespeedonlineV5::GEM_VERSION)
+          @batch_path = 'batch'
+        end
+        
+        # Runs PageSpeed analysis on the page at the specified URL, and returns
+        # PageSpeed scores, a list of suggestions to make that page faster, and other
+        # information.
+        # @param [String] url
+        #   Required. The URL to fetch and analyze
+        # @param [String] captcha_token
+        #   The captcha token passed when filling out a captcha.
+        # @param [Array<String>, String] category
+        #   A Lighthouse category to run; if none are given, only Performance category
+        #   will be run
+        # @param [String] locale
+        #   The locale used to localize formatted results
+        # @param [String] strategy
+        #   The analysis strategy (desktop or mobile) to use, and desktop is the default
+        # @param [String] utm_campaign
+        #   Campaign name for analytics.
+        # @param [String] utm_source
+        #   Campaign source for analytics.
+        # @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::PagespeedonlineV5::PagespeedApiPagespeedResponseV5] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PagespeedonlineV5::PagespeedApiPagespeedResponseV5]
+        #
+        # @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 runpagespeed_pagespeedapi(url, captcha_token: nil, category: nil, locale: nil, strategy: nil, utm_campaign: nil, utm_source: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'pagespeedonline/v5/runPagespeed', options)
+          command.response_representation = Google::Apis::PagespeedonlineV5::PagespeedApiPagespeedResponseV5::Representation
+          command.response_class = Google::Apis::PagespeedonlineV5::PagespeedApiPagespeedResponseV5
+          command.query['captchaToken'] = captcha_token unless captcha_token.nil?
+          command.query['category'] = category unless category.nil?
+          command.query['locale'] = locale unless locale.nil?
+          command.query['strategy'] = strategy unless strategy.nil?
+          command.query['url'] = url unless url.nil?
+          command.query['utm_campaign'] = utm_campaign unless utm_campaign.nil?
+          command.query['utm_source'] = utm_source unless utm_source.nil?
+          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