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

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

[diff] [blame]

79

<p class="firstline">Runs PageSpeed analysis on the page at the specified URL, and returns</p>

Bu Sun Kim

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

[diff] [blame]

80

<h3>Method Details</h3>

81

Bu Sun Kim

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

[diff] [blame^]

82

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

Dan O'Meara

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

[diff] [blame]

83

<pre>Runs PageSpeed analysis on the page at the specified URL, and returns

84

PageSpeed scores, a list of suggestions to make that page faster, and other

85

information.

Bu Sun Kim

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

[diff] [blame]

86

87

Args:

Bu Sun Kim

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

[diff] [blame^]

88

utm_source: string, Campaign source for analytics.

89

category: string, A Lighthouse category to run; if none are given, only Performance category

90

will be run (repeated)

Bu Sun Kim

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

[diff] [blame]

91

locale: string, The locale used to localize formatted results

Dan O'Meara

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

[diff] [blame]

92

url: string, The URL to fetch and analyze

Bu Sun Kim

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

[diff] [blame]

93

utm_campaign: string, Campaign name for analytics.

94

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

95

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

96

default

Dan O'Meara

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

[diff] [blame]

97

x__xgafv: string, V1 error format.

Bu Sun Kim

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

[diff] [blame]

98

Allowed values

Dan O'Meara

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

[diff] [blame]

99

1 - v1 error format

100

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

101

102

Returns:

103

An object of the form:

104

Dan O'Meara

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

[diff] [blame]

105

{ # The Pagespeed API response object.

Bu Sun Kim

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

[diff] [blame^]

106

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

107

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

108

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

109

},

110

"id": "A String", # Canonicalized and final URL for the document, after following page

111

# redirects (if any).

112

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

113

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

114

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

115

"metrics": { # The map of <metrics, data>.

116

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

117

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

118

{ # A proportion of data in the total distribution, bucketed by a min/max

119

# percentage. Each bucket's range is bounded by min <= x < max, In

120

# millisecond.

121

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

122

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

123

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

Bu Sun Kim

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

[diff] [blame]

124

},

125

],

Bu Sun Kim

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

[diff] [blame^]

126

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

127

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

128

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

129

"percentile": 42, # We use this field to store certain percentile value for this metric.

130

# For v4, this field contains pc50.

131

# For v5, this field contains pc90.

132

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

Bu Sun Kim

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

[diff] [blame]

133

},

134

},

Bu Sun Kim

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

[diff] [blame^]

135

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

136

},

137

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

138

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

139

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

Bu Sun Kim

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

[diff] [blame]

140

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

Dan O'Meara

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

[diff] [blame]

141

{ # Message containing Stack Pack information.

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

145

},

Bu Sun Kim

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

[diff] [blame^]

146

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

147

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

Dan O'Meara

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

[diff] [blame]

148

},

149

],

Bu Sun Kim

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

[diff] [blame]

150

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

151

"a_key": { # Message containing a category

152

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

153

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

Bu Sun Kim

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

[diff] [blame]

154

},

155

},

Bu Sun Kim

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

[diff] [blame]

156

"runtimeError": { # Message containing a runtime error config. # A top-level error message that, if present, indicates a serious enough

157

# problem that this Lighthouse result may need to be discarded.

Bu Sun Kim

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

[diff] [blame]

158

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

Bu Sun Kim

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

[diff] [blame^]

159

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

Dan O'Meara

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

[diff] [blame]

160

},

Bu Sun Kim

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

[diff] [blame]

161

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

162

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

163

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

164

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

Bu Sun Kim

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

[diff] [blame^]

165

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

166

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

Bu Sun Kim

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

[diff] [blame]

167

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

168

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

169

# module.

Bu Sun Kim

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

[diff] [blame]

170

},

171

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

172

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

173

},

174

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

175

"",

176

],

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

},

Bu Sun Kim

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

[diff] [blame]

185

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

Bu Sun Kim

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

[diff] [blame^]

186

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

Bu Sun Kim

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

[diff] [blame]

187

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

Bu Sun Kim

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

[diff] [blame^]

188

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

Bu Sun Kim

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

[diff] [blame]

189

"numericValue": 3.14, # A numeric value that has a meaning specific to the audit, e.g. the number

Dan O'Meara

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

[diff] [blame]

190

# of nodes in the DOM or the timestamp of a specific load event. More

191

# information can be found in the audit details, if present.

Bu Sun Kim

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

[diff] [blame]

192

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

193

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

Bu Sun Kim

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

[diff] [blame]

194

},

195

},

Bu Sun Kim

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

[diff] [blame]

196

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

Bu Sun Kim

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

[diff] [blame^]

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

},

201

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

202

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

203

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

204

# configSettings.

Bu Sun Kim

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

[diff] [blame]

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

207

# audit.

Bu Sun Kim

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

[diff] [blame^]

208

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

209

# an entire report.

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

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

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

216

# run.

Bu Sun Kim

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

[diff] [blame^]

217

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

Bu Sun Kim

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

[diff] [blame]

218

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

219

# vary.

Bu Sun Kim

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

[diff] [blame^]

220

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

221

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

222

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

223

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

224

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

225

},

226

},

227

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

228

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

229

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

230

# audits.

231

"score": "", # The overall score of the category, the weighted average of all its audits.

232

# (The category's score, can be null.)

233

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

234

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

235

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

236

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

237

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

238

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

239

# given category.

240

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

241

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

242

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

},

],

},

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

247

# audits.

248

"score": "", # The overall score of the category, the weighted average of all its audits.

249

# (The category's score, can be null.)

250

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

251

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

252

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

253

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

254

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

255

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

256

# given category.

257

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

258

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

259

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

},

],

},

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

264

"score": "", # The overall score of the category, the weighted average of all its audits.

265

# (The category's score, can be null.)

266

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

267

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

268

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

269

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

270

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

271

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

272

# given category.

273

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

274

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

275

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

},

],

},

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

280

# audits.

281

"score": "", # The overall score of the category, the weighted average of all its audits.

282

# (The category's score, can be null.)

283

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

284

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

285

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

286

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

287

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

288

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

289

# given category.

290

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

291

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

292

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

},

],

},

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

297

"score": "", # The overall score of the category, the weighted average of all its audits.

298

# (The category's score, can be null.)

299

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

300

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

301

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

302

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

303

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

304

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

305

# given category.

306

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

307

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

308

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

309

},

310

],

Bu Sun Kim

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

[diff] [blame]

311

},

312

},

Bu Sun Kim

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

[diff] [blame]

313

},

Bu Sun Kim

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

[diff] [blame]

314

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

315

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

Bu Sun Kim

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

[diff] [blame^]

316

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

317

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

Bu Sun Kim

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

[diff] [blame]

318

"metrics": { # The map of <metrics, data>.

319

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

Bu Sun Kim

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

[diff] [blame]

320

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

321

{ # A proportion of data in the total distribution, bucketed by a min/max

322

# percentage. Each bucket's range is bounded by min <= x < max, In

323

# millisecond.

324

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

325

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

326

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

327

},

328

],

329

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

330

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

Bu Sun Kim

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

[diff] [blame]

331

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

332

"percentile": 42, # We use this field to store certain percentile value for this metric.

333

# For v4, this field contains pc50.

334

# For v5, this field contains pc90.

335

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

Bu Sun Kim

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

[diff] [blame]

336

},

337

},

338

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

Bu Sun Kim

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

[diff] [blame]

339

},

Bu Sun Kim