google-api-client 0.19.8 → 0.20.0

data/generated/google/apis/pagespeedonline_v4/representations.rb

@@ -0,0 +1,335 @@
+# Copyright 2015 Google Inc.
+#
+# 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 PagespeedonlineV4
+      
+      class PagespeedApiFormatStringV4
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class Arg
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+          class Rect
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+            include Google::Apis::Core::JsonObjectSupport
+          end
+          
+          class SecondaryRect
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+            include Google::Apis::Core::JsonObjectSupport
+          end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PagespeedApiImageV4
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class PageRect
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PagespeedApiPagespeedResponseV4
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class FormattedResults
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+          class RuleResult
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+            
+            class UrlBlock
+              class Representation < Google::Apis::Core::JsonRepresentation; end
+              
+              class Url
+                class Representation < Google::Apis::Core::JsonRepresentation; end
+              
+                include Google::Apis::Core::JsonObjectSupport
+              end
+            
+              include Google::Apis::Core::JsonObjectSupport
+            end
+          
+            include Google::Apis::Core::JsonObjectSupport
+          end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+        
+        class LoadingExperience
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+          class Metric
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+            
+            class Distribution
+              class Representation < Google::Apis::Core::JsonRepresentation; end
+            
+              include Google::Apis::Core::JsonObjectSupport
+            end
+          
+            include Google::Apis::Core::JsonObjectSupport
+          end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+        
+        class PageStats
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+        
+        class RuleGroup
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+        
+        class Version
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PagespeedApiFormatStringV4
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :args, as: 'args', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Arg, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Arg::Representation
+      
+          property :format, as: 'format'
+        end
+        
+        class Arg
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :key, as: 'key'
+            collection :rects, as: 'rects', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Arg::Rect, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Arg::Rect::Representation
+        
+            collection :secondary_rects, as: 'secondary_rects', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Arg::SecondaryRect, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Arg::SecondaryRect::Representation
+        
+            property :type, as: 'type'
+            property :value, as: 'value'
+          end
+          
+          class Rect
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :height, as: 'height'
+              property :left, as: 'left'
+              property :top, as: 'top'
+              property :width, as: 'width'
+            end
+          end
+          
+          class SecondaryRect
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :height, as: 'height'
+              property :left, as: 'left'
+              property :top, as: 'top'
+              property :width, as: 'width'
+            end
+          end
+        end
+      end
+      
+      class PagespeedApiImageV4
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :data, :base64 => true, as: 'data'
+          property :height, as: 'height'
+          property :key, as: 'key'
+          property :mime_type, as: 'mime_type'
+          property :page_rect, as: 'page_rect', class: Google::Apis::PagespeedonlineV4::PagespeedApiImageV4::PageRect, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiImageV4::PageRect::Representation
+      
+          property :width, as: 'width'
+        end
+        
+        class PageRect
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :height, as: 'height'
+            property :left, as: 'left'
+            property :top, as: 'top'
+            property :width, as: 'width'
+          end
+        end
+      end
+      
+      class PagespeedApiPagespeedResponseV4
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :captcha_result, as: 'captchaResult'
+          property :formatted_results, as: 'formattedResults', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::Representation
+      
+          property :id, as: 'id'
+          collection :invalid_rules, as: 'invalidRules'
+          property :kind, as: 'kind'
+          property :loading_experience, as: 'loadingExperience', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::LoadingExperience, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::LoadingExperience::Representation
+      
+          property :page_stats, as: 'pageStats', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::PageStats, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::PageStats::Representation
+      
+          property :response_code, as: 'responseCode'
+          hash :rule_groups, as: 'ruleGroups', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::RuleGroup, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::RuleGroup::Representation
+      
+          property :screenshot, as: 'screenshot', class: Google::Apis::PagespeedonlineV4::PagespeedApiImageV4, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiImageV4::Representation
+      
+          collection :snapshots, as: 'snapshots', class: Google::Apis::PagespeedonlineV4::PagespeedApiImageV4, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiImageV4::Representation
+      
+          property :title, as: 'title'
+          property :version, as: 'version', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::Version, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::Version::Representation
+      
+        end
+        
+        class FormattedResults
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :locale, as: 'locale'
+            hash :rule_results, as: 'ruleResults', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult::Representation
+        
+          end
+          
+          class RuleResult
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :beta, as: 'beta'
+              collection :groups, as: 'groups'
+              property :localized_rule_name, as: 'localizedRuleName'
+              property :rule_impact, as: 'ruleImpact'
+              property :summary, as: 'summary', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Representation
+          
+              collection :url_blocks, as: 'urlBlocks', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult::UrlBlock, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult::UrlBlock::Representation
+          
+            end
+            
+            class UrlBlock
+              # @private
+              class Representation < Google::Apis::Core::JsonRepresentation
+                property :header, as: 'header', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Representation
+            
+                collection :urls, as: 'urls', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult::UrlBlock::Url, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult::UrlBlock::Url::Representation
+            
+              end
+              
+              class Url
+                # @private
+                class Representation < Google::Apis::Core::JsonRepresentation
+                  collection :details, as: 'details', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Representation
+              
+                  property :result, as: 'result', class: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4::Representation
+              
+                end
+              end
+            end
+          end
+        end
+        
+        class LoadingExperience
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :id, as: 'id'
+            property :initial_url, as: 'initial_url'
+            hash :metrics, as: 'metrics', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::LoadingExperience::Metric, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::LoadingExperience::Metric::Representation
+        
+            property :overall_category, as: 'overall_category'
+          end
+          
+          class Metric
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :category, as: 'category'
+              collection :distributions, as: 'distributions', class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::LoadingExperience::Metric::Distribution, decorator: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::LoadingExperience::Metric::Distribution::Representation
+          
+              property :median, as: 'median'
+            end
+            
+            class Distribution
+              # @private
+              class Representation < Google::Apis::Core::JsonRepresentation
+                property :max, as: 'max'
+                property :min, as: 'min'
+                property :proportion, as: 'proportion'
+              end
+            end
+          end
+        end
+        
+        class PageStats
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :cms, as: 'cms'
+            property :css_response_bytes, :numeric_string => true, as: 'cssResponseBytes'
+            property :flash_response_bytes, :numeric_string => true, as: 'flashResponseBytes'
+            property :html_response_bytes, :numeric_string => true, as: 'htmlResponseBytes'
+            property :image_response_bytes, :numeric_string => true, as: 'imageResponseBytes'
+            property :javascript_response_bytes, :numeric_string => true, as: 'javascriptResponseBytes'
+            property :num_render_blocking_round_trips, as: 'numRenderBlockingRoundTrips'
+            property :num_total_round_trips, as: 'numTotalRoundTrips'
+            property :number_css_resources, as: 'numberCssResources'
+            property :number_hosts, as: 'numberHosts'
+            property :number_js_resources, as: 'numberJsResources'
+            property :number_resources, as: 'numberResources'
+            property :number_roboted_resources, as: 'numberRobotedResources'
+            property :number_static_resources, as: 'numberStaticResources'
+            property :number_transient_fetch_failure_resources, as: 'numberTransientFetchFailureResources'
+            property :other_response_bytes, :numeric_string => true, as: 'otherResponseBytes'
+            property :over_the_wire_response_bytes, :numeric_string => true, as: 'overTheWireResponseBytes'
+            collection :roboted_urls, as: 'robotedUrls'
+            property :text_response_bytes, :numeric_string => true, as: 'textResponseBytes'
+            property :total_request_bytes, :numeric_string => true, as: 'totalRequestBytes'
+            collection :transient_fetch_failure_urls, as: 'transientFetchFailureUrls'
+          end
+        end
+        
+        class RuleGroup
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :pass, as: 'pass'
+            property :score, as: 'score'
+          end
+        end
+        
+        class Version
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :major, as: 'major'
+            property :minor, as: 'minor'
+          end
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/pagespeedonline_v4/service.rb

@@ -0,0 +1,129 @@
+# Copyright 2015 Google Inc.
+#
+# 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 PagespeedonlineV4
+      # PageSpeed Insights API
+      #
+      # Analyzes the performance of a web page and provides tailored suggestions to
+      #  make that page faster.
+      #
+      # @example
+      #    require 'google/apis/pagespeedonline_v4'
+      #
+      #    Pagespeedonline = Google::Apis::PagespeedonlineV4 # Alias the module
+      #    service = Pagespeedonline::PagespeedonlineService.new
+      #
+      # @see https://developers.google.com/speed/docs/insights/v4/getting-started
+      class PagespeedonlineService < 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.
+        #  Overrides userIp if both are provided.
+        attr_accessor :quota_user
+
+        # @return [String]
+        #  IP address of the site where the request originates. Use this if you want to
+        #  enforce per-user limits.
+        attr_accessor :user_ip
+
+        def initialize
+          super('https://www.googleapis.com/', 'pagespeedonline/v4/')
+          @batch_path = 'batch/pagespeedonline/v4'
+        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
+        #   The URL to fetch and analyze
+        # @param [Boolean] filter_third_party_resources
+        #   Indicates if third party resources should be filtered out before PageSpeed
+        #   analysis.
+        # @param [String] locale
+        #   The locale used to localize formatted results
+        # @param [Array<String>, String] rule
+        #   A PageSpeed rule to run; if none are given, all rules are run
+        # @param [Boolean] screenshot
+        #   Indicates if binary data containing a screenshot should be included
+        # @param [Boolean] snapshots
+        #   Indicates if binary data containing snapshot images should be included
+        # @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.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4]
+        #
+        # @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, filter_third_party_resources: nil, locale: nil, rule: nil, screenshot: nil, snapshots: nil, strategy: nil, utm_campaign: nil, utm_source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'runPagespeed', options)
+          command.response_representation = Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::Representation
+          command.response_class = Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4
+          command.query['filter_third_party_resources'] = filter_third_party_resources unless filter_third_party_resources.nil?
+          command.query['locale'] = locale unless locale.nil?
+          command.query['rule'] = rule unless rule.nil?
+          command.query['screenshot'] = screenshot unless screenshot.nil?
+          command.query['snapshots'] = snapshots unless snapshots.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?
+          command.query['userIp'] = user_ip unless user_ip.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?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+        end
+      end
+    end
+  end
+end