google_api_page_speed_online v0.10.1 GoogleApi.PageSpeedOnline.V5.Api.Pagespeedapi View Source

API calls for all endpoints tagged Pagespeedapi.

Link to this section Summary

Functions

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.

Link to this section Functions

Link to this function

pagespeedonline_pagespeedapi_runpagespeed(connection, optional_params \\ [], opts \\ [])

View Source

Specs

pagespeedonline_pagespeedapi_runpagespeed(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PageSpeedOnline.V5.Model.PagespeedApiPagespeedResponseV5.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.PageSpeedOnline.V5.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :captchaToken (type: String.t) - The captcha token passed when filling out a captcha.
    • :category (type: list(String.t)) - A Lighthouse category to run; if none are given, only Performance category will be run
    • :locale (type: String.t) - The locale used to localize formatted results
    • :strategy (type: String.t) - The analysis strategy (desktop or mobile) to use, and desktop is the default
    • :url (type: String.t) - Required. The URL to fetch and analyze
    • :utm_campaign (type: String.t) - Campaign name for analytics.
    • :utm_source (type: String.t) - Campaign source for analytics.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PageSpeedOnline.V5.Model.PagespeedApiPagespeedResponseV5{}} on success
  • {:error, info} on failure