Przeprowadza analizę PageSpeed na stronie o określonym adresie URL, zwraca wyniki PageSpeed, listę sugestii, jak przyspieszyć 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świetli się tylko kategoria Skuteczność |
locale |
Język używany do lokalizowania sformatowanych wyników |
strategy |
Domyślna strategia analizy (komputery lub urządzenia mobilne) i komputery są domyślną |
url |
Wymagane. Adres URL do pobrania i analizy |
utm_campaign |
Nazwa kampanii na potrzeby statystyk. |
utm_source |
Źródło kampanii na potrzeby statystyk. |
captchaToken |
Token captcha przekazywany 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 adres URL dokumentu po przekierowaniach stron (jeśli występują). |
loadingExperience |
Dane dotyczące wczytywania stron przez użytkowników. |
originLoadingExperience |
Wskaźniki dotyczące zagregowanego wczytywania stron w źródle |
analysisUTCTimestamp |
Sygnatura czasowa UTC tej analizy. |
lighthouseResult |
Odpowiedź Lighthouse z adresem URL kontroli jako obiektem. |
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 omówieniu protokołu OAuth 2.0.
Kategoria
Wymienione kategorie, które powinny zostać przeanalizowane.
Wartości w polu enum | |
---|---|
CATEGORY_UNSPECIFIED |
Domyślna NIEZDEFINIOWANA kategoria. |
ACCESSIBILITY |
Ułatwienia dostępu (a11y), kategoria określająca pojemność witryny, z której mogą korzystać wszyscy użytkownicy. |
BEST_PRACTICES |
Sprawdzone metody: kategoria odnosząca się do zgodności witryny ze sprawdzonymi metodami dotyczącymi internetu. |
PERFORMANCE |
Skuteczność, kategoria odnosząca się do skuteczności witryny. |
SEO |
Optymalizacja witryn pod kątem wyszukiwarek (SEO) to kategoria odnosząca się do możliwości indeksowania witryny przez wyszukiwarki. |
Strategia
Strategia na uruchomionym urządzeniu, która zostanie użyta w analizie.
Wartości w polu enum | |
---|---|
STRATEGY_UNSPECIFIED |
NIEOKREŚLONA. |
DESKTOP |
Pobierz i przeanalizuj adres URL w wersji na komputery. |
MOBILE |
Pobierz i przeanalizuj URL dla urządzeń mobilnych. |
PagespeedApiLoadingExperienceV5
Obiekt interfejsu wczytywania CrUX, który zawiera zestawienia danych raportu CrUX.
Zapis JSON | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
Pola | |
---|---|
id |
URL, wzorzec lub źródło, dla którego są uwzględnione dane. |
metrics |
Mapa <metrics, data>. Obiekt zawierający listę par |
overall_category |
Czytelna dla człowieka „kategoria” szybkości identyfikatora. |
initial_url |
Żądany adres URL, który może się różnić od rozwiązanego parametru „id”. |
origin_fallback |
Prawda, jeśli wynik jest wartością zastępczą źródła ze strony. W przeciwnym razie ma wartość false (fałsz). |
LighthouseResultV5
Obiekt wyniku z Lighthouse.
Zapis JSON | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
Pola | |
---|---|
fetchTime |
Godzina pobrania tego uruchomienia. |
requestedUrl |
Pierwotny żą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 obiektu 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 tekstowe z poradami dotyczącymi pakietu Stack. |
environment |
Ustawienia środowiska użyte podczas tworzenia tego obiektu LHR. |
runWarnings |
Lista wszystkich ostrzeżeń dotyczących uruchomienia w LHR. Minimalna wartość to |
runtimeError |
Komunikat o błędzie najwyższego poziomu, który (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 urządzenia LHR. |
Internacjonalizacja
Wiadomość zawierająca dane i18n dla LHR – wersja 1.
Zapis JSON | |
---|---|
{
"rendererFormattedStrings": {
object ( |
Pola | |
---|---|
rendererFormattedStrings |
Umiędzynarodowione ciągi znaków sformatowane zgodnie z ustawieniami regionalnymi w 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 widoczne pod wartością wskaźnika skuteczności. |
opportunityResourceColumnLabel |
Nagłówek szacunkowej oszczędności czasu wczytywania strony podczas kontroli. |
opportunitySavingsColumnLabel |
Nagłówek szacowanej oszczędności czasu wczytywania strony w ramach audytów możliwości. |
errorMissingAuditInfo |
Ciąg znaków o błędzie wyświetlany obok kontroli z błędem. |
errorLabel |
Etykieta wyświetlana obok kontroli lub wskaźnika, w przypadku których wystąpił błąd. |
warningHeader |
Etykieta widoczna nad punktowaną listą 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ą strony. |
manualAuditsGroupTitle |
Nagłówek widoczny nad listą kontroli, które nie zostały przeprowadzone na komputerze. |
toplevelWarningsMessage |
Etykieta widoczna przed ważnymi ostrzeżeniami, które mogły unieważnić cały raport. |
scorescaleLabel |
Etykieta, która objaśnia kryteria oceny skali (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świetlane pod informacjami o skuteczności wyłączenie odpowiedzialności wyjaśniające, że sieć może się różnić. |
labDataTitle |
Tytuł kategorii wyników modułu. |
StackPack
Wiadomość zawierająca informacje o pakiecie Stack Pack.
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 z poradami dotyczącymi pakietów stosu. Obiekt zawierający listę par |
Środowisko
Wiadomość z konfiguracją środowiska uruchomioną w Lighthouse.
Zapis JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
Pola | |
---|---|
networkUserAgent |
Ciąg znaków klienta użytkownika przesłany przez sieć. |
hostUserAgent |
Ciąg znaków klienta użytkownika używanej wersji Chrome. |
benchmarkIndex |
Liczba indeksu porównawcza, która wskazuje przybliżoną klasę urządzenia. |
RuntimeError
Komunikat zawierający konfigurację błędu środowiska wykonawczego.
Zapis JSON | |
---|---|
{ "code": string, "message": string } |
Pola | |
---|---|
code |
Wybrany kod błędu narzędzia Lighthouse. |
message |
Zrozumiały dla człowieka komunikat objaśniający kod błędu. |
Kategorie
Kategorie w biegu w Lighthouse.
Zapis JSON | |
---|---|
{ "accessibility": { object ( |
Pola | |
---|---|
accessibility |
kategoria ułatwień dostępu obejmująca wszystkie kontrole związane z ułatwieniami 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 optymalizacją witryn pod kątem wyszukiwarek (SEO). |
performance |
Kategoria skuteczności obejmująca wszystkie audyty związane z wydajnością. |
LighthouseCategoryV5
Kategoria Latarnia morska.
Zapis JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
Pola | |
---|---|
id |
Identyfikator kategorii w postaci ciągu znaków. |
title |
Przystępna dla człowieka nazwa kategorii. |
description |
Bardziej szczegółowy opis kategorii i jej znaczenia. |
manualDescription |
Opis kontroli ręcznych 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 audytów. (Wynik kategorii może mieć wartość null). |
AuditRefs
Niewielkie odniesienia do kontroli według identyfikatora służącej do grupowania i sprawdzania wagi w ramach danej kategorii.
Zapis JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
Pola | |
---|---|
id |
Identyfikator referencyjny kontroli. |
weight |
Znaczenie wyniku kontroli dla ogólnego wyniku kategorii. |
group |
Grupa kategorii, do której należy kontrola (opcjonalnie). |
Czas
Wiadomość zawierająca dane o czasie działania narzędzia Lighthouse.
Zapis JSON | |
---|---|
{ "total": number } |
Pola | |
---|---|
total |
Łączny czas działania narzędzia 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 ma interpretować to uruchomienie pod kątem wyników i pomijania testów dotyczących tylko urządzeń mobilnych na komputerach. |
PagespeedVersion
Obiekt Pagespeed Version.
Zapis JSON | |
---|---|
{ "major": string, "minor": string } |
Pola | |
---|---|
major |
Numer głównej wersji PageSpeed użytej do wygenerowania tych wyników. |
minor |
Numer wersji podrzędnej PageSpeed użytej do wygenerowania tych wyników. |