blob: bdc423d590aa106eb5d3606de6612aaf4a49a52d [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="pagespeedonline_v5.html">PageSpeed Insights API</a> . <a href="pagespeedonline_v5.pagespeedapi.html">pagespeedapi</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080081 <code><a href="#runpagespeed">runpagespeed(url=None, category=None, utm_campaign=None, captchaToken=None, locale=None, strategy=None, utm_source=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<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 Kim715bd7f2019-06-14 16:50:42 -070083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080090 <code class="details" id="runpagespeed">runpagespeed(url=None, category=None, utm_campaign=None, captchaToken=None, locale=None, strategy=None, utm_source=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <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 Kim715bd7f2019-06-14 16:50:42 -070092
93Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080094 url: string, Required. The URL to fetch and analyze
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070095 category: string, A Lighthouse category to run; if none are given, only Performance category will be run (repeated)
96 Allowed values
97 CATEGORY_UNSPECIFIED - Default UNDEFINED category.
98 ACCESSIBILITY - Accessibility (a11y), category pertaining to a website&#x27;s capacity to be accessible to all users.
99 BEST_PRACTICES - Best Practices, category pertaining to a website&#x27;s conformance to web best practice.
100 PERFORMANCE - Performance, category pertaining to a website&#x27;s performance.
101 PWA - Progressive Web App (PWA), category pertaining to a website&#x27;s ability to be run as a PWA.
102 SEO - Search Engine Optimization (SEO), category pertaining to a website&#x27;s ability to be indexed by search engines.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700103 utm_campaign: string, Campaign name for analytics.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800104 captchaToken: string, The captcha token passed when filling out a captcha.
105 locale: string, The locale used to localize formatted results
106 strategy: string, The analysis strategy (desktop or mobile) to use, and desktop is the default
107 Allowed values
108 STRATEGY_UNSPECIFIED - UNDEFINED.
109 DESKTOP - Fetch and analyze the URL for desktop browsers.
110 MOBILE - Fetch and analyze the URL for mobile devices.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700111 utm_source: string, Campaign source for analytics.
Dan O'Mearadd494642020-05-01 07:42:23 -0700112 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 1 - v1 error format
115 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116
117Returns:
118 An object of the form:
119
Dan O'Mearadd494642020-05-01 07:42:23 -0700120 { # The Pagespeed API response object.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800121 &quot;version&quot;: { # The Pagespeed Version object. # The version of PageSpeed used to generate these results.
122 &quot;major&quot;: &quot;A String&quot;, # The major version number of PageSpeed used to generate these results.
123 &quot;minor&quot;: &quot;A String&quot;, # The minor version number of PageSpeed used to generate these results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700124 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800125 &quot;captchaResult&quot;: &quot;A String&quot;, # The captcha verify result
126 &quot;analysisUTCTimestamp&quot;: &quot;A String&quot;, # The UTC timestamp of this analysis.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700127 &quot;kind&quot;: &quot;A String&quot;, # Kind of result.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800128 &quot;loadingExperience&quot;: { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of end users&#x27; page loading experience.
129 &quot;origin_fallback&quot;: True or False, # True if the result is an origin fallback from a page, false otherwise.
130 &quot;overall_category&quot;: &quot;A String&quot;, # The human readable speed &quot;category&quot; of the id.
131 &quot;initial_url&quot;: &quot;A String&quot;, # The requested URL, which may differ from the resolved &quot;id&quot;.
132 &quot;metrics&quot;: { # The map of .
133 &quot;a_key&quot;: { # A CrUX metric object for a single metric and form factor.
134 &quot;percentile&quot;: 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.
135 &quot;median&quot;: 42, # The median number of the metric, in millisecond.
136 &quot;category&quot;: &quot;A String&quot;, # The category of the specific time metric.
137 &quot;formFactor&quot;: &quot;A String&quot;, # Identifies the form factor of the metric being collected.
138 &quot;metricId&quot;: &quot;A String&quot;, # Identifies the type of the metric.
139 &quot;distributions&quot;: [ # Metric distributions. Proportions should sum up to 1.
140 { # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket&#x27;s range is bounded by min &lt;= x &lt; max, In millisecond.
141 &quot;proportion&quot;: 3.14, # The proportion of data in this bucket.
142 &quot;max&quot;: 42, # Upper bound for a bucket&#x27;s range.
143 &quot;min&quot;: 42, # Lower bound for a bucket&#x27;s range.
144 },
145 ],
146 },
147 },
148 &quot;id&quot;: &quot;A String&quot;, # The url, pattern or origin which the metrics are on.
149 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800150 &quot;lighthouseResult&quot;: { # The Lighthouse result object. # Lighthouse response for the audit url as an object.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800151 &quot;categories&quot;: { # The categories in a Lighthouse run. # Map of categories in the LHR.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800152 &quot;seo&quot;: { # A Lighthouse category. # The Search-Engine-Optimization (SEO) category, containing all seo related audits.
153 &quot;id&quot;: &quot;A String&quot;, # The string identifier of the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800154 &quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
155 { # A light reference to an audit by id, used to group and weight audits in a given category.
156 &quot;id&quot;: &quot;A String&quot;, # The audit ref id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800157 &quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800158 &quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800159 },
160 ],
161 &quot;manualDescription&quot;: &quot;A String&quot;, # A description for the manual audits in the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800162 &quot;description&quot;: &quot;A String&quot;, # A more detailed description of the category and its importance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800163 &quot;title&quot;: &quot;A String&quot;, # The human-friendly name of the category.
164 &quot;score&quot;: &quot;&quot;, # The overall score of the category, the weighted average of all its audits. (The category&#x27;s score, can be null.)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800165 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800166 &quot;accessibility&quot;: { # A Lighthouse category. # The accessibility category, containing all accessibility related audits.
167 &quot;id&quot;: &quot;A String&quot;, # The string identifier of the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800168 &quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
169 { # A light reference to an audit by id, used to group and weight audits in a given category.
170 &quot;id&quot;: &quot;A String&quot;, # The audit ref id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800171 &quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800172 &quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800173 },
174 ],
175 &quot;manualDescription&quot;: &quot;A String&quot;, # A description for the manual audits in the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800176 &quot;description&quot;: &quot;A String&quot;, # A more detailed description of the category and its importance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800177 &quot;title&quot;: &quot;A String&quot;, # The human-friendly name of the category.
178 &quot;score&quot;: &quot;&quot;, # The overall score of the category, the weighted average of all its audits. (The category&#x27;s score, can be null.)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800179 },
180 &quot;performance&quot;: { # A Lighthouse category. # The performance category, containing all performance related audits.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800181 &quot;id&quot;: &quot;A String&quot;, # The string identifier of the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800182 &quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
183 { # A light reference to an audit by id, used to group and weight audits in a given category.
184 &quot;id&quot;: &quot;A String&quot;, # The audit ref id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800185 &quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800186 &quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800187 },
188 ],
189 &quot;manualDescription&quot;: &quot;A String&quot;, # A description for the manual audits in the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800190 &quot;description&quot;: &quot;A String&quot;, # A more detailed description of the category and its importance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800191 &quot;title&quot;: &quot;A String&quot;, # The human-friendly name of the category.
192 &quot;score&quot;: &quot;&quot;, # The overall score of the category, the weighted average of all its audits. (The category&#x27;s score, can be null.)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800193 },
194 &quot;best-practices&quot;: { # A Lighthouse category. # The best practices category, containing all best practices related audits.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800195 &quot;id&quot;: &quot;A String&quot;, # The string identifier of the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800196 &quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
197 { # A light reference to an audit by id, used to group and weight audits in a given category.
198 &quot;id&quot;: &quot;A String&quot;, # The audit ref id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800199 &quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800200 &quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800201 },
202 ],
203 &quot;manualDescription&quot;: &quot;A String&quot;, # A description for the manual audits in the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800204 &quot;description&quot;: &quot;A String&quot;, # A more detailed description of the category and its importance.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800205 &quot;title&quot;: &quot;A String&quot;, # The human-friendly name of the category.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800206 &quot;score&quot;: &quot;&quot;, # The overall score of the category, the weighted average of all its audits. (The category&#x27;s score, can be null.)
207 },
208 &quot;pwa&quot;: { # A Lighthouse category. # The Progressive-Web-App (PWA) category, containing all pwa related audits.
209 &quot;id&quot;: &quot;A String&quot;, # The string identifier of the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800210 &quot;auditRefs&quot;: [ # An array of references to all the audit members of this category.
211 { # A light reference to an audit by id, used to group and weight audits in a given category.
212 &quot;id&quot;: &quot;A String&quot;, # The audit ref id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800213 &quot;weight&quot;: 3.14, # The weight this audit&#x27;s score has on the overall category score.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800214 &quot;group&quot;: &quot;A String&quot;, # The category group that the audit belongs to (optional).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800215 },
216 ],
217 &quot;manualDescription&quot;: &quot;A String&quot;, # A description for the manual audits in the category.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800218 &quot;description&quot;: &quot;A String&quot;, # A more detailed description of the category and its importance.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800219 &quot;title&quot;: &quot;A String&quot;, # The human-friendly name of the category.
220 &quot;score&quot;: &quot;&quot;, # The overall score of the category, the weighted average of all its audits. (The category&#x27;s score, can be null.)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700221 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700222 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800223 &quot;categoryGroups&quot;: { # Map of category groups in the LHR.
224 &quot;a_key&quot;: { # Message containing a category
225 &quot;title&quot;: &quot;A String&quot;, # The human readable title of the group
226 &quot;description&quot;: &quot;A String&quot;, # The description of what the category is grouping
227 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700228 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800229 &quot;requestedUrl&quot;: &quot;A String&quot;, # The original requested url.
230 &quot;lighthouseVersion&quot;: &quot;A String&quot;, # The lighthouse version that was used to generate this LHR.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700231 &quot;stackPacks&quot;: [ # The Stack Pack advice strings.
232 { # Message containing Stack Pack information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800233 &quot;id&quot;: &quot;A String&quot;, # The stack pack id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800234 &quot;title&quot;: &quot;A String&quot;, # The stack pack title.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700235 &quot;descriptions&quot;: { # The stack pack advice strings.
236 &quot;a_key&quot;: &quot;A String&quot;,
237 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800238 &quot;iconDataURL&quot;: &quot;A String&quot;, # The stack pack icon data uri.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700239 },
240 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800241 &quot;environment&quot;: { # Message containing environment configuration for a Lighthouse run. # Environment settings that were used when making this LHR.
242 &quot;hostUserAgent&quot;: &quot;A String&quot;, # The user agent string of the version of Chrome used.
243 &quot;networkUserAgent&quot;: &quot;A String&quot;, # The user agent string that was sent over the network.
244 &quot;benchmarkIndex&quot;: 3.14, # The benchmark index number that indicates rough device class.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800245 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800246 &quot;fetchTime&quot;: &quot;A String&quot;, # The time that this run was fetched.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800247 &quot;userAgent&quot;: &quot;A String&quot;, # The user agent that was used to run this LHR.
248 &quot;runWarnings&quot;: [ # List of all run warnings in the LHR. Will always output to at least `[]`.
249 &quot;&quot;,
250 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800251 &quot;finalUrl&quot;: &quot;A String&quot;, # The final resolved url that was audited.
252 &quot;runtimeError&quot;: { # 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.
253 &quot;code&quot;: &quot;A String&quot;, # The enumerated Lighthouse Error code.
254 &quot;message&quot;: &quot;A String&quot;, # A human readable message explaining the error code.
255 },
256 &quot;configSettings&quot;: { # Message containing the configuration settings for the Lighthouse run. # The configuration settings for this LHR.
257 &quot;emulatedFormFactor&quot;: &quot;A String&quot;, # The form factor the emulation should use.
258 &quot;locale&quot;: &quot;A String&quot;, # The locale setting.
259 &quot;onlyCategories&quot;: &quot;&quot;, # List of categories of audits the run should conduct.
260 &quot;channel&quot;: &quot;A String&quot;, # How Lighthouse was run, e.g. from the Chrome extension or from the npm module.
261 },
262 &quot;timing&quot;: { # Message containing the performance timing data for the Lighthouse run. # Timing information for this LHR.
263 &quot;total&quot;: 3.14, # The total duration of Lighthouse&#x27;s run.
264 },
265 &quot;i18n&quot;: { # Message containing the i18n data for the LHR - Version 1. # The internationalization strings that are required to render the LHR.
266 &quot;rendererFormattedStrings&quot;: { # Message holding the formatted strings used in the renderer. # Internationalized strings that are formatted to the locale in configSettings.
267 &quot;labDataTitle&quot;: &quot;A String&quot;, # The title of the lab data performance category.
268 &quot;auditGroupExpandTooltip&quot;: &quot;A String&quot;, # The tooltip text on an expandable chevron icon.
269 &quot;scorescaleLabel&quot;: &quot;A String&quot;, # The label that explains the score gauges scale (0-49, 50-89, 90-100).
270 &quot;opportunityResourceColumnLabel&quot;: &quot;A String&quot;, # The heading for the estimated page load savings opportunity of an audit.
271 &quot;varianceDisclaimer&quot;: &quot;A String&quot;, # The disclaimer shown below a performance metric value.
272 &quot;opportunitySavingsColumnLabel&quot;: &quot;A String&quot;, # The heading for the estimated page load savings of opportunity audits.
273 &quot;warningHeader&quot;: &quot;A String&quot;, # The label shown above a bulleted list of warnings.
274 &quot;lsPerformanceCategoryDescription&quot;: &quot;A String&quot;, # The disclaimer shown under performance explaning that the network can vary.
275 &quot;notApplicableAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading shown above a list of audits that do not apply to a page.
276 &quot;toplevelWarningsMessage&quot;: &quot;A String&quot;, # The label shown preceding important warnings that may have invalidated an entire report.
277 &quot;crcInitialNavigation&quot;: &quot;A String&quot;, # The label for the initial request in a critical request chain.
278 &quot;errorMissingAuditInfo&quot;: &quot;A String&quot;, # The error string shown next to an erroring audit.
279 &quot;errorLabel&quot;: &quot;A String&quot;, # The label shown next to an audit or metric that has had an error.
280 &quot;passedAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading that is shown above a list of audits that are passing.
281 &quot;crcLongestDurationLabel&quot;: &quot;A String&quot;, # The label for values shown in the summary of critical request chains.
282 &quot;manualAuditsGroupTitle&quot;: &quot;A String&quot;, # The heading shown above a list of audits that were not computerd in the run.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700283 },
284 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800285 &quot;audits&quot;: { # Map of audits in the LHR.
286 &quot;a_key&quot;: { # An audit&#x27;s result object in a Lighthouse result.
287 &quot;description&quot;: &quot;A String&quot;, # The description of the audit.
288 &quot;numericValue&quot;: 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.
289 &quot;title&quot;: &quot;A String&quot;, # The human readable title.
290 &quot;displayValue&quot;: &quot;A String&quot;, # The value that should be displayed on the UI for this audit.
291 &quot;score&quot;: &quot;&quot;, # The score of the audit, can be null.
292 &quot;id&quot;: &quot;A String&quot;, # The audit&#x27;s id.
293 &quot;details&quot;: { # Freeform details section of the audit.
294 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
295 },
296 &quot;errorMessage&quot;: &quot;A String&quot;, # An error message from a thrown error inside the audit.
297 &quot;scoreDisplayMode&quot;: &quot;A String&quot;, # The enumerated score display mode.
298 &quot;warnings&quot;: &quot;&quot;, # Possible warnings that occurred in the audit, can be null.
299 &quot;explanation&quot;: &quot;A String&quot;, # An explanation of the errors in the audit.
300 },
301 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800302 },
303 &quot;originLoadingExperience&quot;: { # The CrUX loading experience object that contains CrUX data breakdowns. # Metrics of the aggregated page loading experience of the origin
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800304 &quot;origin_fallback&quot;: True or False, # True if the result is an origin fallback from a page, false otherwise.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800305 &quot;overall_category&quot;: &quot;A String&quot;, # The human readable speed &quot;category&quot; of the id.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800306 &quot;initial_url&quot;: &quot;A String&quot;, # The requested URL, which may differ from the resolved &quot;id&quot;.
307 &quot;metrics&quot;: { # The map of .
308 &quot;a_key&quot;: { # A CrUX metric object for a single metric and form factor.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800309 &quot;percentile&quot;: 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.
310 &quot;median&quot;: 42, # The median number of the metric, in millisecond.
311 &quot;category&quot;: &quot;A String&quot;, # The category of the specific time metric.
312 &quot;formFactor&quot;: &quot;A String&quot;, # Identifies the form factor of the metric being collected.
313 &quot;metricId&quot;: &quot;A String&quot;, # Identifies the type of the metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800314 &quot;distributions&quot;: [ # Metric distributions. Proportions should sum up to 1.
315 { # A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket&#x27;s range is bounded by min &lt;= x &lt; max, In millisecond.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800316 &quot;proportion&quot;: 3.14, # The proportion of data in this bucket.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800317 &quot;max&quot;: 42, # Upper bound for a bucket&#x27;s range.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800318 &quot;min&quot;: 42, # Lower bound for a bucket&#x27;s range.
319 },
320 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800321 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700322 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800323 &quot;id&quot;: &quot;A String&quot;, # The url, pattern or origin which the metrics are on.
Bu Sun Kim65020912020-05-20 12:08:20 -0700324 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800325 &quot;id&quot;: &quot;A String&quot;, # Canonicalized and final URL for the document, after following page redirects (if any).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700326 }</pre>
327</div>
328
329</body></html>