1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# 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]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
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
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @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
|
