Method: pagespeedapi.runpagespeed

Menjalankan analisis PageSpeed pada halaman di URL yang ditentukan, dan menampilkan skor PageSpeed, daftar saran untuk mempercepat pemuatan halaman, 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 untuk dijalankan; jika tidak ada yang diberikan, hanya kategori Performa yang akan dijalankan

locale

string

Lokal yang digunakan untuk melokalkan hasil yang diformat

strategy

enum (Strategy)

Strategi analisis (desktop atau seluler) yang dapat digunakan, dan desktop adalah setelan default

url

string

Wajib diisi. URL yang akan diambil dan dianalisis

utm_campaign

string

Nama kampanye untuk analisis.

utm_source

string

Sumber kampanye untuk analisis.

captchaToken

string

Token captcha diteruskan saat mengisi captcha.

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

Hasil yang bagus.

captchaResult

string

Hasil verifikasi captcha

id

string

URL final dan dikanonikalisasi untuk dokumen, setelah pengalihan halaman berikut (jika ada).

loadingExperience

object (PagespeedApiLoadingExperienceV5)

Metrik pengguna akhir pengalaman pemuatan halaman.

originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Metrik pengalaman pemuatan halaman gabungan asal

analysisUTCTimestamp

string

Stempel waktu UTC dalam 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:

  • 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 situs agar 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.
SEO Pengoptimalan Mesin Telusur (SEO), yaitu kategori yang berkaitan dengan kemampuan situs untuk diindeks oleh mesin telusur.

Strategi

Strategi perangkat yang berjalan untuk 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

"Kategori" kecepatan yang dapat dibaca manusia ID.

initial_url

string

URL yang diminta, yang mungkin berbeda dengan "id" yang telah diselesaikan.

origin_fallback

boolean

True jika hasilnya adalah penggantian asal dari suatu 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 proses ini diambil.

requestedUrl

string

URL asli yang diminta.

finalUrl

string

URL final final yang telah diaudit.

lighthouseVersion

string

Versi mercusuar yang digunakan untuk menghasilkan 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 pengoperasian di LHR. Akan selalu menghasilkan setidaknya [].

runtimeError

object (RuntimeError)

Pesan {i>error <i}tingkat atas yang, jika ada, menunjukkan masalah yang cukup serius sehingga hasil Lighthouse ini mungkin perlu dibuang.

categories

object (Categories)

Peta kategori di LHR.

timing

object (Timing)

Informasi 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 perkiraan 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 berbutir peringatan.

auditGroupExpandTooltip

string

Teks tooltip pada ikon tanda V yang dapat diperluas.

passedAuditsGroupTitle

string

Judul yang ditampilkan di atas daftar audit yang lulus.

notApplicableAuditsGroupTitle

string

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

manualAuditsGroupTitle

string

Judul yang ditampilkan di atas daftar audit yang tidak dijalankan dengan komputer.

toplevelWarningsMessage

string

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

scorescaleLabel

string

Label yang menjelaskan skala alat pengukur (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 yang ditampilkan di bagian performa yang menjelaskan bahwa jaringan dapat bervariasi.

labDataTitle

string

Judul kategori performa data lab.

StackPack

Pesan yang berisi informasi Paket Stack.

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

string

ID paket tumpukan.

title

string

Judul paket tumpukan.

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" }.

Lingkungan

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 versi Chrome yang digunakan.

benchmarkIndex

number

Nomor indeks benchmark yang menunjukkan kelas perangkat kasar.

RuntimeError

Pesan yang berisi konfigurasi error runtime.

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

string

Kode Error Lighthouse yang disebutkan.

message

string

Pesan yang dapat dibaca manusia yang menjelaskan kode error.

Kategori

Kategori dalam menjalankan Lighthouse.

Representasi JSON
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    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.

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 dipahami manusia.

description

string

Deskripsi kategori yang lebih terperinci dan tingkat 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, bisa nol.)

AuditRefs

Referensi ringan untuk audit menurut ID, yang digunakan untuk mengelompokkan dan audit berat dalam kategori tertentu.

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

string

ID ref audit.

weight

number

Bobot skor audit ini terhadap skor kategori secara keseluruhan.

group

string

Grup kategori tempat audit tersebut berada (opsional).

Waktu

Pesan yang berisi data waktu performa untuk operasi Lighthouse.

Representasi JSON
{
  "total": number
}
Kolom
total

number

Total durasi lari 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 dalam 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, mis. dari ekstensi Chrome atau dari modul npm.

formFactor

string

Cara Lighthouse menafsirkan operasi ini terkait 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 memberikan hasil ini.

minor

string

Nomor versi minor PageSpeed yang digunakan untuk membuat hasil ini.