Method: pagespeedapi.runpagespeed

Uruchamia analizę PageSpeed na stronie pod określonym adresem URL i zwraca wyniki PageSpeed, listę sugestii dotyczących przyspieszenia działania strony i 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, która ma zostać uruchomiona; jeśli nie podasz żadnej wartości, wyświetlana będzie tylko kategoria skuteczności
locale

string

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

enum (Strategy)

stosowaną strategię analizy (komputery lub urządzenia mobilne), która jest domyślna; komputery.
url

string

Wymagane. Adres URL do pobrania i przeanalizowania
utm_campaign

string

Nazwa kampanii na potrzeby analityki.
utm_source

string

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

string

Token captcha przekazany podczas wypełniania.

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

W pewnym stopniu.
captchaResult

string

Wynik weryfikacji captcha
id

string

Kanoniczny i końcowy adres URL dokumentu, po następujących przekierowaniach stron (jeśli występują).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Dane użytkowników podczas wczytywania strony.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Wskaźniki zagregowanego wczytywania stron w źródle
analysisUTCTimestamp

string

Sygnatura czasowa UTC tej analizy.
lighthouseResult

object (LighthouseResultV5)

Odpowiedź Lighthouse z adresu URL kontroli jako obiektu.
version

object (PagespeedVersion)

Wersja PageSpeed , której użyto 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

Kategorie wymienione do analizy.

Wartości w polu enum
CATEGORY_UNSPECIFIED Domyślna kategoria NIEDEFINED.
ACCESSIBILITY Ułatwienia dostępu (a11y) – kategoria określająca, na ile strona może być dostępna dla wszystkich użytkowników.
BEST_PRACTICES Sprawdzone metody, kategoria odnosząca się do zgodności witryny ze sprawdzonymi metodami dotyczącymi witryn.
PERFORMANCE Skuteczność, kategoria powiązana ze skutecznością witryny.
SEO Optymalizacja witryn pod kątem wyszukiwarek (SEO) – kategoria odnosząca się do możliwości indeksowania witryny przez wyszukiwarki.

Strategia

Strategia działającego urządzenia do zastosowania w analizie.

Wartości w polu enum
STRATEGY_UNSPECIFIED NIEOKREŚLONY.
DESKTOP Pobierz i przeanalizuj adres URL przeglądarki na komputerze.
MOBILE Pobierz i przeanalizuj adres URL na urządzenia mobilne.

PagespeedApiLoadingExperienceV5

Obiekt środowiska 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, w których znajdują się wskaźniki.
metrics

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

Mapa: <dane, dane>.

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

string

Zrozumiała dla człowieka „kategoria” prędkości identyfikatora.
initial_url

string

Żądany adres URL, który może się różnić od właściwego identyfikatora.
origin_fallback

boolean

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

LighthouseResultV5

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

Oryginalny żądany adres URL.
finalUrl

string

Ostatni otrzymany 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 tekstowe 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 komisji wyborczej (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 porady dotyczące pakietu Stack Pack.
environment

object (Environment)

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

array (ListValue format)

Lista wszystkich ostrzeżeń dotyczących uruchomienia w LHR. Będzie zawsze dostarczany co najmniej do [].
runtimeError

object (RuntimeError)

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

object (Categories)

Mapa kategorii w LHR.
timing

object (Timing)

Informacje o czasie dla tego pomiaru LHR.
configSettings

object (ConfigSettings)

Ustawienia konfiguracji dla LHR.

Internacjonalizacja

Komunikat zawierający dane i18n dla LHR – wersja 1.

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

object (RendererFormattedStrings)

Umiędzynarodowione ciągi tekstowe sformatowane na potrzeby ustawień regionalnych w konfiguracji configSettings.

RendererFormattedStrings

Wiadomość zawierająca 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ą danych o skuteczności.
opportunityResourceColumnLabel

string

Nagłówek możliwości szacowanych oszczędności wczytywania strony w ramach audytu.
opportunitySavingsColumnLabel

string

Nagłówek szacowanych oszczędności czasu wczytywania strony wynikających z kontroli możliwości.
errorMissingAuditInfo

string

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

string

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

string

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

string

Tekst etykietki na ikonie rozwijania szewronu.
passedAuditsGroupTitle

string

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

string

Nagłówek widoczny nad listą kontroli, które nie mają zastosowania do strony.
manualAuditsGroupTitle

string

Nagłówek widoczny nad listą kontroli, które nie zostały ujęte w komputerach podczas uruchomienia.
toplevelWarningsMessage

string

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

string

Etykieta objaśniająca skalę wyników (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 krytycznym łańcuchu żądań.
lsPerformanceCategoryDescription

string

Pod informacją o skuteczności pojawi się wyłączenie odpowiedzialności z wyjaśnieniem, że sieć może się różnić.
labDataTitle

string

Tytuł kategorii wydajności danych 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ąg znaków z poradami.

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

Środowisko

Komunikat zawierający konfigurację środowiska na potrzeby uruchomienia Lighthouse.

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

string

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

string

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

number

Porównawczy indeks wskazujący przybliżoną klasę urządzenia.

RuntimeError

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

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

string

Wyliczony kod błędu Lighthouse.
message

string

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

Kategorie

Kategorie w biegu 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 zawierająca wszystkie kontrole związane z ułatwieniami dostępu.
best-practices

object (LighthouseCategoryV5)

Kategoria sprawdzonych metod zawierająca wszystkie audyty związane ze sprawdzonymi metodami.
seo

object (LighthouseCategoryV5)

Kategoria „Optymalizacja pod kątem wyszukiwarek” (SEO) obejmująca wszystkie audyty związane z SEO.
performance

object (LighthouseCategoryV5)

Kategoria wydajności zawierająca wszystkie audyty związane ze 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

Przyjazna dla człowieka nazwa kategorii.
description

string

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

string

Opis ręcznych audytów w danej kategorii.
auditRefs[]

object (AuditRefs)

Tablica odniesień do wszystkich elementów kontroli w tej kategorii.
score

value (Value format)

Ogólny wynik kategorii, średnia ważona ze wszystkich kontroli. (wynik kategorii może mieć wartość null).

AuditRefs

Krótkie odniesienie do audytu według identyfikatora, służącego do grupowania i ważenia audytów w ramach danej kategorii.

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

string

Identyfikator referencyjny kontroli.
weight

number

Waga wyniku tego audytu w odniesieniu do ogólnego wyniku kategorii.
group

string

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

Czas

Komunikat zawierający dane o czasie działania uruchomione w Lighthouse.

Zapis JSON 
{
  "total": number
}
Pola
total

number

Łączny czas działania Lighthouse.

ConfigSettings

Komunikat z ustawieniami konfiguracji do uruchomienia Lighthouse.

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

value (Value format)

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

string

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

string

Ustawienie regionalne.
channel

string

Jak uruchomiono Lighthouse, np. z rozszerzenia do Chrome lub z modułu npm.
formFactor

string

Jak Lighthouse powinien interpretować to uruchomienie pod kątem danych o skutecznoś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.