google_api_page_speed_online v0.10.1 API Reference
Modules
API client metadata for GoogleApi.PageSpeedOnline.V2.
API calls for all endpoints tagged Pagespeedapi
.
Handle Tesla connections for GoogleApi.PageSpeedOnline.V2.
Attributes
-
args
(type:list(GoogleApi.PageSpeedOnline.V2.Model.PagespeedApiFormatStringV2Args.t)
, default:nil
) - List of arguments for the format string. -
format
(type:String.t
, default:nil
) - A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
Attributes
-
key
(type:String.t
, default:nil
) - The placeholder key for this arg, as a string. -
rects
(type:list(GoogleApi.PageSpeedOnline.V2.Model.PagespeedApiFormatStringV2ArgsRects.t)
, default:nil
) - The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot. -
secondary_rects
(type:list(GoogleApi.PageSpeedOnline.V2.Model.PagespeedApiFormatStringV2ArgsSecondaryRects.t)
, default:nil
) - Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. -
type
(type:String.t
, default:nil
) - Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT. -
value
(type:String.t
, default:nil
) - Argument value, as a localized string.
Attributes
-
height
(type:integer()
, default:nil
) - The height of the rect. -
left
(type:integer()
, default:nil
) - The left coordinate of the rect, in page coordinates. -
top
(type:integer()
, default:nil
) - The top coordinate of the rect, in page coordinates. -
width
(type:integer()
, default:nil
) - The width of the rect.
Attributes
-
height
(type:integer()
, default:nil
) - The height of the rect. -
left
(type:integer()
, default:nil
) - The left coordinate of the rect, in page coordinates. -
top
(type:integer()
, default:nil
) - The top coordinate of the rect, in page coordinates. -
width
(type:integer()
, default:nil
) - The width of the rect.
Attributes
-
data
(type:String.t
, default:nil
) - Image data base64 encoded. -
height
(type:integer()
, default:nil
) - Height of screenshot in pixels. -
key
(type:String.t
, default:nil
) - Unique string key, if any, identifying this image. -
mime_type
(type:String.t
, default:nil
) - Mime type of image data (e.g. "image/jpeg"). -
page_rect
(type:GoogleApi.PageSpeedOnline.V2.Model.PagespeedApiImageV2PageRect.t
, default:nil
) - The region of the page that is captured by this image, with dimensions measured in CSS pixels. -
width
(type:integer()
, default:nil
) - Width of screenshot in pixels.
The region of the page that is captured by this image, with dimensions measured in CSS pixels.
Attributes
-
captchaResult
(type:String.t
, default:nil
) - The captcha verify result -
formattedResults
(type:GoogleApi.PageSpeedOnline.V2.Model.ResultFormattedResults.t
, default:nil
) - Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. -
id
(type:String.t
, default:nil
) - Canonicalized and final URL for the document, after following page redirects (if any). -
invalidRules
(type:list(String.t)
, default:nil
) - List of rules that were specified in the request, but which the server did not know how to instantiate. -
kind
(type:String.t
, default:pagespeedonline#result
) - Kind of result. -
pageStats
(type:GoogleApi.PageSpeedOnline.V2.Model.ResultPageStats.t
, default:nil
) - Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. -
responseCode
(type:integer()
, default:nil
) - Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. -
ruleGroups
(type:map()
, default:nil
) - A map with one entry for each rule group in these results. -
screenshot
(type:GoogleApi.PageSpeedOnline.V2.Model.PagespeedApiImageV2.t
, default:nil
) - Base64-encoded screenshot of the page that was analyzed. -
title
(type:String.t
, default:nil
) - Title of the page, as displayed in the browser's title bar. -
version
(type:GoogleApi.PageSpeedOnline.V2.Model.ResultVersion.t
, default:nil
) - The version of PageSpeed used to generate these results.
Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.
Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
The version of PageSpeed used to generate these results.
API client metadata for GoogleApi.PageSpeedOnline.V4.
API calls for all endpoints tagged Pagespeedapi
.
Handle Tesla connections for GoogleApi.PageSpeedOnline.V4.
Attributes
-
args
(type:list(GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiFormatStringV4Args.t)
, default:nil
) - List of arguments for the format string. -
format
(type:String.t
, default:nil
) - A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'.
Attributes
-
key
(type:String.t
, default:nil
) - The placeholder key for this arg, as a string. -
rects
(type:list(GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiFormatStringV4ArgsRects.t)
, default:nil
) - The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot. -
secondary_rects
(type:list(GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiFormatStringV4ArgsSecondaryRects.t)
, default:nil
) - Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. -
type
(type:String.t
, default:nil
) - Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT. -
value
(type:String.t
, default:nil
) - Argument value, as a localized string.
Attributes
-
data
(type:String.t
, default:nil
) - Image data base64 encoded. -
height
(type:integer()
, default:nil
) - Height of screenshot in pixels. -
key
(type:String.t
, default:nil
) - Unique string key, if any, identifying this image. -
mime_type
(type:String.t
, default:nil
) - Mime type of image data (e.g. "image/jpeg"). -
page_rect
(type:GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiImageV4PageRect.t
, default:nil
) - -
width
(type:integer()
, default:nil
) - Width of screenshot in pixels.
Attributes
-
captchaResult
(type:String.t
, default:nil
) - The captcha verify result -
formattedResults
(type:GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4FormattedResults.t
, default:nil
) - Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. -
id
(type:String.t
, default:nil
) - Canonicalized and final URL for the document, after following page redirects (if any). -
invalidRules
(type:list(String.t)
, default:nil
) - List of rules that were specified in the request, but which the server did not know how to instantiate. -
kind
(type:String.t
, default:pagespeedonline#result
) - Kind of result. -
loadingExperience
(type:GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4LoadingExperience.t
, default:nil
) - Metrics of end users' page loading experience. -
pageStats
(type:GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4PageStats.t
, default:nil
) - Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. -
responseCode
(type:integer()
, default:nil
) - Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. -
ruleGroups
(type:map()
, default:nil
) - A map with one entry for each rule group in these results. -
screenshot
(type:GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiImageV4.t
, default:nil
) - Base64-encoded screenshot of the page that was analyzed. -
snapshots
(type:list(GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiImageV4.t)
, default:nil
) - Additional base64-encoded screenshots of the page, in various partial render states. -
title
(type:String.t
, default:nil
) - Title of the page, as displayed in the browser's title bar. -
version
(type:GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4Version.t
, default:nil
) - The version of PageSpeed used to generate these results.
Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.
Metrics of end users' page loading experience.
Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
The version of PageSpeed used to generate these results.
API client metadata for GoogleApi.PageSpeedOnline.V5.
API calls for all endpoints tagged Pagespeedapi
.
Handle Tesla connections for GoogleApi.PageSpeedOnline.V5.
A light reference to an audit by id, used to group and weight audits in a given category.
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.
The categories in a Lighthouse run.
Message containing a category
Message containing the configuration settings for the Lighthouse run.
Message containing environment configuration for a Lighthouse run.
Message containing the i18n data for the LHR - Version 1.
An audit's result object in a Lighthouse result.
A Lighthouse category.
The Lighthouse result object.
The CrUX loading experience object that contains CrUX data breakdowns.
The Pagespeed API response object.
The Pagespeed Version object.
Message holding the formatted strings used in the renderer.
Message containing a runtime error config.
Message containing Stack Pack information.
Message containing the performance timing data for the Lighthouse run.
A CrUX metric object for a single metric and form factor.