Method: pagespeedapi.runpagespeed

Esegue l'analisi PageSpeed sulla pagina all'URL specificato e restituisce i punteggi PageSpeed, un elenco di suggerimenti per rendere la pagina più veloce e altre informazioni.

Richiesta HTTP

GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
category

enum (Category)

Una categoria Lighthouse da eseguire; Se non ne viene specificata nessuna, verrà eseguita solo la categoria Rendimento

locale

string

Le impostazioni internazionali utilizzate per localizzare i risultati formattati

strategy

enum (Strategy)

La strategia di analisi (computer o dispositivo mobile) da utilizzare è quella predefinita.

url

string

Obbligatorio. L'URL da recuperare e analizzare

utm_campaign

string

Nome della campagna per Analytics.

utm_source

string

Sorgente campagna per analisi.

captchaToken

string

Il token captcha passato durante la compilazione di un captcha.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

L'oggetto di risposta dell'API Pagespeed.

Rappresentazione JSON
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Campi
kind

string

Tipo di risultato.

captchaResult

string

Il risultato della verifica captcha

id

string

URL canonico e finale del documento, dopo gli eventuali reindirizzamenti delle pagine successivi.

loadingExperience

object (PagespeedApiLoadingExperienceV5)

Le metriche relative agli utenti finali l'esperienza di caricamento delle pagine.

originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Metriche relative all'esperienza di caricamento delle pagine aggregata dell'origine

analysisUTCTimestamp

string

Il timestamp UTC di questa analisi.

lighthouseResult

object (LighthouseResultV5)

Risposta Lighthouse per l'URL di controllo come oggetto.

version

object (PagespeedVersion)

La versione di PageSpeed utilizzata per generare questi risultati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • openid

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.

Categoria

Le categorie enumerate da analizzare.

Enum
CATEGORY_UNSPECIFIED Categoria UNDEFINED predefinita.
ACCESSIBILITY Accessibilità (a11y), categoria relativa alla capacità di un sito web di essere accessibile a tutti gli utenti.
BEST_PRACTICES Best practice, categoria relativa alla conformità di un sito web alle best practice per il web.
PERFORMANCE Rendimento, categoria relativa al rendimento di un sito web.
SEO Ottimizzazione per i motori di ricerca (SEO), categoria relativa alla capacità di un sito web di essere indicizzato dai motori di ricerca.

Strategia

La strategia di esecuzione del dispositivo da usare nell'analisi.

Enum
STRATEGY_UNSPECIFIED NON DEFINITO.
DESKTOP Recupera e analizza l'URL per i browser desktop.
MOBILE Recupera e analizza l'URL per i dispositivi mobili.

PagespeedApiLoadingExperienceV5

L'oggetto dell'esperienza di caricamento di CrUX che contiene le suddivisioni dei dati CrUX.

Rappresentazione JSON
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Campi
id

string

L'URL, il pattern o l'origine su cui si trovano le metriche.

metrics

map (key: string, value: object (UserPageLoadMetricV5))

La mappa di <metrics, data>.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

overall_category

string

La "categoria" di velocità leggibile da una persona dell'ID.

initial_url

string

L'URL richiesto, che potrebbe essere diverso dall'"id" risolto.

origin_fallback

boolean

True se il risultato è un'origine di riserva da una pagina, false in caso contrario.

LighthouseResultV5

L'oggetto risultato Lighthouse.

Rappresentazione JSON
{
  "fetchTime": string,
  "requestedUrl": string,
  "finalUrl": string,
  "lighthouseVersion": string,
  "i18n": {
    object (I18n)
  },
  "userAgent": string,
  "audits": {
    string: {
      object (LighthouseAuditResultV5)
    },
    ...
  },
  "categoryGroups": {
    string: {
      object (CategoryGroupV5)
    },
    ...
  },
  "stackPacks": [
    {
      object (StackPack)
    }
  ],
  "environment": {
    object (Environment)
  },
  "runWarnings": array,
  "runtimeError": {
    object (RuntimeError)
  },
  "categories": {
    object (Categories)
  },
  "timing": {
    object (Timing)
  },
  "configSettings": {
    object (ConfigSettings)
  }
}
Campi
fetchTime

string

L'ora in cui è stata recuperata questa esecuzione.

requestedUrl

string

L'URL richiesto originale.

finalUrl

string

L'URL risolto finale che è stato controllato.

lighthouseVersion

string

La versione del faro utilizzata per generare questo LHR.

i18n

object (I18n)

Le stringhe di internazionalizzazione necessarie per il rendering dell'LHR.

userAgent

string

Lo user agent utilizzato per eseguire questo LHR.

audits

map (key: string, value: object (LighthouseAuditResultV5))

Mappa degli audit nella LHR.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

categoryGroups

map (key: string, value: object (CategoryGroupV5))

Mappa di gruppi di categorie nel LHR.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

stackPacks[]

object (StackPack)

Stringhe di consigli di Stack Pack.

environment

object (Environment)

Impostazioni dell'ambiente utilizzate durante la creazione di questo LHR.

runWarnings

array (ListValue format)

Elenco di tutti gli avvisi di esecuzione nell'LHR. L'output sarà sempre almeno pari ad almeno [].

runtimeError

object (RuntimeError)

Un messaggio di errore di primo livello che, se presente, indica un problema abbastanza grave da richiedere l'eliminazione di questo risultato Lighthouse.

categories

object (Categories)

Mappa di categorie nella LHR.

timing

object (Timing)

Informazioni sui tempi per questo LHR.

configSettings

object (ConfigSettings)

Le impostazioni di configurazione per questo LHR.

Internazionalizzazione

Messaggio contenente i dati i18n per LHR - Versione 1.

Rappresentazione JSON
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Campi
rendererFormattedStrings

object (RendererFormattedStrings)

Stringhe internazionalizzate formattate per le impostazioni internazionali in configSettings.

RendererFormattedStrings

Messaggio che contiene le stringhe formattate utilizzate nel renderer.

Rappresentazione JSON
{
  "varianceDisclaimer": string,
  "opportunityResourceColumnLabel": string,
  "opportunitySavingsColumnLabel": string,
  "errorMissingAuditInfo": string,
  "errorLabel": string,
  "warningHeader": string,
  "auditGroupExpandTooltip": string,
  "passedAuditsGroupTitle": string,
  "notApplicableAuditsGroupTitle": string,
  "manualAuditsGroupTitle": string,
  "toplevelWarningsMessage": string,
  "scorescaleLabel": string,
  "crcLongestDurationLabel": string,
  "crcInitialNavigation": string,
  "lsPerformanceCategoryDescription": string,
  "labDataTitle": string
}
Campi
varianceDisclaimer

string

Disclaimer mostrato sotto il valore di una metrica sul rendimento.

opportunityResourceColumnLabel

string

L'intestazione dell'opportunità di risparmio stimato del caricamento pagina di un controllo.

opportunitySavingsColumnLabel

string

L'intestazione per i risparmi stimati per il caricamento delle pagine dei controlli delle opportunità.

errorMissingAuditInfo

string

La stringa di errore mostrata accanto a un controllo con errori.

errorLabel

string

L'etichetta mostrata accanto a un controllo o a una metrica che ha generato un errore.

warningHeader

string

Etichetta visualizzata sopra un elenco puntato di avvisi.

auditGroupExpandTooltip

string

Il testo della descrizione comando su un'icona con freccia di espansione a forma di freccia.

passedAuditsGroupTitle

string

Intestazione visualizzata sopra un elenco di controlli superati.

notApplicableAuditsGroupTitle

string

Intestazione mostrata sopra un elenco di controlli che non si applicano a una pagina.

manualAuditsGroupTitle

string

Intestazione mostrata sopra un elenco di controlli che non sono stati computerizzati durante l'esecuzione.

toplevelWarningsMessage

string

L'etichetta mostrava avvisi importanti che potrebbero aver invalidato un intero report.

scorescaleLabel

string

L'etichetta che spiega la scala dei punteggi (0-49, 50-89, 90-100).

crcLongestDurationLabel

string

L'etichetta per i valori visualizzati nel riepilogo delle catene di richieste critiche.

crcInitialNavigation

string

L'etichetta della richiesta iniziale in una catena di richieste critiche.

lsPerformanceCategoryDescription

string

Disclaimer mostrato sotto le prestazioni che spiega che la rete può variare.

labDataTitle

string

Il titolo della categoria di prestazioni dei dati del lab.

StackPack

Messaggio contenente informazioni sullo Stack Pack.

Rappresentazione JSON
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Campi
id

string

L'ID dello stack pack.

title

string

Il titolo dello stack pack.

iconDataURL

string

URI di dati dell'icona dello stack pack.

descriptions

map (key: string, value: string)

Le stringhe di consigli dello stack pack.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Ambiente

Messaggio contenente la configurazione dell'ambiente per un'esecuzione di Lighthouse.

Rappresentazione JSON
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Campi
networkUserAgent

string

La stringa dello user agent inviata tramite la rete.

hostUserAgent

string

La stringa dello user agent della versione di Chrome utilizzata.

benchmarkIndex

number

Il numero di indice di benchmark che indica la classe approssimativa del dispositivo.

RuntimeError

Messaggio contenente una configurazione degli errori di runtime.

Rappresentazione JSON
{
  "code": string,
  "message": string
}
Campi
code

string

Il codice di errore enumerato di Lighthouse.

message

string

Un messaggio leggibile che spiega il codice di errore.

Categorie

Le categorie in un'esecuzione di Lighthouse.

Rappresentazione JSON
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Campi
accessibility

object (LighthouseCategoryV5)

La categoria di accessibilità, contenente tutti i controlli relativi all'accessibilità.

best-practices

object (LighthouseCategoryV5)

La categoria delle best practice, contenente tutti i controlli correlati alle best practice.

seo

object (LighthouseCategoryV5)

La categoria Ottimizzazione per i motori di ricerca (SEO) che contiene tutti i controlli correlati a questo argomento.

performance

object (LighthouseCategoryV5)

La categoria delle prestazioni, contenente tutti i controlli correlati alle prestazioni.

LighthouseCategoryV5

Una categoria Lighthouse.

Rappresentazione JSON
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Campi
id

string

L'identificatore di stringa della categoria.

title

string

Il nome della categoria.

description

string

Una descrizione più dettagliata della categoria e della sua importanza.

manualDescription

string

Una descrizione dei controlli manuali nella categoria.

auditRefs[]

object (AuditRefs)

Un array di riferimenti a tutti i membri del controllo di questa categoria.

score

value (Value format)

Il punteggio complessivo della categoria, la media ponderata di tutti i controlli. Il punteggio della categoria può essere nullo.

AuditRefs

Un semplice riferimento a un controllo per ID, utilizzato per raggruppare e ponderare i controlli in una determinata categoria.

Rappresentazione JSON
{
  "id": string,
  "weight": number,
  "group": string
}
Campi
id

string

L'ID di riferimento di controllo.

weight

number

La ponderazione del punteggio di questo controllo sul punteggio complessivo della categoria.

group

string

Il gruppo di categorie a cui appartiene il controllo (facoltativo).

Tempi

Messaggio contenente i dati sui tempi delle prestazioni per l'esecuzione di Lighthouse.

Rappresentazione JSON
{
  "total": number
}
Campi
total

number

La durata totale dell'esecuzione di Lighthouse.

ConfigSettings

Messaggio contenente le impostazioni di configurazione per l'esecuzione di Lighthouse.

Rappresentazione JSON
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Campi
onlyCategories

value (Value format)

Elenco di categorie di controlli che l'esecuzione deve eseguire.

emulatedFormFactor
(deprecated)

string

Il fattore di forma che deve essere utilizzato dall'emulazione. Questo campo è obsoleto. Al suo posto deve essere utilizzato il fattore di forma.

locale

string

Le impostazioni internazionali.

channel

string

Come è stato eseguito Lighthouse, ad esempio dall'estensione di Chrome o dal modulo npm.

formFactor

string

Come Lighthouse deve interpretare questa esecuzione per quanto riguarda la valutazione delle metriche delle prestazioni e l'esclusione dei test solo per dispositivi mobili su computer.

PagespeedVersion

L'oggetto Pagespeed Version.

Rappresentazione JSON
{
  "major": string,
  "minor": string
}
Campi
major

string

Il numero di versione principale di PageSpeed utilizzato per generare questi risultati.

minor

string

Il numero di versione secondario di PageSpeed utilizzato per generare questi risultati.