Executa a análise do PageSpeed na página do URL especificado e retorna as pontuações do PageSpeed, uma lista de sugestões para tornar a página mais rápida e outras informações.
Solicitação HTTP
GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
Parâmetros | |
---|---|
category |
Uma categoria do Lighthouse a ser executada; se nenhuma for fornecida, somente a categoria Desempenho será executada |
locale |
A localidade usada para localizar resultados formatados |
strategy |
A estratégia de análise (computador ou dispositivo móvel) a ser usada, sendo o computador o padrão. |
url |
Obrigatório. O URL a ser buscado e analisado |
utm_campaign |
Nome da campanha para análise. |
utm_source |
Origem da campanha para análise. |
captchaToken |
O token de captcha transmitido ao preencher um captcha. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
O objeto de resposta da API Pagespeed.
Representação JSON | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
Campos | |
---|---|
kind |
Tipo de resultado. |
captchaResult |
Resultado da verificação do captcha |
id |
É o URL canonizado e final do documento, após redirecionamentos de página (se houver). |
loadingExperience |
Métricas da experiência de carregamento da página dos usuários finais. |
originLoadingExperience |
Métricas da experiência agregada de carregamento de página da origem |
analysisUTCTimestamp |
O carimbo de data/hora UTC desta análise. |
lighthouseResult |
Resposta do Lighthouse para o URL de auditoria como um objeto. |
version |
A versão do PageSpeed usada para gerar estes resultados. |
Escopos de autorização
Requer o seguinte escopo OAuth:
openid
Para mais informações, consulte a Visão geral do OAuth 2.0.
Categoria
As categorias enumeradas que precisam ser analisadas.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
Categoria padrão UNDEFINED. |
ACCESSIBILITY |
Acessibilidade (a11y), categoria relacionada à capacidade de um site ser acessível a todos os usuários. |
BEST_PRACTICES |
Práticas recomendadas, categoria relacionada à conformidade de um site com as práticas recomendadas da Web. |
PERFORMANCE |
Desempenho, categoria relacionada ao desempenho de um site. |
PWA |
Progressive Web App (PWA), categoria relacionada à capacidade de um site ser executado como um PWA. |
SEO |
Otimização de mecanismos de pesquisa (SEO), categoria relacionada à capacidade de um site de ser indexado pelos mecanismos de pesquisa. |
Estratégia
A estratégia de execução do dispositivo a ser usada na análise.
Enums | |
---|---|
STRATEGY_UNSPECIFIED |
SEM DEFINIÇÃO. |
DESKTOP |
Busque e analise o URL para navegadores para computador. |
MOBILE |
Busque e analise o URL para dispositivos móveis. |
PagespeedApiLoadingExperienceV5
O objeto da experiência de carregamento do CrUX que contém detalhamentos dos dados.
Representação JSON | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
Campos | |
---|---|
id |
O URL, o padrão ou a origem em que as métricas estão. |
metrics |
O mapa de <metrics, data>. Um objeto com uma lista de pares |
overall_category |
A "categoria" de velocidade legível do ID. |
initial_url |
O URL solicitado, que pode ser diferente do "id" resolvido. |
origin_fallback |
Verdadeiro se o resultado for um substituto de origem de uma página. Caso contrário, será falso. |
LighthouseResultV5
O objeto de resultado do Lighthouse.
Representação JSON | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
Campos | |
---|---|
fetchTime |
A hora em que essa execução foi buscada. |
requestedUrl |
O URL original solicitado. |
finalUrl |
O URL final resolvido que foi auditado. |
lighthouseVersion |
A versão do farol usada para gerar este LHR. |
i18n |
As strings de internacionalização necessárias para renderizar o LHR. |
userAgent |
O user agent utilizado para executar este LHR. |
audits |
Mapa de auditorias do LHR. Um objeto com uma lista de pares |
categoryGroups |
Mapa de grupos de categorias no LHR. Um objeto com uma lista de pares |
stackPacks[] |
As strings de recomendação do pacote de pilha. |
environment |
Configurações do ambiente usadas ao criar este LHR. |
runWarnings |
Lista de todos os alertas de execução no LHR. A saída sempre será pelo menos |
runtimeError |
Uma mensagem de erro de nível superior que, se presente, indica um problema grave o suficiente para que esse resultado do Lighthouse precise ser descartado. |
categories |
Mapa de categorias no LHR. |
timing |
Informações de tempo para este LHR. |
configSettings |
As definições de configuração deste LHR. |
Localização
Mensagem contendo os dados de i18n para o LHR - Versão 1.
Representação JSON | |
---|---|
{
"rendererFormattedStrings": {
object ( |
Campos | |
---|---|
rendererFormattedStrings |
Strings internacionalizadas formatadas para a localidade em configSettings. |
RendererFormattedStrings
Mensagem contendo as strings formatadas usadas no renderizador.
Representação 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 |
A exoneração de responsabilidade mostrada abaixo de um valor de métrica de desempenho. |
opportunityResourceColumnLabel |
O título da oportunidade estimada de economia de carregamento de página de uma auditoria. |
opportunitySavingsColumnLabel |
O título para a economia estimada de carregamento de página das auditorias de oportunidade. |
errorMissingAuditInfo |
A string de erro mostrada ao lado de uma auditoria com erros. |
errorLabel |
O rótulo exibido ao lado de uma auditoria ou métrica com erro. |
warningHeader |
O rótulo mostrado acima de uma lista com marcadores de avisos. |
auditGroupExpandTooltip |
O texto da dica em um ícone de chevron expansível. |
passedAuditsGroupTitle |
O cabeçalho que é mostrado acima de uma lista de auditorias aprovadas. |
notApplicableAuditsGroupTitle |
O título mostrado acima de uma lista de auditorias que não se aplicam a uma página. |
manualAuditsGroupTitle |
O título mostrado acima de uma lista de auditorias que não foram computadas na execução. |
toplevelWarningsMessage |
O rótulo mostrado antes de avisos importantes que podem ter invalidado um relatório inteiro. |
scorescaleLabel |
O rótulo que explica a escala dos medidores de pontuação (0 a 49, 50 a 89, 90 a 100). |
crcLongestDurationLabel |
O rótulo dos valores mostrados no resumo das cadeias de solicitação críticas. |
crcInitialNavigation |
O rótulo da solicitação inicial em uma cadeia de solicitação crítica. |
lsPerformanceCategoryDescription |
A exoneração de responsabilidade mostrada abaixo do desempenho explicando que a rede pode variar. |
labDataTitle |
O título da categoria de desempenho de dados do laboratório. |
StackPack
Mensagem contendo informações do pacote de pilha.
Representação JSON | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
Campos | |
---|---|
id |
O ID do pacote de pilha. |
title |
Título do pacote de pilha. |
iconDataURL |
O URI de dados do ícone do pacote de pilhas. |
descriptions |
As strings de orientação do pacote de pilhas. Um objeto com uma lista de pares |
Ambiente
Mensagem com a configuração do ambiente para uma execução do Lighthouse.
Representação JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
Campos | |
---|---|
networkUserAgent |
A string do user agent enviada pela rede. |
hostUserAgent |
A string do user agent da versão do Chrome usada. |
benchmarkIndex |
É o número do índice de comparação que indica a classe aproximada do dispositivo. |
RuntimeError
Mensagem contendo uma configuração de erro de tempo de execução.
Representação JSON | |
---|---|
{ "code": string, "message": string } |
Campos | |
---|---|
code |
O código de erro do Lighthouse enumerado. |
message |
Uma mensagem legível explicando o código do erro. |
Categorias
As categorias de uma execução do Lighthouse.
Representação JSON | |
---|---|
{ "accessibility": { object ( |
Campos | |
---|---|
accessibility |
A categoria de acessibilidade, que contém todas as auditorias relacionadas à acessibilidade. |
best-practices |
A categoria de práticas recomendadas, que contém todas as auditorias relacionadas às práticas recomendadas. |
seo |
A categoria Otimização de mecanismos de pesquisa (SEO, na sigla em inglês), contendo todas as auditorias relacionadas a SEO. |
pwa |
A categoria de Progressive Web App (PWA), contendo todas as auditorias relacionadas a pwa. |
performance |
A categoria de performance, que contém todas as auditorias relacionadas a isso. |
LighthouseCategoryV5
Uma categoria do Lighthouse.
Representação JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
Campos | |
---|---|
id |
O identificador de string da categoria. |
title |
O nome legível da categoria. |
description |
Uma descrição mais detalhada da categoria e sua importância. |
manualDescription |
Uma descrição para as auditorias manuais na categoria. |
auditRefs[] |
Uma matriz de referências a todos os membros de auditoria dessa categoria. |
score |
A pontuação geral da categoria, a média ponderada de todas as auditorias. A pontuação da categoria pode ser nula. |
AuditRefs
Uma referência simples a uma auditoria por ID, usada para agrupar auditorias de peso em uma determinada categoria.
Representação JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
Campos | |
---|---|
id |
O ID de referência da auditoria. |
weight |
O peso que a pontuação desta auditoria tem na pontuação da categoria geral. |
group |
O grupo de categorias a que a auditoria pertence (opcional). |
Cronograma
Mensagem que contém os dados de tempo de desempenho para a execução do Lighthouse.
Representação JSON | |
---|---|
{ "total": number } |
Campos | |
---|---|
total |
A duração total da execução do Lighthouse. |
ConfigSettings
Mensagem contendo as definições de configuração para a execução do Lighthouse.
Representação JSON | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
Campos | |
---|---|
onlyCategories |
Lista de categorias de auditorias que a execução deve realizar. |
emulatedFormFactor |
O formato que a emulação precisa usar. O uso desse campo foi descontinuado. Use formFactor |
locale |
A configuração de localidade. |
channel |
Como o Lighthouse foi executado, por exemplo, a partir da extensão do Chrome ou do módulo npm. |
formFactor |
Como o Lighthouse deve interpretar a execução em relação às métricas de desempenho da pontuação e ao pular testes somente para dispositivos móveis no computador. |
PagespeedVersion
O objeto Pagespeed Version.
Representação JSON | |
---|---|
{ "major": string, "minor": string } |
Campos | |
---|---|
major |
O número da versão principal do PageSpeed usado para gerar esses resultados. |
minor |
O número da versão secundária do PageSpeed usado para gerar estes resultados. |