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 |
Kategoria Lighthouse. Jeśli nie podasz żadnej, wyświetlana będzie tylko kategoria Skuteczność |
locale |
Język używany do lokalizowania sformatowanych wyników |
strategy |
Domyślna strategia analizy (komputery lub urządzenia mobilne) – komputer jest domyślną |
url |
To pole jest wymagane. adres URL do pobrania i analizy, |
utm_campaign |
Nazwa kampanii na potrzeby statystyk. |
utm_source |
Źródło kampanii do celów analitycznych. |
captchaToken |
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 ( |
Pola | |
---|---|
kind |
Rodzaj wyniku. |
captchaResult |
Wynik weryfikacji captcha |
id |
Kanoniczny i końcowy URL dokumentu po przekierowaniach stron (jeśli istnieją). |
loadingExperience |
Dane dotyczące wczytywania stron przez użytkowników. |
originLoadingExperience |
Wskaźniki zagregowanego procesu wczytywania stron źródła |
analysisUTCTimestamp |
Sygnatura czasowa UTC tej analizy. |
lighthouseResult |
Odpowiedź z Lighthouse dla adresu URL kontroli jako obiektu. |
version |
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 ( |
Pola | |
---|---|
id |
URL, wzorzec lub źródło, dla których znajdują się dane. |
metrics |
Mapa: <metrics, data>. Obiekt zawierający listę par |
overall_category |
„Kategoria” identyfikatora w postaci czytelnej dla człowieka. |
initial_url |
Żądany adres URL, który może się różnić od ustalonego parametru „id”. |
origin_fallback |
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 ( |
Pola | |
---|---|
fetchTime |
Godzina pobrania tego uruchomienia. |
requestedUrl |
Pierwotnie żądany adres URL. |
finalUrl |
Ostateczny zakończony adres URL, który został sprawdzony. |
lighthouseVersion |
Wersja latarni morskiej, która została użyta do wygenerowania tego LHR. |
i18n |
Ciągi znaków internacjonalizacji wymagane do renderowania LHR. |
userAgent |
Klient użytkownika, który został użyty do uruchomienia tego LHR. |
audits |
Mapa audytów w LHR. Obiekt zawierający listę par |
categoryGroups |
Mapa grup kategorii w LHR. Obiekt zawierający listę par |
stackPacks[] |
Ciągi ze wskazówkami dotyczącymi pakietu Stack. |
environment |
Ustawienia środowiska użyte podczas tworzenia tego LHR. |
runWarnings |
Lista wszystkich ostrzeżeń dotyczących uruchomienia w LHR. Dane wyjściowe zawsze będą miały wartość co najmniej |
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 |
Mapa kategorii w LHR. |
timing |
Informacje o czasie trwania tego LHR. |
configSettings |
Ustawienia konfiguracji tego LHR. |
Internacjonalizacja
Wiadomość zawierająca dane i18n dla LHR – wersja 1.
Zapis JSON | |
---|---|
{
"rendererFormattedStrings": {
object ( |
Pola | |
---|---|
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 |
Wyłączenie odpowiedzialności wyświetlane pod wartością danych o skuteczności. |
opportunityResourceColumnLabel |
Nagłówek szacunkowej oszczędności czasu wczytywania strony związanej z kontrolą. |
opportunitySavingsColumnLabel |
Nagłówek dotyczący szacowanego oszczędności czasu wczytywania strony wynikającego z kontroli możliwości. |
errorMissingAuditInfo |
Ciąg znaków o błędzie wyświetlany obok błędu kontroli. |
errorLabel |
Etykieta wyświetlana obok kontroli lub wskaźnika, w przypadku których wystąpił błąd. |
warningHeader |
Etykieta wyświetlana nad listą punktowaną ostrzeżeń. |
auditGroupExpandTooltip |
Tekst etykietki na rozwijanej ikonie szewronu. |
passedAuditsGroupTitle |
Nagłówek widoczny nad listą niezaliczonych kontroli. |
notApplicableAuditsGroupTitle |
Nagłówek widoczny nad listą kontroli, które nie dotyczą żadnej strony. |
manualAuditsGroupTitle |
Nagłówek widoczny nad listą kontroli, które nie zostały skomputeryzowane w trakcie uruchomienia. |
toplevelWarningsMessage |
Etykieta widoczna przed ważnymi ostrzeżeniami, które mogły doprowadzić do unieważnienia całego raportu. |
scorescaleLabel |
Etykieta z wyjaśnieniem skali punktacji (0-49, 50-89, 90-100). |
crcLongestDurationLabel |
Etykieta wartości wyświetlanych w podsumowaniu krytycznych łańcuchów żądań. |
crcInitialNavigation |
Etykieta początkowego żądania w łańcuchu żądań krytycznych. |
lsPerformanceCategoryDescription |
Wyłączenie odpowiedzialności widoczne w sekcji „Wydajność” z objaśnieniem różnych czynników w sieci. |
labDataTitle |
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 |
Identyfikator pakietu stosu. |
title |
Tytuł pakietu stosu. |
iconDataURL |
Identyfikator URI danych ikony pakietu stosu. |
descriptions |
Ciągi ze wskazówkami dotyczącymi pakietu stosu. Obiekt zawierający listę par |
Środowisko
Wiadomość z konfiguracją środowiska do uruchomienia Lighthouse.
Zapis JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
Pola | |
---|---|
networkUserAgent |
Ciąg znaków klienta użytkownika wysłany przez sieć. |
hostUserAgent |
Ciąg znaków klienta użytkownika używanej wersji Chrome. |
benchmarkIndex |
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 |
Wybrany kod błędu Lighthouse. |
message |
Zrozumiały dla człowieka komunikat wyjaśniający kod błędu. |
Kategorie
Kategorie w biegu Lighthouse.
Zapis JSON | |
---|---|
{ "accessibility": { object ( |
Pola | |
---|---|
accessibility |
Kategoria ułatwień dostępu zawierająca wszystkie kontrole ułatwień dostępu. |
best-practices |
Kategoria sprawdzonych metod, która zawiera wszystkie audyty związane ze sprawdzonymi metodami. |
seo |
Kategoria Search-Engine-Optimization (SEO) zawierająca wszystkie audyty związane z SEO. |
pwa |
Kategoria Progresywnych aplikacji internetowych (PWA) zawierająca wszystkie audyty związane z PWA. |
performance |
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 ( |
Pola | |
---|---|
id |
Identyfikator kategorii w postaci ciągu znaków. |
title |
Czytelna dla ludzi nazwa kategorii. |
description |
Bardziej szczegółowy opis kategorii i jej znaczenia. |
manualDescription |
Opis ręcznych kontroli w danej kategorii. |
auditRefs[] |
Tablica odwołań do wszystkich członków kontroli w tej kategorii. |
score |
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 |
Identyfikator referencyjny kontroli. |
weight |
Wagę wyniku audytu dla ogólnego wyniku kategorii. |
group |
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 |
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 |
Lista kategorii kontroli, które należy przeprowadzić. |
emulatedFormFactor |
Format, którego powinna używać emulacja. To pole zostało wycofane. Zamiast niego należy używać parametru formFactor. |
locale |
Ustawienie regionalne. |
channel |
Sposób uruchomienia narzędzia Lighthouse, np. z poziomu rozszerzenia do Chrome lub modułu npm. |
formFactor |
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 |
Numer wersji głównej PageSpeed użytej do wygenerowania tych wyników. |
minor |
Numer wersji podrzędnej PageSpeed użytej do wygenerowania tych wyników. |