Method: pagespeedapi.runpagespeed

Przeprowadza analizę PageSpeed na stronie o podanym adresie URL i zwraca wyniki PageSpeed, listę sugestii, jak przyspieszyć tę stronę, oraz inne informacje.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
category

enum (Category)

Kategoria Lighthouse. Jeśli nie podasz żadnej, wyświetlana będzie tylko kategoria Skuteczność
locale

string

Język używany do lokalizowania sformatowanych wyników
strategy

enum (Strategy)

Domyślna strategia analizy (komputery lub urządzenia mobilne) – komputer jest domyślną
url

string

To pole jest wymagane. adres URL do pobrania i analizy,
utm_campaign

string

Nazwa kampanii na potrzeby statystyk.
utm_source

string

Źródło kampanii do celów analitycznych.
captchaToken

string

Token captcha został przekazany podczas wypełniania captcha.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Obiekt odpowiedzi interfejsu Pagespeed API.

Zapis JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Pola
kind

string

Rodzaj wyniku.
captchaResult

string

Wynik weryfikacji captcha
id

string

Kanoniczny i końcowy URL dokumentu po przekierowaniach stron (jeśli istnieją).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Dane dotyczące wczytywania stron przez użytkowników.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Wskaźniki zagregowanego procesu wczytywania stron źródła
analysisUTCTimestamp

string

Sygnatura czasowa UTC tej analizy.
lighthouseResult

object (LighthouseResultV5)

Odpowiedź z Lighthouse dla adresu URL kontroli jako obiektu.
version

object (PagespeedVersion)

Wersja PageSpeed, która została użyta do wygenerowania tych wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • openid

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

Kategoria

Wymienione kategorie, które powinny być analizowane.

Wartości w polu enum
CATEGORY_UNSPECIFIED Domyślna kategoria NIEZDEFINIOWANA.
ACCESSIBILITY Dostępność (a11y), która określa, czy strona internetowa może być dostępna dla wszystkich użytkowników.
BEST_PRACTICES Sprawdzone metody, kategoria określająca zgodność witryny ze sprawdzonymi metodami dotyczącymi internetu.
PERFORMANCE Wydajność, kategoria odnosząca się do skuteczności witryny.
PWA Progresywna aplikacja internetowa (PWA) to kategoria, która określa, czy strona może działać jako PWA.
SEO Optymalizacja witryn pod kątem wyszukiwarek (SEO), czyli kategoria określająca możliwość indeksowania witryny przez wyszukiwarki.

Strategia

Strategia dotycząca urządzenia, która ma zostać użyta w analizie.

Wartości w polu enum
STRATEGY_UNSPECIFIED BRAK OKREŚLENIA.
DESKTOP Pobierz i przeanalizuj adres URL dla przeglądarek na komputerze.
MOBILE Pobierz i przeanalizuj adresy URL w przypadku urządzeń mobilnych.

PagespeedApiLoadingExperienceV5

Obiekt interfejsu wczytywania raportu CrUX, który zawiera zestawienia danych na ten temat.

Zapis JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Pola
id

string

URL, wzorzec lub źródło, dla których znajdują się dane.
metrics

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

Mapa: <metrics, data>.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
overall_category

string

„Kategoria” identyfikatora w postaci czytelnej dla człowieka.
initial_url

string

Żądany adres URL, który może się różnić od ustalonego parametru „id”.
origin_fallback

boolean

Wartość to „prawda”, jeśli wynik jest wartością zastępczą źródła ze strony. W przeciwnym razie ma wartość fałsz.

LighthouseResultV5

Obiekt wyniku wyszukiwania Lighthouse.

Zapis 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)
  }
}
Pola
fetchTime

string

Godzina pobrania tego uruchomienia.
requestedUrl

string

Pierwotnie żądany adres URL.
finalUrl

string

Ostateczny zakończony adres URL, który został sprawdzony.
lighthouseVersion

string

Wersja latarni morskiej, która została użyta do wygenerowania tego LHR.
i18n

object (I18n)

Ciągi znaków internacjonalizacji wymagane do renderowania LHR.
userAgent

string

Klient użytkownika, który został użyty do uruchomienia tego LHR.
audits

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

Mapa audytów w LHR.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
categoryGroups

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

Mapa grup kategorii w LHR.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
stackPacks[]

object (StackPack)

Ciągi ze wskazówkami dotyczącymi pakietu Stack.
environment

object (Environment)

Ustawienia środowiska użyte podczas tworzenia tego LHR.
runWarnings

array (ListValue format)

Lista wszystkich ostrzeżeń dotyczących uruchomienia w LHR. Dane wyjściowe zawsze będą miały wartość co najmniej [].
runtimeError

object (RuntimeError)

Komunikat o błędzie najwyższego poziomu. Jeśli występuje, oznacza na tyle poważny problem, że wynik z Lighthouse może wymagać odrzucenia.
categories

object (Categories)

Mapa kategorii w LHR.
timing

object (Timing)

Informacje o czasie trwania tego LHR.
configSettings

object (ConfigSettings)

Ustawienia konfiguracji tego LHR.

Internacjonalizacja

Wiadomość zawierająca dane i18n dla LHR – wersja 1.

Zapis JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Pola
rendererFormattedStrings

object (RendererFormattedStrings)

Umiędzynarodowione ciągi znaków sformatowane pod kątem języka w ustawieniach configSettings.

RendererFormattedStrings

Komunikat zawierający sformatowane ciągi znaków używane w mechanizmie renderowania.

Zapis 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
}
Pola
varianceDisclaimer

string

Wyłączenie odpowiedzialności wyświetlane pod wartością danych o skuteczności.
opportunityResourceColumnLabel

string

Nagłówek szacunkowej oszczędności czasu wczytywania strony związanej z kontrolą.
opportunitySavingsColumnLabel

string

Nagłówek dotyczący szacowanego oszczędności czasu wczytywania strony wynikającego z kontroli możliwości.
errorMissingAuditInfo

string

Ciąg znaków o błędzie wyświetlany obok błędu kontroli.
errorLabel

string

Etykieta wyświetlana obok kontroli lub wskaźnika, w przypadku których wystąpił błąd.
warningHeader

string

Etykieta wyświetlana nad listą punktowaną ostrzeżeń.
auditGroupExpandTooltip

string

Tekst etykietki na rozwijanej ikonie szewronu.
passedAuditsGroupTitle

string

Nagłówek widoczny nad listą niezaliczonych kontroli.
notApplicableAuditsGroupTitle

string

Nagłówek widoczny nad listą kontroli, które nie dotyczą żadnej strony.
manualAuditsGroupTitle

string

Nagłówek widoczny nad listą kontroli, które nie zostały skomputeryzowane w trakcie uruchomienia.
toplevelWarningsMessage

string

Etykieta widoczna przed ważnymi ostrzeżeniami, które mogły doprowadzić do unieważnienia całego raportu.
scorescaleLabel

string

Etykieta z wyjaśnieniem skali punktacji (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

Etykieta wartości wyświetlanych w podsumowaniu krytycznych łańcuchów żądań.
crcInitialNavigation

string

Etykieta początkowego żądania w łańcuchu żądań krytycznych.
lsPerformanceCategoryDescription

string

Wyłączenie odpowiedzialności widoczne w sekcji „Wydajność” z objaśnieniem różnych czynników w sieci.
labDataTitle

string

Tytuł kategorii wyników modułu.

StackPack

Wiadomość zawierająca informacje o pakiecie stosu.

Zapis JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Pola
id

string

Identyfikator pakietu stosu.
title

string

Tytuł pakietu stosu.
iconDataURL

string

Identyfikator URI danych ikony pakietu stosu.
descriptions

map (key: string, value: string)

Ciągi ze wskazówkami dotyczącymi pakietu stosu.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Środowisko

Wiadomość z konfiguracją środowiska do uruchomienia Lighthouse.

Zapis JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Pola
networkUserAgent

string

Ciąg znaków klienta użytkownika wysłany przez sieć.
hostUserAgent

string

Ciąg znaków klienta użytkownika używanej wersji Chrome.
benchmarkIndex

number

Numer indeksu porównawczego oznaczający ogólną klasę urządzenia.

RuntimeError

Komunikat zawierający konfigurację błędu środowiska wykonawczego.

Zapis JSON 
{
  "code": string,
  "message": string
}
Pola
code

string

Wybrany kod błędu Lighthouse.
message

string

Zrozumiały dla człowieka komunikat wyjaśniający kod błędu.

Kategorie

Kategorie w biegu Lighthouse.

Zapis JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Pola
accessibility

object (LighthouseCategoryV5)

Kategoria ułatwień dostępu zawierająca wszystkie kontrole ułatwień dostępu.
best-practices

object (LighthouseCategoryV5)

Kategoria sprawdzonych metod, która zawiera wszystkie audyty związane ze sprawdzonymi metodami.
seo

object (LighthouseCategoryV5)

Kategoria Search-Engine-Optimization (SEO) zawierająca wszystkie audyty związane z SEO.
pwa

object (LighthouseCategoryV5)

Kategoria Progresywnych aplikacji internetowych (PWA) zawierająca wszystkie audyty związane z PWA.
performance

object (LighthouseCategoryV5)

Kategoria skuteczności, która zawiera wszystkie audyty dotyczące skuteczności.

LighthouseCategoryV5

Kategoria Lighthouse.

Zapis JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Pola
id

string

Identyfikator kategorii w postaci ciągu znaków.
title

string

Czytelna dla ludzi nazwa kategorii.
description

string

Bardziej szczegółowy opis kategorii i jej znaczenia.
manualDescription

string

Opis ręcznych kontroli w danej kategorii.
auditRefs[]

object (AuditRefs)

Tablica odwołań do wszystkich członków kontroli w tej kategorii.
score

value (Value format)

Ogólny wynik kategorii, średnia ważona wszystkich jej audytów. (Wynik kategorii może mieć wartość null).

AuditRefs

Niewielkie odwołanie do kontroli według identyfikatora służące do grupowania i kontroli wagi w ramach danej kategorii.

Zapis JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
Pola
id

string

Identyfikator referencyjny kontroli.
weight

number

Wagę wyniku audytu dla ogólnego wyniku kategorii.
group

string

grupa kategorii, do której należy kontrola (opcjonalnie).

Czas

Komunikat zawierający dane o czasie wydajności uruchomienia Lighthouse.

Zapis JSON 
{
  "total": number
}
Pola
total

number

Całkowity czas działania Lighthouse.

ConfigSettings

Komunikat z ustawieniami konfiguracji uruchomienia Lighthouse.

Zapis JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Pola
onlyCategories

value (Value format)

Lista kategorii kontroli, które należy przeprowadzić.
emulatedFormFactor
(deprecated)

string

Format, którego powinna używać emulacja. To pole zostało wycofane. Zamiast niego należy używać parametru formFactor.
locale

string

Ustawienie regionalne.
channel

string

Sposób uruchomienia narzędzia Lighthouse, np. z poziomu rozszerzenia do Chrome lub modułu npm.
formFactor

string

Jak Lighthouse powinna interpretować to uruchomienie pod kątem oceny danych o wydajności i pomijania testów tylko na urządzeniach mobilnych na komputerach.

PagespeedVersion

Obiekt wersji Pagespeed.

Zapis JSON 
{
  "major": string,
  "minor": string
}
Pola
major

string

Numer wersji głównej PageSpeed użytej do wygenerowania tych wyników.
minor

string

Numer wersji podrzędnej PageSpeed użytej do wygenerowania tych wyników.