Ejecuta el análisis de PageSpeed en la página de la URL especificada y muestra las puntuaciones de PageSpeed, una lista de sugerencias para que la página sea más rápida y otro tipo de información.
Solicitud HTTP
GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros | |
---|---|
category |
Una categoría de Lighthouse para ejecutar. Si no se proporciona ninguna, solo se ejecutará la categoría de Rendimiento. |
locale |
La configuración regional que se usa para localizar resultados con formato |
strategy |
La estrategia de análisis (computadoras de escritorio o dispositivos móviles) que se debe utilizar y la versión predeterminada para computadoras de escritorio es |
url |
Obligatorio. La URL que se recuperará y analizará |
utm_campaign |
Nombre de la campaña para Analytics. |
utm_source |
Fuente de la campaña para estadísticas. |
captchaToken |
El token del captcha que se pasa cuando se completa un captcha. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
El objeto de respuesta de la API de Pagespeed.
Representación JSON | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
Campos | |
---|---|
kind |
Tipo de resultado. |
captchaResult |
El resultado de la verificación de captcha |
id |
Es la URL canónica y la URL final del documento, después de los redireccionamientos de la página siguiente (si corresponde). |
loadingExperience |
Son las métricas de la experiencia de carga de las páginas de los usuarios finales. |
originLoadingExperience |
Métricas de la experiencia de carga de páginas agregada del origen |
analysisUTCTimestamp |
La marca de tiempo UTC de este análisis. |
lighthouseResult |
Respuesta de Lighthouse para la URL de auditoría como un objeto. |
version |
Es la versión de PageSpeed que se usa para generar estos resultados. |
Alcances de la autorización
Requiere el siguiente alcance de OAuth:
openid
Para obtener más información, consulta la Descripción general de OAuth 2.0.
Categoría
Las categorías enumeradas que deben analizarse.
Enumeradores | |
---|---|
CATEGORY_UNSPECIFIED |
Es la categoría predeterminada UNDEFINED. |
ACCESSIBILITY |
Accesibilidad (a11y), categoría relacionada con la capacidad de un sitio web para ser accesible para todos los usuarios. |
BEST_PRACTICES |
Prácticas recomendadas, categoría relativa al cumplimiento de un sitio web con las prácticas recomendadas para la Web. |
PERFORMANCE |
Rendimiento, categoría relacionada con el rendimiento de un sitio web. |
SEO |
Optimización del motor de búsqueda (SEO), categoría relacionada con la capacidad de un sitio web para que los motores de búsqueda lo indexen. |
Estrategia
Es la estrategia del dispositivo en ejecución que se usará en el análisis.
Enumeradores | |
---|---|
STRATEGY_UNSPECIFIED |
INDEFINIDA. |
DESKTOP |
Recupera y analiza la URL para navegadores para computadoras. |
MOBILE |
Recupera y analiza la URL para dispositivos móviles. |
PagespeedApiLoadingExperienceV5
El objeto de experiencia de carga de CrUX que contiene desgloses de datos de CrUX
Representación JSON | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
Campos | |
---|---|
id |
Es la URL, el origen o el patrón en los que se encuentran las métricas. |
metrics |
El mapa de <metrics, data>. Es un objeto que contiene una lista de pares |
overall_category |
Es la "categoría" de velocidad legible del ID. |
initial_url |
La URL solicitada, que puede diferir del "id" resuelto. |
origin_fallback |
Es verdadero si el resultado es un resguardo de origen de una página. De lo contrario, es falso. |
LighthouseResultV5
El objeto de resultado de Lighthouse
Representación JSON | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
Campos | |
---|---|
fetchTime |
La hora a la que se recuperó esta ejecución. |
requestedUrl |
La URL solicitada originalmente. |
finalUrl |
La URL final resuelta que se auditó. |
lighthouseVersion |
Es la versión del faro que se usó para generar este LHR. |
i18n |
Las cadenas de internacionalización necesarias para renderizar el LHR. |
userAgent |
El usuario-agente que se usó para ejecutar este LHR. |
audits |
Mapa de auditorías en el LHR. Es un objeto que contiene una lista de pares |
categoryGroups |
Mapa de grupos de categorías en el LHR Es un objeto que contiene una lista de pares |
stackPacks[] |
Las cadenas de asesoramiento del paquete de pila. |
environment |
La configuración del entorno que se usó cuando se creó este LHR. |
runWarnings |
Lista de todas las advertencias de ejecución en el LHR. Siempre se mostrará como mínimo |
runtimeError |
Un mensaje de error de nivel superior que, si está presente, indica un problema lo suficientemente grave como para que se deba descartar este resultado de Lighthouse. |
categories |
Mapa de categorías en el LHR |
timing |
Información sobre el tiempo para este LHR |
configSettings |
Son los parámetros de configuración de este LHR. |
I18n
Mensaje que contiene los datos de i18n para el LHR (versión 1).
Representación JSON | |
---|---|
{
"rendererFormattedStrings": {
object ( |
Campos | |
---|---|
rendererFormattedStrings |
Cadenas internacionalizadas que se formatean según la configuración regional en configSettings. |
RendererFormattedStrings
Mensaje que contiene las cadenas con formato que se usaron en el procesador.
Representación 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 } |
Campos | |
---|---|
varianceDisclaimer |
La renuncia de responsabilidad que se muestra debajo del valor de una métrica de rendimiento |
opportunityResourceColumnLabel |
El encabezado de la oportunidad de ahorro de carga de página estimado de una auditoría. |
opportunitySavingsColumnLabel |
Es el encabezado que muestra el ahorro estimado en la carga de páginas de las auditorías de oportunidades. |
errorMissingAuditInfo |
La cadena de error que se muestra junto a una auditoría con errores. |
errorLabel |
Es la etiqueta que se muestra junto a una auditoría o métrica que tiene un error. |
warningHeader |
La etiqueta que aparece sobre una lista con viñetas de advertencias. |
auditGroupExpandTooltip |
El texto de información sobre la herramienta en un ícono de cheurón expandible. |
passedAuditsGroupTitle |
El encabezado que se muestra sobre una lista de auditorías aprobadas. |
notApplicableAuditsGroupTitle |
El encabezado que se muestra sobre una lista de auditorías que no se aplican a una página. |
manualAuditsGroupTitle |
Es el encabezado que se muestra sobre una lista de auditorías que no se procesaron durante la ejecución. |
toplevelWarningsMessage |
La etiqueta que se muestra antes de las advertencias importantes que pueden haber invalidado un informe completo. |
scorescaleLabel |
Es la etiqueta que explica la escala de los indicadores de puntuación (0-49, 50-89, 90-100). |
crcLongestDurationLabel |
La etiqueta de los valores que se muestran en el resumen de las cadenas de solicitudes críticas. |
crcInitialNavigation |
La etiqueta de la solicitud inicial en una cadena de solicitudes crítica. |
lsPerformanceCategoryDescription |
La renuncia de responsabilidad que se muestra debajo del rendimiento y que explica que la red puede variar. |
labDataTitle |
Es el título de la categoría de rendimiento de los datos de lab. |
StackPack
Mensaje que contiene información sobre el paquete de pila.
Representación JSON | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
Campos | |
---|---|
id |
Es el ID del paquete de pila. |
title |
Es el título del paquete de pila. |
iconDataURL |
El URI de datos del ícono del paquete de pila. |
descriptions |
Las cadenas de asesoramiento del paquete de pila. Es un objeto que contiene una lista de pares |
Entorno
Mensaje que contiene la configuración del entorno para una ejecución de Lighthouse.
Representación JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
Campos | |
---|---|
networkUserAgent |
Es la cadena del usuario-agente que se envió a través de la red. |
hostUserAgent |
Es la cadena del usuario-agente de la versión de Chrome que se usó. |
benchmarkIndex |
El número de índice comparativo que indica la clase de dispositivo aproximada. |
RuntimeError
Mensaje que contiene una configuración de error de entorno de ejecución.
Representación JSON | |
---|---|
{ "code": string, "message": string } |
Campos | |
---|---|
code |
El código de error de Lighthouse enumerado. |
message |
Un mensaje legible en el que se explica el código de error. |
Categorías
Las categorías en Lighthouse se ejecutan.
Representación JSON | |
---|---|
{ "accessibility": { object ( |
Campos | |
---|---|
accessibility |
La categoría de accesibilidad, que contiene todas las auditorías relacionadas con la accesibilidad. |
best-practices |
La categoría de prácticas recomendadas, que contiene todas las auditorías relacionadas con las prácticas recomendadas. |
seo |
La categoría Optimización para motores de búsqueda (SEO), que contiene todas las auditorías relacionadas con SEO |
performance |
Es la categoría de rendimiento, que contiene todas las auditorías relacionadas con el rendimiento. |
LighthouseCategoryV5
Una categoría de Lighthouse.
Representación JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
Campos | |
---|---|
id |
Es el identificador de cadena de la categoría. |
title |
Es el nombre sencillo de la categoría. |
description |
Una descripción más detallada de la categoría y su importancia. |
manualDescription |
Una descripción de las auditorías manuales en la categoría. |
auditRefs[] |
Un array de referencias a todos los miembros de auditoría de esta categoría. |
score |
La puntuación general de la categoría, el promedio ponderado de todas sus auditorías. (La puntuación de la categoría puede ser nula). |
AuditRefs
Es una referencia ligera a una auditoría por ID, que se usa para agrupar y ponderar auditorías en una categoría determinada.
Representación JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
Campos | |
---|---|
id |
Es el ID de referencia de la auditoría. |
weight |
El peso que tiene la puntuación de esta auditoría en la puntuación general de la categoría. |
group |
El grupo de categorías al que pertenece la auditoría (opcional). |
Tiempos
Mensaje que contiene los datos de tiempo de rendimiento de la ejecución de Lighthouse.
Representación JSON | |
---|---|
{ "total": number } |
Campos | |
---|---|
total |
La duración total de la ejecución de Lighthouse. |
ConfigSettings
Mensaje que contiene los parámetros de configuración de la ejecución de Lighthouse.
Representación JSON | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
Campos | |
---|---|
onlyCategories |
Lista de categorías de auditorías que la ejecución debe realizar. |
emulatedFormFactor |
Es el factor de forma que debe usar la emulación. Este campo dejó de estar disponible. En su lugar, se debe usar formFactor. |
locale |
Es la configuración regional. |
channel |
La manera en que se ejecutó Lighthouse, p. ej., desde la extensión de Chrome o desde el módulo de npm |
formFactor |
Cómo Lighthouse debería interpretar esta ejecución con respecto a la puntuación de métricas de rendimiento y la omisión de pruebas exclusivas para dispositivos móviles en computadoras de escritorio |
PagespeedVersion
El objeto Pagespeed Version.
Representación JSON | |
---|---|
{ "major": string, "minor": string } |
Campos | |
---|---|
major |
Es el número de versión principal de PageSpeed que se usa para generar estos resultados. |
minor |
Es el número de versión secundaria de PageSpeed que se usa para generar estos resultados. |