Method: pagespeedapi.runpagespeed

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

enum (Category)

Kategoria Lighthouse. Jeśli nie podasz żadnej, wyświetli się 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) i komputery są domyślną
url

string

Wymagane. Adres URL do pobrania i analizy
utm_campaign

string

Nazwa kampanii na potrzeby statystyk.
utm_source

string

Źródło kampanii na potrzeby statystyk.
captchaToken

string

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 (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 adres URL dokumentu po przekierowaniach stron (jeśli występują).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

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

object (PagespeedApiLoadingExperienceV5)

Wskaźniki dotyczące zagregowanego wczytywania stron w źródle
analysisUTCTimestamp

string

Sygnatura czasowa UTC tej analizy.
lighthouseResult

object (LighthouseResultV5)

Odpowiedź Lighthouse z adresem URL kontroli jako obiektem.
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 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 (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Pola
id

string

URL, wzorzec lub źródło, dla którego są uwzględnione 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

Czytelna dla człowieka „kategoria” szybkości identyfikatora.
initial_url

string

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

boolean

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

Pierwotny żą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 obiektu 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 tekstowe z poradami dotyczącymi pakietu Stack.
environment

object (Environment)

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

array (ListValue format)

Lista wszystkich ostrzeżeń dotyczących uruchomienia w LHR. Minimalna wartość to [].
runtimeError

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

object (Categories)

Mapa kategorii w LHR.
timing

object (Timing)

Informacje o czasie trwania tego LHR.
configSettings

object (ConfigSettings)

Ustawienia konfiguracji tego urządzenia 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 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

string

Wyłączenie odpowiedzialności widoczne pod wartością wskaźnika skuteczności.
opportunityResourceColumnLabel

string

Nagłówek szacunkowej oszczędności czasu wczytywania strony podczas kontroli.
opportunitySavingsColumnLabel

string

Nagłówek szacowanej oszczędności czasu wczytywania strony w ramach audytów możliwości.
errorMissingAuditInfo

string

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

string

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

string

Etykieta widoczna nad punktowaną listą 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ą strony.
manualAuditsGroupTitle

string

Nagłówek widoczny nad listą kontroli, które nie zostały przeprowadzone na komputerze.
toplevelWarningsMessage

string

Etykieta widoczna przed ważnymi ostrzeżeniami, które mogły unieważnić cały raport.
scorescaleLabel

string

Etykieta, która objaśnia kryteria oceny skali (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świetlane pod informacjami o skuteczności wyłączenie odpowiedzialności wyjaśniające, że sieć może się różnić.
labDataTitle

string

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

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 z poradami dotyczącymi pakietów stosu.

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

Środowisko

Wiadomość z konfiguracją środowiska uruchomioną w Lighthouse.

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

string

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

string

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

number

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

string

Wybrany kod błędu narzędzia Lighthouse.
message

string

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

Kategorie

Kategorie w biegu w Lighthouse.

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

object (LighthouseCategoryV5)

kategoria ułatwień dostępu obejmująca wszystkie kontrole związane z ułatwieniami 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 optymalizacją witryn pod kątem wyszukiwarek (SEO).
performance

object (LighthouseCategoryV5)

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 (AuditRefs)
    }
  ],
  "score": value
}
Pola
id

string

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

string

Przystępna dla człowieka nazwa kategorii.
description

string

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

string

Opis kontroli ręcznych 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 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

string

Identyfikator referencyjny kontroli.
weight

number

Znaczenie wyniku kontroli dla ogólnego wyniku kategorii.
group

string

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

number

Łą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

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

string

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

string

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