Pagespeedapi: runpagespeed

Menjalankan analisis PageSpeed pada halaman pada URL yang ditentukan, dan menampilkan skor PageSpeed, daftar saran untuk membuat halaman tersebut lebih cepat, serta informasi lainnya. Coba sekarang.

Permintaan

Permintaan HTTP

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

Parameter

Nama parameter Nilai Deskripsi
Parameter kueri yang diperlukan
url string URL untuk diambil dan dianalisis
Parameter kueri opsional
category string Kategori Lighthouse yang akan dijalankan; jika tidak ada yang ditentukan, hanya kategori Performa yang akan dijalankan

Nilai yang dapat diterima adalah:
  • "accessibility"
  • "best-practices"
  • "performance"
  • "pwa"
  • "seo"
locale string Lokalitas yang digunakan untuk melokalkan hasil berformat
strategy string Strategi analisis (desktop atau seluler) yang akan digunakan, dan desktop bersifat default

Nilai yang dapat diterima adalah:
  • "desktop": Mengambil dan menganalisis URL untuk browser desktop
  • "mobile": Mengambil dan menganalisis URL untuk perangkat seluler
utm_campaign string Nama kampanye untuk analisis.
utm_source string Sumber kampanye untuk analisis.

Isi permintaan

Jangan memberikan isi permintaan dengan metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "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
  }
}
Nama properti Nilai Deskripsi Catatan
captchaResult string Hasil verifikasi CAPTCHA

Nilai yang diterima adalah:
  • "CAPTCHA_BLOCKING"
  • "CAPTCHA_MATCHED"
  • "CAPTCHA_NEEDED"
  • "CAPTCHA_NOT_NEEDED"
  • "CAPTCHA_UNMATCHED"
kind string Jenis hasil.
id string URL final dan kanonis untuk dokumen, setelah mengikuti pengalihan halaman (jika ada).
loadingExperience nested object Metrik pengalaman pemuatan halaman pengguna akhir.
loadingExperience.id string URL, pola, atau origin tempat metrik berada.
loadingExperience.metrics object
loadingExperience.metrics.(key) object Jenis metrik.
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 Versi PageSpeed yang digunakan untuk menampilkan hasil ini.
version.major integer Nomor versi utama PageSpeed yang digunakan untuk menampilkan hasil ini.
version.minor integer Nomor versi minor PageSpeed yang digunakan untuk menghasilkan hasil ini.
loadingExperience.metrics.(key).category string

Nilai yang dapat diterima adalah:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.overall_category string

Nilai yang dapat diterima adalah:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.initial_url string
loadingExperience.metrics.(key).percentile integer
originLoadingExperience nested object Metrik pengalaman pemuatan halaman gabungan dari origin
originLoadingExperience.id string URL, pola, atau origin tempat metrik berada.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object Jenis metrik.
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

Nilai yang dapat diterima adalah:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.overall_category string

Nilai yang dapat diterima adalah:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.initial_url string
analysisUTCTimestamp string Stempel waktu UTC analisis ini.
lighthouseResult nested object Respons Lighthouse untuk URL audit sebagai objek.
lighthouseResult.requestedUrl string URL asli yang diminta.
lighthouseResult.finalUrl string URL final yang diselesaikan yang diaudit.
lighthouseResult.lighthouseVersion string Versi mercusuar yang digunakan untuk membuat LHR ini.
lighthouseResult.userAgent string Agen pengguna yang digunakan untuk menjalankan LHR ini.
lighthouseResult.fetchTime string Waktu operasi ini diambil.
lighthouseResult.environment object Setelan lingkungan yang digunakan saat membuat LHR ini.
lighthouseResult.environment.networkUserAgent string
lighthouseResult.environment.hostUserAgent string
lighthouseResult.environment.benchmarkIndex double
lighthouseResult.runWarnings[] list Daftar semua peringatan operasi di LHR. Akan selalu menghasilkan output minimal `[]`.
lighthouseResult.configSettings object Setelan konfigurasi untuk LHR ini.
lighthouseResult.configSettings.emulatedFormFactor string Faktor bentuk yang harus digunakan emulasi harus menggunakan

Nilai yang dapat diterima adalah:
  • "UNKNOWN_FORM_FACTOR"
  • "desktop"
  • "mobile"
  • "none"
lighthouseResult.configSettings.locale string Setelan lokalitas
lighthouseResult.configSettings.onlyCategories nested object
lighthouseResult.audits object Peta audit di LHR.
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string ID audit.
lighthouseResult.audits.(key).title string Judul yang dapat dibaca manusia.
lighthouseResult.audits.(key).description string Deskripsi audit.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string Mode tampilan skor yang dienumerasi.

Nilai yang dapat diterima adalah:
  • "SCORE_DISPLAY_MODE_UNSPECIFIED"
  • "binary"
  • "error"
  • "informative"
  • "manual"
  • "not_applicable"
  • "numeric"
lighthouseResult.audits.(key).displayValue string Nilai yang harus ditampilkan di UI untuk audit ini.
lighthouseResult.audits.(key).explanation string Penjelasan tentang error dalam audit.
lighthouseResult.audits.(key).errorMessage string Pesan error dari error yang ditampilkan di dalam audit.
lighthouseResult.audits.(key).warnings nested object
lighthouseResult.audits.(key).details object Bagian detail audit dengan format bebas.
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object Peta kategori di LHR.
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string ID string kategori.
lighthouseResult.categories.(key).title string Nama kategori yang mudah dibaca manusia
lighthouseResult.categories.(key).description string Deskripsi yang lebih detail tentang kategori dan kepentingannya.
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string Deskripsi untuk audit manual dalam kategori.
lighthouseResult.categories.(key).auditRefs[] list Array referensi ke semua anggota audit kategori ini.
lighthouseResult.categories.(key).auditRefs[].id string ID referensi audit.
lighthouseResult.categories.(key).auditRefs[].weight double Bobot skor audit ini pada skor kategori keseluruhan.
lighthouseResult.categories.(key).auditRefs[].group string Grup kategori tempat audit berada (opsional).
lighthouseResult.categoryGroups object Peta grup kategori di LHR.
lighthouseResult.categoryGroups.(key) object
lighthouseResult.categoryGroups.(key).title string
lighthouseResult.categoryGroups.(key).description string
lighthouseResult.runtimeError object Objek yang berisi kode + pesan error runtime yang ditampilkan.
lighthouseResult.runtimeError.code string

Nilai yang dapat diterima adalah:
  • "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 Informasi pengaturan waktu untuk LHR ini.
lighthouseResult.timing.total double Total durasi durasi Lighthouse
lighthouseResult.i18n object String internasionalisasi yang diperlukan untuk merender 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

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan melihat respons.