google_api_page_speed_online v0.5.0 API Reference

Modules

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

  • height (type: integer(), default: nil) -
  • left (type: integer(), default: nil) -
  • top (type: integer(), default: nil) -
  • width (type: integer(), default: nil) -

Attributes

  • height (type: integer(), default: nil) -
  • left (type: integer(), default: nil) -
  • top (type: integer(), default: nil) -
  • width (type: integer(), default: nil) -

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

  • height (type: integer(), default: nil) -
  • left (type: integer(), default: nil) -
  • top (type: integer(), default: nil) -
  • width (type: integer(), default: nil) -

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.

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 calls for all endpoints tagged Pagespeedapi.

Handle Tesla connections for GoogleApi.PageSpeedOnline.V5.

Attributes

  • description (type: String.t, default: nil) - The description of the audit.
  • details (type: map(), default: nil) - Freeform details section of the audit.
  • displayValue (type: String.t, default: nil) - The value that should be displayed on the UI for this audit.
  • errorMessage (type: String.t, default: nil) - An error message from a thrown error inside the audit.
  • explanation (type: String.t, default: nil) - An explanation of the errors in the audit.
  • id (type: String.t, default: nil) - The audit's id.
  • numericValue (type: float(), default: nil) - 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.
  • score (type: any(), default: nil) -
  • scoreDisplayMode (type: String.t, default: nil) - The enumerated score display mode.
  • title (type: String.t, default: nil) - The human readable title.
  • warnings (type: any(), default: nil) -

Attributes

  • auditRefs (type: list(GoogleApi.PageSpeedOnline.V5.Model.LighthouseCategoryV5AuditRefs.t), default: nil) - An array of references to all the audit members of this category.
  • description (type: String.t, default: nil) - A more detailed description of the category and its importance.
  • id (type: String.t, default: nil) - The string identifier of the category.
  • manualDescription (type: String.t, default: nil) - A description for the manual audits in the category.
  • score (type: any(), default: nil) -
  • title (type: String.t, default: nil) - The human-friendly name of the category.

Attributes

  • group (type: String.t, default: nil) - The category group that the audit belongs to (optional).
  • id (type: String.t, default: nil) - The audit ref id.
  • weight (type: float(), default: nil) - The weight this audit's score has on the overall category score.

Attributes

  • audits (type: %{optional(String.t) => GoogleApi.PageSpeedOnline.V5.Model.LighthouseAuditResultV5.t}, default: nil) - Map of audits in the LHR.
  • categories (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5Categories.t, default: nil) - Map of categories in the LHR.
  • categoryGroups (type: map(), default: nil) - Map of category groups in the LHR.
  • configSettings (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5ConfigSettings.t, default: nil) - The configuration settings for this LHR.
  • environment (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5Environment.t, default: nil) - Environment settings that were used when making this LHR.
  • fetchTime (type: String.t, default: nil) - The time that this run was fetched.
  • finalUrl (type: String.t, default: nil) - The final resolved url that was audited.
  • i18n (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5I18n.t, default: nil) - The internationalization strings that are required to render the LHR.
  • lighthouseVersion (type: String.t, default: nil) - The lighthouse version that was used to generate this LHR.
  • requestedUrl (type: String.t, default: nil) - The original requested url.
  • runWarnings (type: GoogleApi.PageSpeedOnline.V5.Model.GoogleprotobufListValue.t, default: nil) - List of all run warnings in the LHR. Will always output to at least [].
  • runtimeError (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5RuntimeError.t, default: nil) - A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded.
  • stackPacks (type: list(GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5StackPacks.t), default: nil) - The Stack Pack advice strings.
  • timing (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5Timing.t, default: nil) - Timing information for this LHR.
  • userAgent (type: String.t, default: nil) - The user agent that was used to run this LHR.

Environment settings that were used when making this LHR.

The internationalization strings that are required to render the LHR.

Internationalized strings that are formatted to the locale in configSettings.

A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded.

Attributes

  • descriptions (type: map(), default: nil) - The stack pack advice strings.
  • iconDataURL (type: String.t, default: nil) - The stack pack icon data uri.
  • id (type: String.t, default: nil) - The stack pack id.
  • title (type: String.t, default: nil) - The stack pack title.

Attributes

  • id (type: String.t, default: nil) - The url, pattern or origin which the metrics are on.
  • initial_url (type: String.t, default: nil) -
  • metrics (type: map(), default: nil) -
  • overall_category (type: String.t, default: nil) -

Attributes

  • analysisUTCTimestamp (type: String.t, default: nil) - The UTC timestamp of this analysis.
  • captchaResult (type: String.t, default: nil) - The captcha verify result
  • id (type: String.t, default: nil) - Canonicalized and final URL for the document, after following page redirects (if any).
  • kind (type: String.t, default: pagespeedonline#result) - Kind of result.
  • lighthouseResult (type: GoogleApi.PageSpeedOnline.V5.Model.LighthouseResultV5.t, default: nil) - Lighthouse response for the audit url as an object.
  • loadingExperience (type: GoogleApi.PageSpeedOnline.V5.Model.PagespeedApiLoadingExperienceV5.t, default: nil) - Metrics of end users' page loading experience.
  • originLoadingExperience (type: GoogleApi.PageSpeedOnline.V5.Model.PagespeedApiLoadingExperienceV5.t, default: nil) - Metrics of the aggregated page loading experience of the origin
  • version (type: GoogleApi.PageSpeedOnline.V5.Model.PagespeedApiPagespeedResponseV5Version.t, default: nil) - The version of PageSpeed used to generate these results.

The version of PageSpeed used to generate these results.