Method: pagespeedapi.runpagespeed

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

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
category

enum (Category)

Una categoria Lighthouse da eseguire; se non è specificata, verrà eseguita solo la categoria Prestazioni
locale

string

Le impostazioni internazionali utilizzate per localizzare i risultati formattati
strategy

enum (Strategy)

La strategia di analisi (desktop o dispositivo mobile) da utilizzare (desktop o mobile) è l'impostazione predefinita
url

string

Obbligatorio. L'URL da recuperare e analizzare
utm_campaign

string

Nome della campagna per Analytics.
utm_source

string

Sorgente campagna per Analytics.
captchaToken

string

Il token captcha inviato 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 della 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

Risultato della verifica captcha
id

string

URL canonico e finale del documento, dopo aver seguito reindirizzamenti di pagina (se presenti).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Metriche relative all'esperienza di caricamento delle pagine degli utenti finali.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Metriche dell'esperienza di caricamento delle pagine aggregate 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 che devono essere analizzate.

Enum
CATEGORY_UNSPECIFIED Categoria NON DEFINITA predefinita.
ACCESSIBILITY Accessibilità, 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 sul Web.
PERFORMANCE Rendimento, categoria relativa al rendimento di un sito web.
PWA App web progressive (PWA), categoria relativa alla capacità di un sito web di essere eseguito come PWA.
SEO Ottimizzazione per i motori di ricerca (SEO), categoria relativa alla capacità di un sito web di essere indicizzato dai motori di ricerca.

La strategia

La strategia del dispositivo da utilizzare nell'analisi.

Enum
STRATEGY_UNSPECIFIED NON DEFINITA.
DESKTOP Recupera e analizza l'URL per i browser desktop.
MOBILE Recupera e analizza l'URL per 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 in 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" leggibile della velocità dell'ID.
initial_url

string

L'URL richiesto, che può essere diverso dall'"id" risolto.
origin_fallback

boolean

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

LighthouseResultV5

L'oggetto del 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 originale richiesto.
finalUrl

string

L'URL finale risolto che è stato controllato.
lighthouseVersion

string

La versione 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 nell'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 dei gruppi di categorie nell'LHR.

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

object (StackPack)

Stringhe relative ai consigli dello 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 in LHR. L'output sarà sempre almeno pari a [].
runtimeError

object (RuntimeError)

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

object (Categories)

Mappa delle categorie nella LHR.
timing

object (Timing)

Informazioni sulle tempistiche per questo LHR.
configSettings

object (ConfigSettings)

Le impostazioni di configurazione per questo LHR.

Internazionalizzazione

Messaggio contenente i dati i18n per l'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

Il disclaimer mostrato sotto il valore di una metrica di rendimento.
opportunityResourceColumnLabel

string

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

string

L'intestazione per la stima dei risparmi durante il caricamento delle pagine dei controlli delle opportunità.
errorMissingAuditInfo

string

La stringa di errore visualizzata accanto a un controllo degli errori.
errorLabel

string

L'etichetta visualizzata accanto a un controllo o a una metrica che presenta un errore.
warningHeader

string

L'etichetta visualizzata sopra un elenco puntato di avvisi.
auditGroupExpandTooltip

string

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

string

L'intestazione visualizzata sopra un elenco dei controlli superati.
notApplicableAuditsGroupTitle

string

L'intestazione mostrata sopra è un elenco dei controlli che non si applicano a una pagina.
manualAuditsGroupTitle

string

L'intestazione mostrata sopra un elenco dei controlli non computerizzati durante l'esecuzione.
toplevelWarningsMessage

string

L'etichetta mostrata prima di avvisi importanti che potrebbero aver invalidato un intero report.
scorescaleLabel

string

L'etichetta che spiega la scala di valutazione (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

L'etichetta dei valori mostrati nel riepilogo delle catene di richieste critiche.
crcInitialNavigation

string

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

string

La limitazione di responsabilità mostrata sotto il rendimento che spiega che la rete può variare.
labDataTitle

string

Il titolo della categoria di rendimento 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 stack pack.
title

string

Il titolo dello stack pack.
iconDataURL

string

L'URI dei dati dell'icona di stack pack.
descriptions

map (key: string, value: string)

Le stringhe dei 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 dell'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 Lighthouse enumerato.
message

string

Un messaggio leggibile che spiega il codice di errore.

Categorie

Le categorie in un'esecuzione Lighthouse.

Rappresentazione JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    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, che contiene tutti gli audit relativi alle best practice.
seo

object (LighthouseCategoryV5)

La categoria di ottimizzazione per i motori di ricerca (SEO), contenente tutti i controlli correlati alla SEO.
pwa

object (LighthouseCategoryV5)

La categoria App web progressive (PWA), che contiene tutti i controlli relativi a Pwa.
performance

object (LighthouseCategoryV5)

La categoria di rendimento, contenente tutti i controlli relativi 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 stringa della categoria.
title

string

Il nome della categoria adatto alle persone.
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 relativi controlli. (Il punteggio della categoria può essere nullo).

AuditRefs

Un riferimento leggero 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 del 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 delle tempistiche 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 delle categorie di controlli che l'esecuzione dovrebbe eseguire.
emulatedFormFactor
(deprecated)

string

Il fattore di forma che deve essere utilizzato dall'emulazione. Questo campo è obsoleto; al suo posto è necessario utilizzare formFactor.
locale

string

Le impostazioni internazionali.
channel

string

La modalità di esecuzione di Lighthouse, ad esempio dall'estensione di Chrome o dal modulo npm.
formFactor

string

In che modo Lighthouse dovrebbe interpretare questa esecuzione per quanto riguarda la valutazione delle metriche sul rendimento e il salto dei test solo per dispositivi mobili sui 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 minore di PageSpeed utilizzato per generare questi risultati.