Struct google_pagespeedonline5::api::PagespeedapiRunpagespeedCall[−][src]

pub struct PagespeedapiRunpagespeedCall<'a> { /* fields omitted */ }

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.

A builder for the runpagespeed method supported by a pagespeedapi resource. It is not used directly, but through a PagespeedapiMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.pagespeedapi().runpagespeed("url")
             .utm_source("duo")
             .utm_campaign("ipsum")
             .strategy("sed")
             .locale("ut")
             .add_category("gubergren")
             .captcha_token("rebum.")
             .doit().await;

Implementations

impl<'a> PagespeedapiRunpagespeedCall<'a>[src]

pub async fn doit(
    self
) -> Result<(Response<Body>, PagespeedApiPagespeedResponseV5)>[src]

Perform the operation you have build so far.

pub fn url(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

Required. The URL to fetch and analyze

Sets the url query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn utm_source(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

Campaign source for analytics.

Sets the utm_source query property to the given value.

pub fn utm_campaign(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

Campaign name for analytics.

Sets the utm_campaign query property to the given value.

pub fn strategy(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

The analysis strategy (desktop or mobile) to use, and desktop is the default

Sets the strategy query property to the given value.

pub fn locale(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

The locale used to localize formatted results

Sets the locale query property to the given value.

pub fn add_category(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

A Lighthouse category to run; if none are given, only Performance category will be run

Append the given value to the category query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.

pub fn captcha_token(self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a>[src]

The captcha token passed when filling out a captcha.

Sets the captcha token query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> PagespeedapiRunpagespeedCall<'a>[src]

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> PagespeedapiRunpagespeedCall<'a> where
    T: AsRef<str>, [src]

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

  • $.xgafv (query-string) - V1 error format.
  • access_token (query-string) - OAuth access token.
  • alt (query-string) - Data format for response.
  • callback (query-string) - JSONP
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • key (query-string) - 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 (query-string) - OAuth 2.0 token for the current user.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • quotaUser (query-string) - 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 (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
  • upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

pub fn add_scope<T, S>(self, scope: T) -> PagespeedapiRunpagespeedCall<'a> where
    T: Into<Option<S>>,
    S: AsRef<str>, [src]

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::Openid.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.