Method: 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.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
category

enum (Category)

Kategori Lighthouse yang akan dijalankan; jika tidak ada yang diberikan, hanya kategori Performa yang akan dijalankan
locale

string

Lokalitas yang digunakan untuk melokalkan hasil berformat
strategy

enum (Strategy)

Strategi analisis (desktop atau seluler) yang akan digunakan, dan desktop adalah opsi default
url

string

Wajib. URL untuk diambil dan dianalisis
utm_campaign

string

Nama kampanye untuk analisis.
utm_source

string

Sumber kampanye untuk analisis.
captchaToken

string

Token kapitalisasi terlewati saat mengisi reCAPTCHA.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Objek respons Pagespeed API.

Representasi JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Kolom
kind

string

Jenis hasil.
captchaResult

string

Hasil verifikasi Captcha
id

string

URL final dan kanonis untuk dokumen, setelah mengikuti pengalihan halaman (jika ada).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Metrik pengalaman pemuatan halaman pengguna akhir.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Metrik pengalaman pemuatan halaman gabungan dari origin
analysisUTCTimestamp

string

Stempel waktu UTC analisis ini.
lighthouseResult

object (LighthouseResultV5)

Respons Lighthouse untuk URL audit sebagai objek.
version

object (PagespeedVersion)

Versi PageSpeed yang digunakan untuk menampilkan hasil ini.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

  • openid

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Kategori

Kategori terenumerasi yang harus dianalisis.

Enum
CATEGORY_UNSPECIFIED Kategori default TIDAK DITENTUKAN.
ACCESSIBILITY Aksesibilitas (a11y), kategori yang berkaitan dengan kapasitas {i>website<i} untuk dapat diakses oleh semua pengguna.
BEST_PRACTICES Praktik Terbaik, kategori yang berkaitan dengan kesesuaian situs dengan praktik terbaik web.
PERFORMANCE Performa, kategori yang berkaitan dengan performa situs.
PWA Progressive Web App (PWA), kategori yang berkaitan dengan kemampuan situs untuk dijalankan sebagai PWA.
SEO Pengoptimalan Mesin Telusur (SEO), kategori yang berkaitan dengan kemampuan situs untuk diindeks oleh mesin telusur.

Strategi

Strategi menjalankan perangkat yang akan digunakan dalam analisis.

Enum
STRATEGY_UNSPECIFIED TIDAK DITENTUKAN.
DESKTOP Ambil dan analisis URL untuk browser desktop.
MOBILE Ambil dan analisis URL untuk perangkat seluler.

PagespeedApiLoadingExperienceV5

Objek pengalaman pemuatan CrUX yang berisi perincian data CrUX.

Representasi JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Kolom
id

string

URL, pola, atau origin tempat metrik berada.
metrics

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

Peta <metrics, data>.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
overall_category

string

Kecepatan "kategori" ID yang dapat dibaca manusia.
initial_url

string

URL yang diminta, yang mungkin berbeda dengan "id" yang di-resolve.
origin_fallback

boolean

True jika hasilnya adalah fallback origin dari halaman, false jika tidak.

LighthouseResultV5

Objek hasil Lighthouse.

Representasi 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)
  }
}
Kolom
fetchTime

string

Waktu operasi ini diambil.
requestedUrl

string

URL asli yang diminta.
finalUrl

string

URL final yang diselesaikan yang diaudit.
lighthouseVersion

string

Versi mercusuar yang digunakan untuk membuat LHR ini.
i18n

object (I18n)

String internasionalisasi yang diperlukan untuk merender LHR.
userAgent

string

Agen pengguna yang digunakan untuk menjalankan LHR ini.
audits

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

Peta audit di LHR.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
categoryGroups

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

Peta grup kategori di LHR.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
stackPacks[]

object (StackPack)

String saran Stack Pack.
environment

object (Environment)

Setelan lingkungan yang digunakan saat membuat LHR ini.
runWarnings

array (ListValue format)

Daftar semua peringatan operasi di LHR. Akan selalu menghasilkan output setidaknya ke [].
runtimeError

object (RuntimeError)

Pesan error tingkat atas yang, jika ada, menunjukkan masalah yang cukup serius sehingga hasil Lighthouse ini mungkin perlu dihapus.
categories

object (Categories)

Peta kategori di LHR.
timing

object (Timing)

Informasi pengaturan waktu untuk LHR ini.
configSettings

object (ConfigSettings)

Setelan konfigurasi untuk LHR ini.

I18n

Pesan yang berisi data i18n untuk LHR - Versi 1.

Representasi JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Kolom
rendererFormattedStrings

object (RendererFormattedStrings)

String internasional yang diformat ke lokalitas di configSettings.

RendererFormattedStrings

Pesan yang menyimpan string berformat yang digunakan dalam perender.

Representasi 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
}
Kolom
varianceDisclaimer

string

Pernyataan penyangkalan yang ditampilkan di bawah nilai metrik performa.
opportunityResourceColumnLabel

string

Judul untuk estimasi peluang penghematan pemuatan halaman dari audit.
opportunitySavingsColumnLabel

string

Judul untuk estimasi penghematan pemuatan halaman dari audit peluang.
errorMissingAuditInfo

string

String error yang ditampilkan di samping audit yang mengalami error.
errorLabel

string

Label yang ditampilkan di samping audit atau metrik yang mengalami error.
warningHeader

string

Label yang ditampilkan di atas daftar peringatan berbutir.
auditGroupExpandTooltip

string

Teks tooltip pada ikon tanda V yang dapat diluaskan.
passedAuditsGroupTitle

string

Judul yang ditampilkan di atas daftar audit yang lulus.
notApplicableAuditsGroupTitle

string

Judul yang ditampilkan di atas daftar audit yang tidak berlaku untuk suatu halaman.
manualAuditsGroupTitle

string

Judul yang ditampilkan di atas daftar audit yang tidak dikomputasi dalam proses.
toplevelWarningsMessage

string

Label ditampilkan sebelum peringatan penting yang mungkin telah membuat seluruh laporan tidak valid.
scorescaleLabel

string

Label yang menjelaskan skala pengukur skor (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

Label untuk nilai yang ditampilkan dalam ringkasan rantai permintaan penting.
crcInitialNavigation

string

Label untuk permintaan awal dalam rantai permintaan penting.
lsPerformanceCategoryDescription

string

Pernyataan penyangkalan ditampilkan di bagian performa yang menjelaskan bahwa jaringan dapat bervariasi.
labDataTitle

string

Judul kategori performa data lab.

StackPack

Pesan yang berisi informasi Paket Tumpukan.

Representasi JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Kolom
id

string

ID paket tumpukan.
title

string

Judul paket stack.
iconDataURL

string

URI data ikon paket tumpukan.
descriptions

map (key: string, value: string)

String saran paket tumpukan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Environment

Pesan yang berisi konfigurasi lingkungan untuk menjalankan Lighthouse.

Representasi JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Kolom
networkUserAgent

string

String agen pengguna yang dikirim melalui jaringan.
hostUserAgent

string

String agen pengguna dari versi Chrome yang digunakan.
benchmarkIndex

number

Nomor indeks benchmark yang menunjukkan kasar class perangkat.

RuntimeError

Pesan yang berisi konfigurasi error runtime.

Representasi JSON 
{
  "code": string,
  "message": string
}
Kolom
code

string

Kode Error Lighthouse yang dienumerasi.
message

string

Pesan yang dapat dibaca manusia yang menjelaskan kode error.

Kategori

Kategori di Lighthouse berjalan.

Representasi JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Kolom
accessibility

object (LighthouseCategoryV5)

Kategori aksesibilitas, yang berisi semua audit terkait aksesibilitas.
best-practices

object (LighthouseCategoryV5)

Kategori praktik terbaik, yang berisi semua audit terkait praktik terbaik.
seo

object (LighthouseCategoryV5)

Kategori Pengoptimalan Mesin Telusur (SEO), yang berisi semua audit terkait SEO.
pwa

object (LighthouseCategoryV5)

Kategori Progressive-Web-App (PWA), yang berisi semua audit terkait pwa.
performance

object (LighthouseCategoryV5)

Kategori performa, yang berisi semua audit terkait performa.

LighthouseCategoryV5

Kategori Lighthouse.

Representasi JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Kolom
id

string

ID string kategori.
title

string

Nama kategori yang mudah dibaca manusia.
description

string

Deskripsi yang lebih detail tentang kategori dan kepentingannya.
manualDescription

string

Deskripsi untuk audit manual dalam kategori.
auditRefs[]

object (AuditRefs)

Array referensi ke semua anggota audit kategori ini.
score

value (Value format)

Skor keseluruhan kategori, rata-rata tertimbang dari semua auditnya. (Skor kategori, boleh nol.)

AuditRefs

Referensi ringan ke audit menurut ID, yang digunakan untuk mengelompokkan dan memberikan bobot audit dalam kategori tertentu.

Representasi JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
Kolom
id

string

ID referensi audit.
weight

number

Bobot skor audit ini pada skor kategori keseluruhan.
group

string

Grup kategori tempat audit berada (opsional).

Waktu

Pesan yang berisi data waktu performa untuk menjalankan Lighthouse.

Representasi JSON 
{
  "total": number
}
Kolom
total

number

Total durasi durasi Lighthouse.

ConfigSettings

Pesan yang berisi setelan konfigurasi untuk menjalankan Lighthouse.

Representasi JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Kolom
onlyCategories

value (Value format)

Daftar kategori audit yang harus dilakukan operasi.
emulatedFormFactor
(deprecated)

string

Faktor bentuk yang harus digunakan emulasi. Kolom ini tidak digunakan lagi. Sebagai gantinya, formFactor harus digunakan.
locale

string

Setelan lokalitas.
channel

string

Cara Lighthouse dijalankan, misalnya dari ekstensi Chrome atau dari modul npm.
formFactor

string

Cara Lighthouse menafsirkan proses ini dalam kaitannya dengan penilaian metrik performa dan melewatkan pengujian khusus seluler di desktop.

PagespeedVersion

Objek Pagespeed Version.

Representasi JSON 
{
  "major": string,
  "minor": string
}
Kolom
major

string

Nomor versi utama PageSpeed yang digunakan untuk menampilkan hasil ini.
minor

string

Nomor versi minor PageSpeed yang digunakan untuk menghasilkan hasil ini.