PagespeedInsights.Pagespeedapi.Runpagespeed (PageSpeed Insights API v5-rev20230705-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.pagespeedonline.v5.PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
        
        com.google.api.services.pagespeedonline.v5.PagespeedInsights.Pagespeedapi.Runpagespeed

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: PagespeedInsights.Pagespeedapi

public class PagespeedInsights.Pagespeedapi.Runpagespeed
extends PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Runpagespeed(String url)` 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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getCaptchaToken()` The captcha token passed when filling out a captcha.
`List<String>`	`getCategory()` A Lighthouse category to run; if none are given, only Performance category will be run
`String`	`getLocale()` The locale used to localize formatted results
`String`	`getStrategy()` The analysis strategy (desktop or mobile) to use, and desktop is the default
`String`	`getUrl()` Required.
`String`	`getUtmCampaign()` Campaign name for analytics.
`String`	`getUtmSource()` Campaign source for analytics.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`set(String parameterName, Object value)`
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`set$Xgafv(String $Xgafv)` V1 error format.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setAccessToken(String accessToken)` OAuth access token.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setAlt(String alt)` Data format for response.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setCallback(String callback)` JSONP
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setCaptchaToken(String captchaToken)` The captcha token passed when filling out a captcha.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setCategory(List<String> category)` A Lighthouse category to run; if none are given, only Performance category will be run
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setKey(String key)` API key.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setLocale(String locale)` The locale used to localize formatted results
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setStrategy(String strategy)` The analysis strategy (desktop or mobile) to use, and desktop is the default
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setUrl(String url)` Required.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setUtmCampaign(String utmCampaign)` Campaign name for analytics.
`PagespeedInsights.Pagespeedapi.Runpagespeed`	`setUtmSource(String utmSource)` Campaign source for analytics.

Methods inherited from class com.google.api.services.pagespeedonline.v5.PagespeedInsightsRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Runpagespeed
```
protected Runpagespeed(String url)
```
    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. Create a request for the method "pagespeedapi.runpagespeed". This request holds the parameters needed by the the pagespeedonline server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    PagespeedInsights.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    url - Required. The URL to fetch and analyze
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PagespeedApiPagespeedResponseV5>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PagespeedApiPagespeedResponseV5>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PagespeedInsights.Pagespeedapi.Runpagespeed set$Xgafv(String $Xgafv)
```
    Description copied from class: PagespeedInsightsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setAccessToken
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setAccessToken(String accessToken)
```
    Description copied from class: PagespeedInsightsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setAlt
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setAlt(String alt)
```
    Description copied from class: PagespeedInsightsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setCallback
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setCallback(String callback)
```
    Description copied from class: PagespeedInsightsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setFields
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setFields(String fields)
```
    Description copied from class: PagespeedInsightsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setKey
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setKey(String key)
```
    Description copied from class: PagespeedInsightsRequest
    
    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.
    
    Overrides:
    
    setKey in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setOauthToken
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setOauthToken(String oauthToken)
```
    Description copied from class: PagespeedInsightsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setPrettyPrint
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: PagespeedInsightsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setQuotaUser
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setQuotaUser(String quotaUser)
```
    Description copied from class: PagespeedInsightsRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setUploadType
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setUploadType(String uploadType)
```
    Description copied from class: PagespeedInsightsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - setUploadProtocol
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setUploadProtocol(String uploadProtocol)
```
    Description copied from class: PagespeedInsightsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>
  - getUrl
```
public String getUrl()
```
    Required. The URL to fetch and analyze
  - setUrl
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setUrl(String url)
```
    Required. The URL to fetch and analyze
  - getCaptchaToken
```
public String getCaptchaToken()
```
    The captcha token passed when filling out a captcha.
  - setCaptchaToken
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setCaptchaToken(String captchaToken)
```
    The captcha token passed when filling out a captcha.
  - getCategory
```
public List<String> getCategory()
```
    A Lighthouse category to run; if none are given, only Performance category will be run
  - setCategory
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setCategory(List<String> category)
```
    A Lighthouse category to run; if none are given, only Performance category will be run
  - getLocale
```
public String getLocale()
```
    The locale used to localize formatted results
  - setLocale
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setLocale(String locale)
```
    The locale used to localize formatted results
  - getStrategy
```
public String getStrategy()
```
    The analysis strategy (desktop or mobile) to use, and desktop is the default
  - setStrategy
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setStrategy(String strategy)
```
    The analysis strategy (desktop or mobile) to use, and desktop is the default
  - getUtmCampaign
```
public String getUtmCampaign()
```
    Campaign name for analytics.
  - setUtmCampaign
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setUtmCampaign(String utmCampaign)
```
    Campaign name for analytics.
  - getUtmSource
```
public String getUtmSource()
```
    Campaign source for analytics.
  - setUtmSource
```
public PagespeedInsights.Pagespeedapi.Runpagespeed setUtmSource(String utmSource)
```
    Campaign source for analytics.
  - set
```
public PagespeedInsights.Pagespeedapi.Runpagespeed set(String parameterName,
                                                       Object value)
```
    Overrides:
    
    set in class PagespeedInsightsRequest<PagespeedApiPagespeedResponseV5>

Class PagespeedInsights.Pagespeedapi.Runpagespeed

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.pagespeedonline.v5.PagespeedInsightsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Runpagespeed

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getUrl

setUrl

getCaptchaToken

setCaptchaToken

getCategory

setCategory

getLocale

setLocale

getStrategy

setStrategy

getUtmCampaign

setUtmCampaign

getUtmSource

setUtmSource

set