v2.d.ts
9.94 KB
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
/**
* Copyright 2019 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.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace pagespeedonline_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* PageSpeed Insights API
*
* Analyzes the performance of a web page and provides tailored suggestions to make that page faster.
*
* @example
* const {google} = require('googleapis');
* const pagespeedonline = google.pagespeedonline('v2');
*
* @namespace pagespeedonline
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Pagespeedonline
*/
export class Pagespeedonline {
context: APIRequestContext;
pagespeedapi: Resource$Pagespeedapi;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$PagespeedApiFormatStringV2 {
/**
* List of arguments for the format string.
*/
args?: Array<{
key?: string;
rects?: Array<{
height?: number;
left?: number;
top?: number;
width?: number;
}>;
secondary_rects?: Array<{
height?: number;
left?: number;
top?: number;
width?: number;
}>;
type?: string;
value?: string;
}> | null;
/**
* A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
*/
format?: string | null;
}
export interface Schema$PagespeedApiImageV2 {
/**
* Image data base64 encoded.
*/
data?: string | null;
/**
* Height of screenshot in pixels.
*/
height?: number | null;
/**
* Unique string key, if any, identifying this image.
*/
key?: string | null;
/**
* Mime type of image data (e.g. "image/jpeg").
*/
mime_type?: string | null;
/**
* The region of the page that is captured by this image, with dimensions measured in CSS pixels.
*/
page_rect?: {
height?: number;
left?: number;
top?: number;
width?: number;
} | null;
/**
* Width of screenshot in pixels.
*/
width?: number | null;
}
export interface Schema$Result {
/**
* The captcha verify result
*/
captchaResult?: string | null;
/**
* Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.
*/
formattedResults?: {
locale?: string;
ruleResults?: {
[key: string]: {
groups?: string[];
localizedRuleName?: string;
ruleImpact?: number;
summary?: Schema$PagespeedApiFormatStringV2;
urlBlocks?: Array<{
header?: Schema$PagespeedApiFormatStringV2;
urls?: Array<{
details?: Schema$PagespeedApiFormatStringV2[];
result?: Schema$PagespeedApiFormatStringV2;
}>;
}>;
};
};
} | null;
/**
* Canonicalized and final URL for the document, after following page redirects (if any).
*/
id?: string | null;
/**
* List of rules that were specified in the request, but which the server did not know how to instantiate.
*/
invalidRules?: string[] | null;
/**
* Kind of result.
*/
kind?: string | null;
/**
* Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
*/
pageStats?: {
cssResponseBytes?: string;
flashResponseBytes?: string;
htmlResponseBytes?: string;
imageResponseBytes?: string;
javascriptResponseBytes?: string;
numberCssResources?: number;
numberHosts?: number;
numberJsResources?: number;
numberResources?: number;
numberStaticResources?: number;
otherResponseBytes?: string;
textResponseBytes?: string;
totalRequestBytes?: string;
} | null;
/**
* Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
*/
responseCode?: number | null;
/**
* A map with one entry for each rule group in these results.
*/
ruleGroups?: {
[key: string]: {
score?: number;
};
} | null;
/**
* Base64-encoded screenshot of the page that was analyzed.
*/
screenshot?: Schema$PagespeedApiImageV2;
/**
* Title of the page, as displayed in the browser's title bar.
*/
title?: string | null;
/**
* The version of PageSpeed used to generate these results.
*/
version?: {
major?: number;
minor?: number;
} | null;
}
export class Resource$Pagespeedapi {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* pagespeedonline.pagespeedapi.runpagespeed
* @desc 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.
* @alias pagespeedonline.pagespeedapi.runpagespeed
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.filter_third_party_resources Indicates if third party resources should be filtered out before PageSpeed analysis.
* @param {string=} params.locale The locale used to localize formatted results
* @param {string=} params.rule A PageSpeed rule to run; if none are given, all rules are run
* @param {boolean=} params.screenshot Indicates if binary data containing a screenshot should be included
* @param {string=} params.strategy The analysis strategy to use
* @param {string} params.url The URL to fetch and analyze
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
runpagespeed(params?: Params$Resource$Pagespeedapi$Runpagespeed, options?: MethodOptions): GaxiosPromise<Schema$Result>;
runpagespeed(params: Params$Resource$Pagespeedapi$Runpagespeed, options: MethodOptions | BodyResponseCallback<Schema$Result>, callback: BodyResponseCallback<Schema$Result>): void;
runpagespeed(params: Params$Resource$Pagespeedapi$Runpagespeed, callback: BodyResponseCallback<Schema$Result>): void;
runpagespeed(callback: BodyResponseCallback<Schema$Result>): void;
}
export interface Params$Resource$Pagespeedapi$Runpagespeed extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Indicates if third party resources should be filtered out before PageSpeed analysis.
*/
filter_third_party_resources?: boolean;
/**
* The locale used to localize formatted results
*/
locale?: string;
/**
* A PageSpeed rule to run; if none are given, all rules are run
*/
rule?: string[];
/**
* Indicates if binary data containing a screenshot should be included
*/
screenshot?: boolean;
/**
* The analysis strategy to use
*/
strategy?: string;
/**
* The URL to fetch and analyze
*/
url?: string;
}
export {};
}