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-12-09 08:56:03 -0800

[diff] [blame]

90

<code class="details" id="runpagespeed">runpagespeed(locale=None, strategy=None, utm_source=None, category=None, captchaToken=None, url=None, utm_campaign=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-12-09 08:56:03 -0800

[diff] [blame]

94

locale: string, The locale used to localize formatted results

95

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

96

Allowed values

97

STRATEGY_UNSPECIFIED - UNDEFINED.

98

DESKTOP - Fetch and analyze the URL for desktop browsers.

99

MOBILE - Fetch and analyze the URL for mobile devices.

100

utm_source: string, Campaign source for analytics.

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-12-09 08:56:03 -0800

[diff] [blame]

109

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

110

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

111

utm_campaign: string, Campaign name 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-26 17:16:03 -0800

[diff] [blame]

121

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

122

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

123

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

124

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

125

"metrics": { # The map of .

126

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

127

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

128

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

129

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

130

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

131

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

132

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

133

{ # 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.

134

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

135

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

136

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

},

],

},

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

141

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

142

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

143

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

144

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

},

],

},

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

},

],

},

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

},

],

},

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

},

],

},

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

},

214

],

Bu Sun Kim

673ec5c

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

[diff] [blame]

215

},

Bu Sun Kim

d059ad8

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

[diff] [blame]

216

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

217

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

218

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

219

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

220

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

221

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

222

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

223

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

224

"a_key": { # Message containing a category

225

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

226

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

227

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

228

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

229

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

230

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

231

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

232

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

233

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

234

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

235

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

236

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

237

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

238

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

239

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

240

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

241

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

242

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

243

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

244

},

245

},

246

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

247

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

248

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

249

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

250

},

251

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

252

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

253

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

254

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

255

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

256

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

257

},

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

277

},

278

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

279

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

280

{ # Message containing Stack Pack information.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

281

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

282

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

283

"a_key": "A String",

284

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

285

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

286

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

287

},

288

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

289

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

290

"",

291

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

292

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

293

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

294

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

295

},

Bu Sun Kim

6502091

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

[diff] [blame]

296

},

Yoshi Automation Bot