Blame - docs/dyn/pagespeedonline_v5.pagespeedapi.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">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.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

83

<h3>Method Details</h3>

84

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<code class="details" id="close">close()</code>

86

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

90

<code class="details" id="runpagespeed">runpagespeed(strategy=None, url=None, captchaToken=None, category=None, locale=None, utm_campaign=None, utm_source=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<pre>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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

93

Args:

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

94

strategy: string, The analysis strategy (desktop or mobile) to use, and desktop is the default

95

Allowed values

96

STRATEGY_UNSPECIFIED - UNDEFINED.

97

DESKTOP - Fetch and analyze the URL for desktop browsers.

98

MOBILE - Fetch and analyze the URL for mobile devices.

99

url: string, Required. The URL to fetch and analyze

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

100

captchaToken: string, The captcha token passed when filling out a captcha.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

101

category: string, A Lighthouse category to run; if none are given, only Performance category will be run (repeated)

102

Allowed values

103

CATEGORY_UNSPECIFIED - Default UNDEFINED category.

104

ACCESSIBILITY - Accessibility (a11y), category pertaining to a website's capacity to be accessible to all users.

105

BEST_PRACTICES - Best Practices, category pertaining to a website's conformance to web best practice.

106

PERFORMANCE - Performance, category pertaining to a website's performance.

107

PWA - Progressive Web App (PWA), category pertaining to a website's ability to be run as a PWA.

108

SEO - Search Engine Optimization (SEO), category pertaining to a website's ability to be indexed by search engines.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

109

locale: string, The locale used to localize formatted results

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

110

utm_campaign: string, Campaign name for analytics.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

111

utm_source: string, Campaign source for analytics.

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

112

x__xgafv: string, V1 error format.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

Allowed values

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

114

1 - v1 error format

115

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

117

Returns:

118

An object of the form:

119

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

120

{ # The Pagespeed API response object.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

121

"analysisUTCTimestamp": "A String", # The UTC timestamp of this analysis.

122

"version": { # The Pagespeed Version object. # The version of PageSpeed used to generate these results.

123

"major": "A String", # The major version number of PageSpeed used to generate these results.

124

"minor": "A String", # The minor version number of PageSpeed used to generate these results.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

125

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

"kind": "A String", # Kind of result.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

127

"id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).

128

"lighthouseResult": { # The Lighthouse result object. # Lighthouse response for the audit url as an object.

129

"fetchTime": "A String", # The time that this run was fetched.

130

"configSettings": { # Message containing the configuration settings for the Lighthouse run. # The configuration settings for this LHR.

131

"onlyCategories": "", # List of categories of audits the run should conduct.

132

"emulatedFormFactor": "A String", # The form factor the emulation should use.

133

"channel": "A String", # How Lighthouse was run, e.g. from the Chrome extension or from the npm module.

134

"locale": "A String", # The locale setting.

135

},

136

"timing": { # Message containing the performance timing data for the Lighthouse run. # Timing information for this LHR.

137

"total": 3.14, # The total duration of Lighthouse's run.

138

},

139

"audits": { # Map of audits in the LHR.

140

"a_key": { # An audit's result object in a Lighthouse result.

141

"scoreDisplayMode": "A String", # The enumerated score display mode.

142

"warnings": "", # Possible warnings that occurred in the audit, can be null.

143

"explanation": "A String", # An explanation of the errors in the audit.

144

"numericValue": 3.14, # A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present.

145

"title": "A String", # The human readable title.

146

"details": { # Freeform details section of the audit.

147

"a_key": "", # Properties of the object.

148

},

149

"id": "A String", # The audit's id.

150

"displayValue": "A String", # The value that should be displayed on the UI for this audit.

151

"errorMessage": "A String", # An error message from a thrown error inside the audit.

152

"description": "A String", # The description of the audit.

153

"score": "", # The score of the audit, can be null.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

154

},

155

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

156

"categories": { # The categories in a Lighthouse run. # Map of categories in the LHR.

157

"accessibility": { # A Lighthouse category. # The accessibility category, containing all accessibility related audits.

158

"title": "A String", # The human-friendly name of the category.

159

"auditRefs": [ # An array of references to all the audit members of this category.

160

{ # A light reference to an audit by id, used to group and weight audits in a given category.

161

"id": "A String", # The audit ref id.

162

"group": "A String", # The category group that the audit belongs to (optional).

163

"weight": 3.14, # The weight this audit's score has on the overall category score.

164

},

165

],

166

"manualDescription": "A String", # A description for the manual audits in the category.

167

"id": "A String", # The string identifier of the category.

168

"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)

169

"description": "A String", # A more detailed description of the category and its importance.

170

},

171

"pwa": { # A Lighthouse category. # The Progressive-Web-App (PWA) category, containing all pwa related audits.

172

"title": "A String", # The human-friendly name of the category.

173

"auditRefs": [ # An array of references to all the audit members of this category.

174

{ # A light reference to an audit by id, used to group and weight audits in a given category.

175

"id": "A String", # The audit ref id.

176

"group": "A String", # The category group that the audit belongs to (optional).

177

"weight": 3.14, # The weight this audit's score has on the overall category score.

178

},

179

],

180

"manualDescription": "A String", # A description for the manual audits in the category.

181

"id": "A String", # The string identifier of the category.

182

"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)

183

"description": "A String", # A more detailed description of the category and its importance.

184

},

185

"performance": { # A Lighthouse category. # The performance category, containing all performance related audits.

186

"title": "A String", # The human-friendly name of the category.

187

"auditRefs": [ # An array of references to all the audit members of this category.

188

{ # A light reference to an audit by id, used to group and weight audits in a given category.

189

"id": "A String", # The audit ref id.

190

"group": "A String", # The category group that the audit belongs to (optional).

191

"weight": 3.14, # The weight this audit's score has on the overall category score.

192

},

193

],

194

"manualDescription": "A String", # A description for the manual audits in the category.

195

"id": "A String", # The string identifier of the category.

196

"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)

197

"description": "A String", # A more detailed description of the category and its importance.

198

},

199

"best-practices": { # A Lighthouse category. # The best practices category, containing all best practices related audits.

200

"title": "A String", # The human-friendly name of the category.

201

"auditRefs": [ # An array of references to all the audit members of this category.

202

{ # A light reference to an audit by id, used to group and weight audits in a given category.

203

"id": "A String", # The audit ref id.

204

"group": "A String", # The category group that the audit belongs to (optional).

205

"weight": 3.14, # The weight this audit's score has on the overall category score.

206

},

207

],

208

"manualDescription": "A String", # A description for the manual audits in the category.

209

"id": "A String", # The string identifier of the category.

210

"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)

211

"description": "A String", # A more detailed description of the category and its importance.

212

},

213

"seo": { # A Lighthouse category. # The Search-Engine-Optimization (SEO) category, containing all seo related audits.

214

"title": "A String", # The human-friendly name of the category.

215

"auditRefs": [ # An array of references to all the audit members of this category.

216

{ # A light reference to an audit by id, used to group and weight audits in a given category.

217

"id": "A String", # The audit ref id.

218

"group": "A String", # The category group that the audit belongs to (optional).

219

"weight": 3.14, # The weight this audit's score has on the overall category score.

220

},

221

],

222

"manualDescription": "A String", # A description for the manual audits in the category.

223

"id": "A String", # The string identifier of the category.

224

"score": "", # The overall score of the category, the weighted average of all its audits. (The category's score, can be null.)

225

"description": "A String", # A more detailed description of the category and its importance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

226

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

227

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

228

"environment": { # Message containing environment configuration for a Lighthouse run. # Environment settings that were used when making this LHR.

229

"networkUserAgent": "A String", # The user agent string that was sent over the network.

230

"hostUserAgent": "A String", # The user agent string of the version of Chrome used.

231

"benchmarkIndex": 3.14, # The benchmark index number that indicates rough device class.

232

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

233

"runtimeError": { # Message containing a runtime error config. # A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded.

234

"code": "A String", # The enumerated Lighthouse Error code.

235

"message": "A String", # A human readable message explaining the error code.

236

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

237

"stackPacks": [ # The Stack Pack advice strings.

238

{ # Message containing Stack Pack information.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

239

"title": "A String", # The stack pack title.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

240

"descriptions": { # The stack pack advice strings.

241

"a_key": "A String",

242

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

243

"id": "A String", # The stack pack id.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

244

"iconDataURL": "A String", # The stack pack icon data uri.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

245

},

246

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

247

"i18n": { # Message containing the i18n data for the LHR - Version 1. # The internationalization strings that are required to render the LHR.

248

"rendererFormattedStrings": { # Message holding the formatted strings used in the renderer. # Internationalized strings that are formatted to the locale in configSettings.

249

"manualAuditsGroupTitle": "A String", # The heading shown above a list of audits that were not computerd in the run.

250

"errorMissingAuditInfo": "A String", # The error string shown next to an erroring audit.

251

"lsPerformanceCategoryDescription": "A String", # The disclaimer shown under performance explaning that the network can vary.

252

"opportunityResourceColumnLabel": "A String", # The heading for the estimated page load savings opportunity of an audit.

253

"crcLongestDurationLabel": "A String", # The label for values shown in the summary of critical request chains.

254

"labDataTitle": "A String", # The title of the lab data performance category.

255

"passedAuditsGroupTitle": "A String", # The heading that is shown above a list of audits that are passing.

256

"opportunitySavingsColumnLabel": "A String", # The heading for the estimated page load savings of opportunity audits.

257

"scorescaleLabel": "A String", # The label that explains the score gauges scale (0-49, 50-89, 90-100).

258

"notApplicableAuditsGroupTitle": "A String", # The heading shown above a list of audits that do not apply to a page.

259

"warningHeader": "A String", # The label shown above a bulleted list of warnings.

260

"crcInitialNavigation": "A String", # The label for the initial request in a critical request chain.

261

"varianceDisclaimer": "A String", # The disclaimer shown below a performance metric value.

262

"auditGroupExpandTooltip": "A String", # The tooltip text on an expandable chevron icon.

263

"toplevelWarningsMessage": "A String", # The label shown preceding important warnings that may have invalidated an entire report.

264

"errorLabel": "A String", # The label shown next to an audit or metric that has had an error.

265

},

266

},

267

"finalUrl": "A String", # The final resolved url that was audited.

268

"requestedUrl": "A String", # The original requested url.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

269

"categoryGroups": { # Map of category groups in the LHR.

270

"a_key": { # Message containing a category

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

271

"description": "A String", # The description of what the category is grouping

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

272

"title": "A String", # The human readable title of the group

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

273

},

274

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

275

"userAgent": "A String", # The user agent that was used to run this LHR.

276

"runWarnings": [ # List of all run warnings in the LHR. Will always output to at least `[]`.

277

"",

278

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

279

"lighthouseVersion": "A String", # The lighthouse version that was used to generate this LHR.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

280

},

281

"captchaResult": "A String", # The captcha verify result

282

"loadingExperience": { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of end users' page loading experience.

283

"id": "A String", # The url, pattern or origin which the metrics are on.

284

"origin_fallback": True or False, # True if the result is an origin fallback from a page, false otherwise.

285

"initial_url": "A String", # The requested URL, which may differ from the resolved "id".

286

"metrics": { # The map of .

287

"a_key": { # A CrUX metric object for a single metric and form factor.

288

"distributions": [ # Metric distributions. Proportions should sum up to 1.

289

{ # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond.

290

"max": 42, # Upper bound for a bucket's range.

291

"proportion": 3.14, # The proportion of data in this bucket.

292

"min": 42, # Lower bound for a bucket's range.

293

},

294

],

295

"percentile": 42, # We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90.

296

"median": 42, # The median number of the metric, in millisecond.

297

"formFactor": "A String", # Identifies the form factor of the metric being collected.

298

"metricId": "A String", # Identifies the type of the metric.

299

"category": "A String", # The category of the specific time metric.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

300

},

301

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

302

"overall_category": "A String", # The human readable speed "category" of the id.

303

},

304

"originLoadingExperience": { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of the aggregated page loading experience of the origin

305

"id": "A String", # The url, pattern or origin which the metrics are on.

306

"origin_fallback": True or False, # True if the result is an origin fallback from a page, false otherwise.

307

"initial_url": "A String", # The requested URL, which may differ from the resolved "id".

308

"metrics": { # The map of .

309

"a_key": { # A CrUX metric object for a single metric and form factor.

310

"distributions": [ # Metric distributions. Proportions should sum up to 1.

311

{ # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond.

312

"max": 42, # Upper bound for a bucket's range.

313

"proportion": 3.14, # The proportion of data in this bucket.

314

"min": 42, # Lower bound for a bucket's range.

315

},

316

],

317

"percentile": 42, # We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90.

318

"median": 42, # The median number of the metric, in millisecond.

319

"formFactor": "A String", # Identifies the form factor of the metric being collected.

320

"metricId": "A String", # Identifies the type of the metric.

321

"category": "A String", # The category of the specific time metric.

322

},

Bu Sun Kim