class Google::Apis::PagespeedonlineV2::PagespeedonlineService
PageSpeed Insights API
Analyzes the performance of a web page and provides tailored suggestions to
make that page faster.
@example
require 'google/apis/pagespeedonline_v2' Pagespeedonline = Google::Apis::PagespeedonlineV2 # Alias the module service = Pagespeedonline::PagespeedonlineService.new
@see developers.google.com/speed/docs/insights/v2/getting-started
Attributes
@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.
@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.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/pagespeedonline_v2/service.rb, line 52 def initialize super('https://www.googleapis.com/', 'pagespeedonline/v2/') end
Public Instance Methods
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 [String] strategy
The analysis strategy to use
@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::PagespeedonlineV2::Result] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PagespeedonlineV2::Result]
@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
# File generated/google/apis/pagespeedonline_v2/service.rb, line 93 def run_pagespeed(url, filter_third_party_resources: nil, locale: nil, rule: nil, screenshot: nil, strategy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'runPagespeed', options) command.response_representation = Google::Apis::PagespeedonlineV2::Result::Representation command.response_class = Google::Apis::PagespeedonlineV2::Result 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['strategy'] = strategy unless strategy.nil? command.query['url'] = url unless url.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 Instance Methods
# File generated/google/apis/pagespeedonline_v2/service.rb, line 111 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