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-20 12:08:20 -0700

[diff] [blame^]

82

<code class="details" id="runpagespeed">runpagespeed(locale=None, url=None, utm_campaign=None, captchaToken=None, strategy=None, category=None, utm_source=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

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

[diff] [blame]

88

locale: string, The locale used to localize formatted results

Dan O'Meara

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

[diff] [blame]

89

url: string, The URL to fetch and analyze

Bu Sun Kim

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

[diff] [blame^]

90

utm_campaign: string, Campaign name for analytics.

91

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

92

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

93

default

94

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

95

will be run (repeated)

96

utm_source: string, Campaign source for analytics.

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-20 12:08:20 -0700

[diff] [blame^]

106

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

107

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

108

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

109

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

110

# audits.

111

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

112

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

113

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

114

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

115

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

116

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

117

# given category.

118

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

119

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

120

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

Bu Sun Kim

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

[diff] [blame]

121

},

122

],

Bu Sun Kim

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

[diff] [blame^]

123

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

124

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

Bu Sun Kim

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

[diff] [blame]

125

},

Bu Sun Kim

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

[diff] [blame^]

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

# given category.

134

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

135

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

136

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

Bu Sun Kim

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

[diff] [blame]

137

},

138

],

Bu Sun Kim

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

[diff] [blame^]

139

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

140

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

141

},

142

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

143

# audits.

144

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

145

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

146

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

147

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

148

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

149

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

150

# given category.

151

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

152

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

153

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

154

},

155

],

156

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

157

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

158

},

159

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

160

# audits.

161

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

162

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

163

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

164

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

165

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

166

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

167

# given category.

168

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

169

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

170

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

171

},

172

],

173

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

174

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

175

},

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

# given category.

184

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

185

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

186

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

187

},

188

],

189

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

190

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

Bu Sun Kim

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

[diff] [blame]

191

},

192

},

Bu Sun Kim

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

[diff] [blame^]

193

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

Dan O'Meara

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

[diff] [blame]

194

{ # Message containing Stack Pack information.

Bu Sun Kim

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

[diff] [blame^]

195

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

196

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

197

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

198

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

199

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

200

},

Dan O'Meara

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

[diff] [blame]

201

},

202

],

Bu Sun Kim

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

[diff] [blame^]

203

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

204

"a_key": { # Message containing a category

205

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

206

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

Bu Sun Kim

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

[diff] [blame]

207

},

208

},

Bu Sun Kim

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

[diff] [blame^]

209

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

210

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

211

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

212

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

Dan O'Meara

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

[diff] [blame]

213

},

Bu Sun Kim

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

[diff] [blame^]

214

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

215

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

216

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

217

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

218

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

219

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

220

# module.

221

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

222

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

223

},

224

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

225

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

226

},

227

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

228

"",

229

],

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

},

238

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

239

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

240

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

241

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

242

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

243

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

Bu Sun Kim

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

[diff] [blame^]

244

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

245

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

246

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

Bu Sun Kim

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

[diff] [blame]

247

},

248

},

Bu Sun Kim

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

[diff] [blame^]

249

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

250

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

251

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

252

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

253

},

254

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

255

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

256

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

257

# configSettings.

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

# an entire report.

266

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

267

# audit.

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

# run.

276

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

277

# vary.

Bu Sun Kim

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

[diff] [blame]

278

},

279

},

Bu Sun Kim

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

[diff] [blame]

280

},

Bu Sun Kim

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

[diff] [blame^]

281

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

282

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

283

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

284

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

285

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

286

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

287

# For v4, this field contains pc50.

288

# For v5, this field contains pc90.

289

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

290

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

291

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

292

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

293

# millisecond.

294

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

295

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

296

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

297

},

298

],

299

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

300

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

301

},

302

},

303

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

304

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

305

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

306

},

307

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

308

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

309

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

310

},

311

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

Dan O'Meara

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

[diff] [blame]

312

# redirects (if any).

Bu Sun Kim