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. Wypróbuj

Żądanie

Żądanie HTTP

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

Parametry

Nazwa parametru Wartość Opis
Wymagane parametry zapytania
url string Adres URL do pobrania i przeanalizowania
Opcjonalne parametry zapytania
category string kategoria Lighthouse, która ma zostać uruchomiona; jeśli nie podasz żadnej wartości, wyświetlana będzie tylko kategoria skuteczności

Akceptowane wartości to:
  • „accessibility”
  • „best-practices”
  • „performance”
  • „pwa”
  • „seo”
locale string Język używany do lokalizowania sformatowanych wyników
strategy string stosowaną strategię analizy (komputery lub urządzenia mobilne), która jest domyślna; komputery.

Akceptowane wartości to:
  • „desktop”: pobierz i przeanalizuj adres URL przeglądarki na komputerze
  • „mobile”: pobierz i przeanalizuj adres URL na urządzenia mobilne
utm_campaign string Nazwa kampanii na potrzeby analityki.
utm_source string Źródło kampanii na potrzeby analiz.

Treść żądania

Nie podawaj treści żądania przy użyciu tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "originLoadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "lighthouseResult": {
    "requestedUrl": string,
    "finalUrl": string,
    "lighthouseVersion": string,
    "userAgent": string,
    "fetchTime": string,
    "environment": {
      "networkUserAgent": string,
      "hostUserAgent": string,
      "benchmarkIndex": double
    },
    "runWarnings": [
      (value)
    ],
    "configSettings": {
      "emulatedFormFactor": string,
      "locale": string,
      "onlyCategories": (value),
      "onlyCategories": (value)
    },
    "audits": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "scoreDisplayMode": string,
        "displayValue": string,
        "explanation": string,
        "errorMessage": string,
        "warnings": (value),
        "warnings": (value),
        "details": {
          (key): (value)
        }
      }
    },
    "categories": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "manualDescription": string,
        "auditRefs": [
          {
            "id": string,
            "weight": double,
            "group": string
          }
        ]
      }
    },
    "categoryGroups": {
      (key): {
        "title": string,
        "description": string
      }
    },
    "runtimeError": {
      "code": string,
      "message": string
    },
    "timing": {
      "total": double
    },
    "i18n": {
      "rendererFormattedStrings": {
        "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
      }
    }
  },
  "analysisUTCTimestamp": string,
  "version": {
    "major": integer,
    "minor": integer
  }
}
Nazwa usługi Wartość Opis Uwagi
captchaResult string Wynik weryfikacji captcha

Akceptowane wartości to:
  • „CAPTCHA_BLOCKING”
  • „CAPTCHA_MATCHED”
  • „CAPTCHA_NEEDED”
  • „CAPTCHA_NOT_NEEDED”
  • „CAPTCHA_UNMATCHED”
kind string W pewnym stopniu.
id string Kanoniczny i końcowy adres URL dokumentu, po następujących przekierowaniach stron (jeśli występują).
loadingExperience nested object Dane użytkowników podczas wczytywania strony.
loadingExperience.id string URL, wzorzec lub źródło, w których znajdują się wskaźniki.
loadingExperience.metrics object
loadingExperience.metrics.(key) object Typ danych.
loadingExperience.metrics.(key).distributions[] list
loadingExperience.metrics.(key).distributions[].min integer
loadingExperience.metrics.(key).distributions[].max integer
loadingExperience.metrics.(key).distributions[].proportion double
version object Wersja PageSpeed , której użyto do wygenerowania tych wyników.
version.major integer Numer wersji głównej PageSpeed użytej do wygenerowania tych wyników.
version.minor integer Numer wersji podrzędnej PageSpeed użytej do wygenerowania tych wyników.
loadingExperience.metrics.(key).category string

Akceptowane wartości to:
  • „AVERAGE”
  • „FAST”
  • „NONE”
  • „SLOW”
loadingExperience.overall_category string

Akceptowane wartości to:
  • „AVERAGE”
  • „FAST”
  • „NONE”
  • „SLOW”
loadingExperience.initial_url string
loadingExperience.metrics.(key).percentile integer
originLoadingExperience nested object Wskaźniki zagregowanego wczytywania stron w źródle
originLoadingExperience.id string URL, wzorzec lub źródło, w których znajdują się wskaźniki.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object Typ danych.
originLoadingExperience.metrics.(key).percentile integer
originLoadingExperience.metrics.(key).distributions[] list
originLoadingExperience.metrics.(key).distributions[].min integer
originLoadingExperience.metrics.(key).distributions[].max integer
originLoadingExperience.metrics.(key).distributions[].proportion double
originLoadingExperience.metrics.(key).category string

Akceptowane wartości to:
  • „AVERAGE”
  • „FAST”
  • „NONE”
  • „SLOW”
originLoadingExperience.overall_category string

Akceptowane wartości to:
  • „AVERAGE”
  • „FAST”
  • „NONE”
  • „SLOW”
originLoadingExperience.initial_url string
analysisUTCTimestamp string Sygnatura czasowa UTC tej analizy.
lighthouseResult nested object Odpowiedź Lighthouse z adresu URL kontroli jako obiektu.
lighthouseResult.requestedUrl string Oryginalny żądany adres URL.
lighthouseResult.finalUrl string Ostatni otrzymany adres URL, który został sprawdzony.
lighthouseResult.lighthouseVersion string Wersja latarni morskiej, która została użyta do wygenerowania tego LHR.
lighthouseResult.userAgent string Klient użytkownika, który został użyty do uruchomienia tego LHR.
lighthouseResult.fetchTime string Godzina pobrania tego uruchomienia.
lighthouseResult.environment object Ustawienia środowiska użyte podczas tworzenia tego pomiaru LHR.
lighthouseResult.environment.networkUserAgent string
lighthouseResult.environment.hostUserAgent string
lighthouseResult.environment.benchmarkIndex double
lighthouseResult.runWarnings[] list Lista wszystkich ostrzeżeń dotyczących uruchomienia w LHR. Będzie zawsze dostarczany co najmniej do argumentu „[]”.
lighthouseResult.configSettings object Ustawienia konfiguracji dla LHR.
lighthouseResult.configSettings.emulatedFormFactor string Format, z którego ma korzystać emulacja

Akceptowane wartości to:
  • „UNKNOWN_FORM_FACTOR”
  • „desktop”
  • „mobile”
  • „none”
lighthouseResult.configSettings.locale string Ustawienie regionalne
lighthouseResult.configSettings.onlyCategories nested object
lighthouseResult.audits object Mapa audytów komisji wyborczej (LHR).
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string Identyfikator audytu.
lighthouseResult.audits.(key).title string Tytuł zrozumiały dla człowieka.
lighthouseResult.audits.(key).description string Opis kontroli.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string Tryb wyświetlania wyliczanego wyniku.

Akceptowane wartości to:
  • „SCORE_DISPLAY_MODE_UNSPECIFIED”
  • „binary”
  • „error”
  • „informative”
  • „manual”
  • „not_applicable”
  • „numeric”
lighthouseResult.audits.(key).displayValue string Wartość, która powinna być wyświetlana w interfejsie tego kontroli.
lighthouseResult.audits.(key).explanation string wyjaśnienie błędów w kontroli.
lighthouseResult.audits.(key).errorMessage string Komunikat o błędzie wygenerowanym w trakcie kontroli.
lighthouseResult.audits.(key).warnings nested object
lighthouseResult.audits.(key).details object Swobodna sekcja szczegółów audytu.
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object Mapa kategorii w LHR.
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string Identyfikator kategorii w postaci ciągu znaków.
lighthouseResult.categories.(key).title string Przyjazna dla człowieka nazwa kategorii.
lighthouseResult.categories.(key).description string Bardziej szczegółowy opis kategorii i jej znaczenia.
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string Opis ręcznych audytów w danej kategorii.
lighthouseResult.categories.(key).auditRefs[] list Tablica odniesień do wszystkich elementów kontroli w tej kategorii.
lighthouseResult.categories.(key).auditRefs[].id string Identyfikator referencyjny kontroli.
lighthouseResult.categories.(key).auditRefs[].weight double Waga wyniku tego audytu w odniesieniu do ogólnego wyniku kategorii.
lighthouseResult.categories.(key).auditRefs[].group string Grupa kategorii, do której należy kontrola (opcjonalnie).
lighthouseResult.categoryGroups object Mapa grup kategorii w LHR.
lighthouseResult.categoryGroups.(key) object
lighthouseResult.categoryGroups.(key).title string
lighthouseResult.categoryGroups.(key).description string
lighthouseResult.runtimeError object Obiekt zawierający kod i komunikat o wszelkich zgłoszonych błędach czasu działania.
lighthouseResult.runtimeError.code string

Akceptowane wartości to:
  • „ERRORED_DOCUMENT_REQUEST”
  • „FAILED_DOCUMENT_REQUEST”
  • „INSECURE_DOCUMENT_REQUEST”
  • „INVALID_SPEEDLINE”
  • „NO_DCL”
  • „NO_DOCUMENT_REQUEST”
  • „NO_ERROR”
  • „NO_FCP”
  • „NO_NAVSTART”
  • „NO_SCREENSHOTS”
  • „NO_SPEEDLINE_FRAMES”
  • „NO_TRACING_STARTED”
  • „PARSING_PROBLEM”
  • „PROTOCOL_TIMEOUT”
  • „READ_FAILED”
  • „SPEEDINDEX_OF_ZERO”
  • „TRACING_ALREADY_STARTED”
  • „UNKNOWN_ERROR”
lighthouseResult.runtimeError.message string
lighthouseResult.timing object Informacje o czasie dla tego pomiaru LHR.
lighthouseResult.timing.total double Łączny czas działania Lighthouse
lighthouseResult.i18n object Ciągi tekstowe internacjonalizacji wymagane do renderowania LHR.
lighthouseResult.i18n.rendererFormattedStrings object
lighthouseResult.i18n.rendererFormattedStrings.varianceDisclaimer string
lighthouseResult.i18n.rendererFormattedStrings.opportunityResourceColumnLabel string
lighthouseResult.i18n.rendererFormattedStrings.opportunitySavingsColumnLabel string
lighthouseResult.i18n.rendererFormattedStrings.errorMissingAuditInfo string
lighthouseResult.i18n.rendererFormattedStrings.errorLabel string
lighthouseResult.i18n.rendererFormattedStrings.warningHeader string
lighthouseResult.i18n.rendererFormattedStrings.auditGroupExpandTooltip string
lighthouseResult.i18n.rendererFormattedStrings.passedAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.notApplicableAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.manualAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.toplevelWarningsMessage string
lighthouseResult.i18n.rendererFormattedStrings.scorescaleLabel string
lighthouseResult.i18n.rendererFormattedStrings.crcLongestDurationLabel string
lighthouseResult.i18n.rendererFormattedStrings.crcInitialNavigation string
lighthouseResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription string
lighthouseResult.i18n.rendererFormattedStrings.labDataTitle string

Wypróbuj

Użyj poniższego eksploratora interfejsów API, aby wywołać tę metodę na bieżących danych i wyświetlić odpowiedź.