Method: pagespeedapi.runpagespeed

Ejecuta PageSpeed Analysis en la página de la URL especificada y muestra las puntuaciones de PageSpeed, una lista de sugerencias para hacer que esa página sea más rápida, entre otros datos.

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

enum (Category)

Una categoría de Lighthouse para ejecutar; Si no se proporciona ninguna, solo se ejecutará la categoría Rendimiento.
locale

string

La configuración regional que se usa para localizar resultados con formato
strategy

enum (Strategy)

La estrategia de análisis (computadoras de escritorio o dispositivos móviles) que se usará y las computadoras de escritorio son la opción predeterminada.
url

string

Obligatorio. La URL para recuperar y analizar
utm_campaign

string

Nombre de la campaña para Analytics.
utm_source

string

Fuente de la campaña para estadísticas.
captchaToken

string

El token de 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 (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Campos
kind

string

Tipo de resultado.
captchaResult

string

Resultado de la verificación de captcha
id

string

URL final canónica y final del documento, después de los redireccionamientos de página siguientes (si los hubiera).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Métricas de las métricas de carga de página.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Métricas de la experiencia de carga de páginas agregada del origen
analysisUTCTimestamp

string

La marca de tiempo UTC de este análisis.
lighthouseResult

object (LighthouseResultV5)

Respuesta de Lighthouse para la URL de auditoría como un objeto.
version

object (PagespeedVersion)

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 se deben analizar.

Enumeraciones
CATEGORY_UNSPECIFIED Categoría predeterminada UNDEFINED.
ACCESSIBILITY Accesibilidad (a11y), categoría que corresponde a la capacidad de un sitio web de ser accesible para todos los usuarios.
BEST_PRACTICES Prácticas recomendadas: categoría que corresponde al cumplimiento de un sitio web con las prácticas recomendadas para la Web.
PERFORMANCE Rendimiento: Es la categoría correspondiente al rendimiento de un sitio web.
SEO Optimización para motores de búsqueda (SEO), categoría que corresponde a la capacidad de un sitio web de ser indexado por los motores de búsqueda.

Estrategia

Es la estrategia de ejecución del dispositivo que se utilizará en el análisis.

Enumeraciones
STRATEGY_UNSPECIFIED SIN DEFINIR.
DESKTOP Recupera y analiza la URL para navegadores de escritorio.
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 (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Campos
id

string

La URL, el patrón o el origen en el que se encuentran las métricas.
metrics

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

El mapa de <metrics, data>.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
overall_category

string

La “categoría” de velocidad legible por humanos del ID.
initial_url

string

La URL solicitada, que puede diferir del valor "id" resuelto.
origin_fallback

boolean

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 (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)
  }
}
Campos
fetchTime

string

La hora a la que se recuperó esta ejecución.
requestedUrl

string

La URL original solicitada.
finalUrl

string

La URL final resuelta que se auditó.
lighthouseVersion

string

Es la versión de faro que se usó para generar este LHR.
i18n

object (I18n)

Las cadenas de internacionalización que se requieren para procesar el LHR.
userAgent

string

El usuario-agente que se usó para ejecutar este LHR.
audits

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

Mapa de auditorías en el LHR.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
categoryGroups

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

Mapa de los grupos de categorías en el LHR.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
stackPacks[]

object (StackPack)

Las cadenas de consejos del Stack Pack.
environment

object (Environment)

La configuración del entorno que se usó cuando se creó este LHR.
runWarnings

array (ListValue format)

Lista de todas las advertencias de ejecución en el LHR. El resultado siempre será, al menos, [].
runtimeError

object (RuntimeError)

Un mensaje de error de nivel superior que, si está presente, indica un problema lo suficientemente grave como para que este resultado de Lighthouse deba descartarse.
categories

object (Categories)

Mapa de categorías en el LHR.
timing

object (Timing)

Información de horarios para este LHR.
configSettings

object (ConfigSettings)

Es la configuración de este LHR.

I18n

Mensaje que contiene los datos de i18n del LHR: versión 1.

Representación JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Campos
rendererFormattedStrings

object (RendererFormattedStrings)

Cadenas internacionalizadas que tienen el formato de la configuración regional de configSettings.

RendererFormattedStrings

Mensaje que contiene las cadenas con formato que se usan 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

string

La renuncia de responsabilidad que se muestra debajo de un valor de métrica de rendimiento.
opportunityResourceColumnLabel

string

El encabezado de la oportunidad de ahorro estimado en la carga de páginas de una auditoría.
opportunitySavingsColumnLabel

string

Título del ahorro estimado en la carga de páginas de las auditorías de oportunidades.
errorMissingAuditInfo

string

La cadena de error que se muestra junto a una auditoría con errores.
errorLabel

string

La etiqueta que se muestra junto a una auditoría o métrica que tuvo un error.
warningHeader

string

La etiqueta que se muestra sobre una lista con viñetas de advertencias.
auditGroupExpandTooltip

string

El texto de información sobre la herramienta en un ícono de cheurón expandible.
passedAuditsGroupTitle

string

El encabezado que se muestra sobre la lista de auditorías aprobadas.
notApplicableAuditsGroupTitle

string

El encabezado que se muestra sobre una lista de auditorías que no corresponden a una página.
manualAuditsGroupTitle

string

El encabezado que se muestra sobre una lista de auditorías que no se procesaron durante la ejecución.
toplevelWarningsMessage

string

Es la etiqueta que se muestra antes de las advertencias importantes que pueden haber invalidado un informe completo.
scorescaleLabel

string

La etiqueta que explica la escala de los indicadores (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

La etiqueta de los valores que se muestran en el resumen de las cadenas de solicitudes críticas.
crcInitialNavigation

string

La etiqueta de la solicitud inicial en una cadena de solicitudes críticas.
lsPerformanceCategoryDescription

string

La renuncia de responsabilidad que se muestra debajo de la planificación del rendimiento y que la red puede variar.
labDataTitle

string

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

string

Es el ID del paquete de pila.
title

string

Es el título del paquete de pila.
iconDataURL

string

El URI de datos del ícono del paquete de pila.
descriptions

map (key: string, value: string)

Las cadenas de consejos del paquete de pila.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

string

La cadena usuario-agente que se envió a través de la red.
hostUserAgent

string

La cadena de usuario-agente de la versión de Chrome utilizada.
benchmarkIndex

number

El número del índice de comparativas que indica la clase aproximada de dispositivo.

RuntimeError

Mensaje que contiene una configuración de error del entorno de ejecución.

Representación JSON 
{
  "code": string,
  "message": string
}
Campos
code

string

El código de error de Lighthouse enumerado.
message

string

Un mensaje legible por humanos que explica el código de error.

Categorías

Son las categorías en una ejecución de Lighthouse.

Representación JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Campos
accessibility

object (LighthouseCategoryV5)

La categoría de accesibilidad, que contiene todas las auditorías relacionadas con la accesibilidad.
best-practices

object (LighthouseCategoryV5)

La categoría de prácticas recomendadas, que contiene todas las auditorías relacionadas con las prácticas recomendadas
seo

object (LighthouseCategoryV5)

La categoría Optimización para motores de búsqueda (SEO), que contiene todas las auditorías relacionadas con SEO
performance

object (LighthouseCategoryV5)

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 (AuditRefs)
    }
  ],
  "score": value
}
Campos
id

string

Es el identificador de cadena de la categoría.
title

string

Es el nombre sencillo de la categoría.
description

string

Una descripción más detallada de la categoría y su importancia.
manualDescription

string

Una descripción de las auditorías manuales en la categoría.
auditRefs[]

object (AuditRefs)

Un array de referencias a todos los miembros de la auditoría de esta categoría.
score

value (Value format)

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

Una referencia ligera a una auditoría por ID, que se usa para agrupar y ponderar las auditorías en una categoría determinada.

Representación JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
Campos
id

string

El ID de referencia de auditoría
weight

number

La ponderación de la puntuación de esta auditoría en la puntuación general de la categoría.
group

string

La categoría del grupo 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

number

Duración total de la ejecución de Lighthouse.

ConfigSettings

Mensaje que contiene la configuración de la ejecución de Lighthouse.

Representación JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Campos
onlyCategories

value (Value format)

Lista de categorías de auditorías que la ejecución debe realizar.
emulatedFormFactor
(deprecated)

string

El factor de forma que debe usar la emulación. Este campo dejó de estar disponible. En su lugar, se debe usar formFactor.
locale

string

Es la configuración regional.
channel

string

Cómo se ejecutó Lighthouse, p.ej. desde la extensión de Chrome o desde el módulo npm.
formFactor

string

La forma en la que Lighthouse debe interpretar esta ejecución en relación con la puntuación de las métricas de rendimiento y la omisión de las pruebas solo en dispositivos móviles en computadoras de escritorio.

PagespeedVersion

El objeto Pagespeed Version.

Representación JSON 
{
  "major": string,
  "minor": string
}
Campos
major

string

Indica el número de versión principal de PageSpeed que se utiliza para generar estos resultados.
minor

string

Indica el número de versión secundaria de PageSpeed que se utiliza para generar estos resultados.