Method: pagespeedapi.runpagespeed

Executa uma análise do PageSpeed na página no URL especificado e retorna as pontuações do PageSpeed, uma lista de sugestões para tornar a página mais rápida, além de 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

enum (Category)

Uma categoria do Lighthouse a ser executada. Se nenhuma for fornecida, somente a categoria "Desempenho" será executada
locale

string

Localidade usada para localizar resultados formatados
strategy

enum (Strategy)

A estratégia de análise (computador ou dispositivo móvel) a ser usada (computador é o padrão)
url

string

Obrigatório. O URL a ser buscado e analisado
utm_campaign

string

Nome da campanha para análise.
utm_source

string

Origem da campanha para análise.
captchaToken

string

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

string

Tipo de resultado.
captchaResult

string

O resultado da verificação de captcha
id

string

URL canonizado e final do documento, depois de seguir os redirecionamentos da página (se houver).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Métricas dos usuários finais experiência de carregamento da página.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Métricas da experiência agregada de carregamento de página da origem
analysisUTCTimestamp

string

O carimbo de data/hora em UTC da análise.
lighthouseResult

object (LighthouseResultV5)

Resposta do Lighthouse para o URL de auditoria como um objeto.
version

object (PagespeedVersion)

A versão do PageSpeed usada para gerar esses 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 UNDEFINED padrão.
ACCESSIBILITY Acessibilidade (a11y), categoria relacionada à capacidade de um site de 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 Performance, categoria relacionada ao desempenho de um site.
SEO Otimização de mecanismos de pesquisa (SEO), categoria relacionada à capacidade de um site ser indexado por 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 de navegadores para computador.
MOBILE Busque e analise o URL para dispositivos móveis.

PagespeedApiLoadingExperienceV5

O objeto da experiência de carregamento CrUX que contém detalhamentos dos dados do CrUX.

Representação JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Campos
id

string

O URL, o padrão ou a origem em que as métricas estão.
metrics

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

O mapa de <metrics, data>.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
overall_category

string

A "categoria" de velocidade legível por humanos do ID.
initial_url

string

O URL solicitado, que pode ser diferente do "id" resolvido.
origin_fallback

boolean

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 (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

O horário em que essa execução foi buscada.
requestedUrl

string

O URL original solicitado.
finalUrl

string

O URL final resolvido que foi auditado.
lighthouseVersion

string

A versão do farol que foi usada para gerar esse LHR.
i18n

object (I18n)

As strings de internacionalização necessárias para renderizar o LHR.
userAgent

string

O user agent usado para executar este LHR.
audits

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

Mapa de auditorias no LHR.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
categoryGroups

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

Mapa dos grupos de categorias no LHR.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
stackPacks[]

object (StackPack)

As strings de aconselhamento do Stack Pack.
environment

object (Environment)

Configurações de ambiente usadas para criar esse LHR.
runWarnings

array (ListValue format)

Lista de todos os avisos de execução no LHR. A saída sempre será pelo menos [].
runtimeError

object (RuntimeError)

Uma mensagem de erro de nível superior que, se presente, indica um problema sério o suficiente para que este resultado do Lighthouse precise ser descartado.
categories

object (Categories)

Mapa de categorias no LHR.
timing

object (Timing)

Informações de tempo para este LHR.
configSettings

object (ConfigSettings)

As definições de configuração para este LHR.

Localização

Mensagem contendo os dados de i18n para o LHR - Versão 1.

Representação JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Campos
rendererFormattedStrings

object (RendererFormattedStrings)

Strings internacionalizadas que são formatadas de acordo com a localidade em configSettings.

RendererFormattedStrings

Mensagem com 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

string

A exoneração de responsabilidade exibida abaixo de um valor de métrica de performance.
opportunityResourceColumnLabel

string

O título da oportunidade de economia estimada de carregamento de página de uma auditoria.
opportunitySavingsColumnLabel

string

O título da economia estimada de carregamento de página de auditorias de oportunidade.
errorMissingAuditInfo

string

A string de erro mostrada ao lado de uma auditoria com erro.
errorLabel

string

O marcador mostrado ao lado de uma auditoria ou métrica que apresentou um erro.
warningHeader

string

O rótulo mostrado acima de uma lista com marcadores de avisos.
auditGroupExpandTooltip

string

O texto da dica em um ícone de divisa expansível.
passedAuditsGroupTitle

string

O título mostrado acima de uma lista de auditorias aprovadas.
notApplicableAuditsGroupTitle

string

O título mostrado acima é uma lista de auditorias que não se aplicam a uma página.
manualAuditsGroupTitle

string

O cabeçalho mostrado acima de uma lista de auditorias que não foram computadas na execução.
toplevelWarningsMessage

string

O rótulo exibido antes de avisos importantes que podem ter invalidado um relatório inteiro.
scorescaleLabel

string

O rótulo que explica a pontuação mede a escala (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

O rótulo dos valores mostrados no resumo das cadeias de solicitação críticas.
crcInitialNavigation

string

O rótulo da solicitação inicial em uma cadeia de solicitações crítica.
lsPerformanceCategoryDescription

string

A exoneração de responsabilidade mostrada abaixo do desempenho, explicando que a rede pode variar.
labDataTitle

string

O título da categoria de desempenho dos dados do laboratório.

StackPack

Mensagem com informações do pacote da pilha.

Representação JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Campos
id

string

O ID do pacote de pilha.
title

string

O título do pacote da pilha.
iconDataURL

string

O URI de dados do ícone do pacote de pilha.
descriptions

map (key: string, value: string)

As strings de aconselhamento do pacote de pilha.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Ambiente

Mensagem contendo a configuração de ambiente para uma execução do Lighthouse.

Representação JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Campos
networkUserAgent

string

A string do user agent que foi enviada pela rede.
hostUserAgent

string

A string do user agent da versão do Chrome usada.
benchmarkIndex

number

O número do índice de comparação que indica uma classe de dispositivo aproximada.

RuntimeError

Mensagem contendo uma configuração de erro de ambiente de execução.

Representação JSON 
{
  "code": string,
  "message": string
}
Campos
code

string

O código de erro enumerado do Lighthouse.
message

string

Uma mensagem legível explicando o código do erro.

Categorias

As categorias em uma execução do Lighthouse.

Representação JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Campos
accessibility

object (LighthouseCategoryV5)

A categoria de acessibilidade, contendo todas as auditorias relacionadas à acessibilidade.
best-practices

object (LighthouseCategoryV5)

A categoria de práticas recomendadas, contendo todas as auditorias relacionadas a práticas recomendadas.
seo

object (LighthouseCategoryV5)

A categoria de otimização do mecanismo de pesquisa (SEO), que contém todas as auditorias relacionadas a SEO.
performance

object (LighthouseCategoryV5)

A categoria de desempenho, que contém todas as auditorias relacionadas ao desempenho.

LighthouseCategoryV5

Uma categoria do Lighthouse.

Representação JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Campos
id

string

O identificador de string da categoria.
title

string

O nome legível da categoria.
description

string

Uma descrição mais detalhada da categoria e sua importância.
manualDescription

string

Uma descrição das auditorias manuais na categoria.
auditRefs[]

object (AuditRefs)

Uma matriz de referências a todos os membros da auditoria dessa categoria.
score

value (Value format)

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 leve a uma auditoria por ID, usada para agrupar e ponderar auditorias em uma determinada categoria.

Representação JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
Campos
id

string

O ID de referência de auditoria.
weight

number

O peso da pontuação da auditoria na pontuação geral da categoria.
group

string

O grupo de categoria ao qual a auditoria pertence (opcional).

Tempo

Mensagem contendo os dados de tempo de desempenho para a execução do Lighthouse.

Representação JSON 
{
  "total": number
}
Campos
total

number

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

value (Value format)

Lista de categorias de auditorias que a execução precisa realizar.
emulatedFormFactor
(deprecated)

string

O formato que a emulação precisa usar. O uso desse campo foi descontinuado. Use o formFactor.
locale

string

A configuração da localidade.
channel

string

Como o Lighthouse foi executado, por exemplo, com a extensão do Chrome ou o módulo npm.
formFactor

string

Como o Lighthouse interpreta essa execução em relação à pontuação das métricas de desempenho e ao pular testes exclusivos para dispositivos móveis no computador.

PagespeedVersion

O objeto Pagespeed Version.

Representação JSON 
{
  "major": string,
  "minor": string
}
Campos
major

string

O número da versão principal do PageSpeed usado para gerar esses resultados.
minor

string

O número da versão secundária do PageSpeed usado para gerar esses resultados.