Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit f2210e1

Browse files
committedMar 21, 2023
feat(pagespeedonline): update the api
#### pagespeedonline:v5 The following keys were added: - schemas.Environment.properties.credits (Total Keys: 2) - schemas.LhrEntity (Total Keys: 9) - schemas.LighthouseResultV5.properties.entities (Total Keys: 2) - schemas.LighthouseResultV5.properties.fullPageScreenshot.type (Total Keys: 1)
1 parent 4762dd6 commit f2210e1

File tree

2 files changed

+79
-1
lines changed

2 files changed

+79
-1
lines changed
 

‎docs/dyn/pagespeedonline_v5.pagespeedapi.html

+18
Original file line numberDiff line numberDiff line change
@@ -246,13 +246,30 @@ <h3>Method Details</h3>
246246
&quot;locale&quot;: &quot;A String&quot;, # The locale setting.
247247
&quot;onlyCategories&quot;: &quot;&quot;, # List of categories of audits the run should conduct.
248248
},
249+
&quot;entities&quot;: [ # Entity classification data.
250+
{ # Message containing an Entity.
251+
&quot;category&quot;: &quot;A String&quot;, # Optional. An optional category name for the entity.
252+
&quot;homepage&quot;: &quot;A String&quot;, # Optional. An optional homepage URL of the entity.
253+
&quot;isFirstParty&quot;: True or False, # Optional. An optional flag indicating if the entity is the first party.
254+
&quot;isUnrecognized&quot;: True or False, # Optional. An optional flag indicating if the entity is not recognized.
255+
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the entity.
256+
&quot;origins&quot;: [ # Required. A list of URL origin strings that belong to this entity.
257+
&quot;A String&quot;,
258+
],
259+
},
260+
],
249261
&quot;environment&quot;: { # Message containing environment configuration for a Lighthouse run. # Environment settings that were used when making this LHR.
250262
&quot;benchmarkIndex&quot;: 3.14, # The benchmark index number that indicates rough device class.
263+
&quot;credits&quot;: { # The version of libraries with which these results were generated. Ex: axe-core.
264+
&quot;a_key&quot;: &quot;A String&quot;,
265+
},
251266
&quot;hostUserAgent&quot;: &quot;A String&quot;, # The user agent string of the version of Chrome used.
252267
&quot;networkUserAgent&quot;: &quot;A String&quot;, # The user agent string that was sent over the network.
253268
},
254269
&quot;fetchTime&quot;: &quot;A String&quot;, # The time that this run was fetched.
270+
&quot;finalDisplayedUrl&quot;: &quot;A String&quot;, # URL displayed on the page after Lighthouse finishes.
255271
&quot;finalUrl&quot;: &quot;A String&quot;, # The final resolved url that was audited.
272+
&quot;fullPageScreenshot&quot;: &quot;&quot;, # Screenshot data of the full page, along with node rects relevant to the audit results.
256273
&quot;i18n&quot;: { # Message containing the i18n data for the LHR - Version 1. # The internationalization strings that are required to render the LHR.
257274
&quot;rendererFormattedStrings&quot;: { # Message holding the formatted strings used in the renderer. # Internationalized strings that are formatted to the locale in configSettings.
258275
&quot;auditGroupExpandTooltip&quot;: &quot;A String&quot;, # The tooltip text on an expandable chevron icon.
@@ -306,6 +323,7 @@ <h3>Method Details</h3>
306323
},
307324
},
308325
&quot;lighthouseVersion&quot;: &quot;A String&quot;, # The lighthouse version that was used to generate this LHR.
326+
&quot;mainDocumentUrl&quot;: &quot;A String&quot;, # URL of the main document request of the final navigation.
309327
&quot;requestedUrl&quot;: &quot;A String&quot;, # The original requested url.
310328
&quot;runWarnings&quot;: [ # List of all run warnings in the LHR. Will always output to at least `[]`.
311329
&quot;&quot;,

‎googleapiclient/discovery_cache/documents/pagespeedonline.v5.json

+61-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@
193193
}
194194
}
195195
},
196-
"revision": "20230309",
196+
"revision": "20230317",
197197
"rootUrl": "https://pagespeedonline.googleapis.com/",
198198
"schemas": {
199199
"AuditRefs": {
@@ -327,6 +327,13 @@
327327
"format": "double",
328328
"type": "number"
329329
},
330+
"credits": {
331+
"additionalProperties": {
332+
"type": "string"
333+
},
334+
"description": "The version of libraries with which these results were generated. Ex: axe-core.",
335+
"type": "object"
336+
},
330337
"hostUserAgent": {
331338
"description": "The user agent string of the version of Chrome used.",
332339
"type": "string"
@@ -349,6 +356,40 @@
349356
},
350357
"type": "object"
351358
},
359+
"LhrEntity": {
360+
"description": "Message containing an Entity.",
361+
"id": "LhrEntity",
362+
"properties": {
363+
"category": {
364+
"description": "Optional. An optional category name for the entity.",
365+
"type": "string"
366+
},
367+
"homepage": {
368+
"description": "Optional. An optional homepage URL of the entity.",
369+
"type": "string"
370+
},
371+
"isFirstParty": {
372+
"description": "Optional. An optional flag indicating if the entity is the first party.",
373+
"type": "boolean"
374+
},
375+
"isUnrecognized": {
376+
"description": "Optional. An optional flag indicating if the entity is not recognized.",
377+
"type": "boolean"
378+
},
379+
"name": {
380+
"description": "Required. Name of the entity.",
381+
"type": "string"
382+
},
383+
"origins": {
384+
"description": "Required. A list of URL origin strings that belong to this entity.",
385+
"items": {
386+
"type": "string"
387+
},
388+
"type": "array"
389+
}
390+
},
391+
"type": "object"
392+
},
352393
"LighthouseAuditResultV5": {
353394
"description": "An audit's result object in a Lighthouse result.",
354395
"id": "LighthouseAuditResultV5",
@@ -469,6 +510,13 @@
469510
"$ref": "ConfigSettings",
470511
"description": "The configuration settings for this LHR."
471512
},
513+
"entities": {
514+
"description": "Entity classification data.",
515+
"items": {
516+
"$ref": "LhrEntity"
517+
},
518+
"type": "array"
519+
},
472520
"environment": {
473521
"$ref": "Environment",
474522
"description": "Environment settings that were used when making this LHR."
@@ -477,10 +525,18 @@
477525
"description": "The time that this run was fetched.",
478526
"type": "string"
479527
},
528+
"finalDisplayedUrl": {
529+
"description": "URL displayed on the page after Lighthouse finishes.",
530+
"type": "string"
531+
},
480532
"finalUrl": {
481533
"description": "The final resolved url that was audited.",
482534
"type": "string"
483535
},
536+
"fullPageScreenshot": {
537+
"description": "Screenshot data of the full page, along with node rects relevant to the audit results.",
538+
"type": "any"
539+
},
484540
"i18n": {
485541
"$ref": "I18n",
486542
"description": "The internationalization strings that are required to render the LHR."
@@ -489,6 +545,10 @@
489545
"description": "The lighthouse version that was used to generate this LHR.",
490546
"type": "string"
491547
},
548+
"mainDocumentUrl": {
549+
"description": "URL of the main document request of the final navigation.",
550+
"type": "string"
551+
},
492552
"requestedUrl": {
493553
"description": "The original requested url.",
494554
"type": "string"

0 commit comments

Comments
 (0)
Please sign in to comment.