เรียกใช้การวิเคราะห์ PageSpeed บนหน้าเว็บที่ URL ที่ระบุ และแสดงผลคะแนน PageSpeed ซึ่งเป็นรายการคำแนะนำเพื่อทำให้หน้าเว็บดังกล่าวทำงานได้เร็วยิ่งขึ้น และข้อมูลอื่นๆ
คำขอ HTTP
GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
category |
มีหมวดหมู่ Lighthouse ที่จะเรียกใช้ หากไม่ระบุ ระบบจะเรียกใช้เฉพาะหมวดหมู่ประสิทธิภาพ |
locale |
ภาษาที่ใช้ในการแปลผลการค้นหาที่จัดรูปแบบ |
strategy |
กลยุทธ์การวิเคราะห์ (เดสก์ท็อปหรืออุปกรณ์เคลื่อนที่) และเดสก์ท็อปเป็นค่าเริ่มต้น |
url |
ต้องระบุ URL ที่จะดึงข้อมูลและวิเคราะห์ |
utm_campaign |
ชื่อแคมเปญสำหรับการวิเคราะห์ |
utm_source |
แหล่งที่มาของแคมเปญสำหรับการวิเคราะห์ |
captchaToken |
โทเค็น CAPTCHA ที่ส่งผ่านเมื่อกรอก CAPTCHA |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
ออบเจ็กต์การตอบกลับ Pagespeed API
การแสดง JSON | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
ช่อง | |
---|---|
kind |
ชนิดของผลลัพธ์ |
captchaResult |
ผลการยืนยัน CAPTCHA |
id |
Canonical URL และเป็น URL สุดท้ายสำหรับเอกสารหลังจากเปลี่ยนเส้นทางหน้าเว็บตามมา (หากมี) |
loadingExperience |
เมตริกประสบการณ์การโหลดหน้าเว็บของผู้ใช้ปลายทาง |
originLoadingExperience |
เมตริกของประสบการณ์การโหลดหน้าเว็บแบบรวมของต้นทาง |
analysisUTCTimestamp |
การประทับเวลา UTC ของการวิเคราะห์นี้ |
lighthouseResult |
การตอบสนองของ Lighthouse สำหรับ URL การตรวจสอบที่เป็นออบเจ็กต์ |
version |
เวอร์ชันของ PageSpeed ที่ใช้สร้างผลลัพธ์เหล่านี้ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
openid
โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมของ OAuth 2.0
หมวดหมู่
หมวดหมู่ที่มีการแจกแจงซึ่งควรวิเคราะห์
Enum | |
---|---|
CATEGORY_UNSPECIFIED |
หมวดหมู่ "ไม่ระบุ" เริ่มต้น |
ACCESSIBILITY |
การช่วยเหลือพิเศษ (a11y) หมวดหมู่ที่เกี่ยวข้องกับความสามารถของเว็บไซต์ที่จะให้ผู้ใช้ทุกคนเข้าถึงได้ |
BEST_PRACTICES |
แนวทางปฏิบัติแนะนำ ซึ่งเป็นหมวดหมู่ที่เกี่ยวข้องกับความสอดคล้องของเว็บไซต์กับแนวทางปฏิบัติที่ดีที่สุดสำหรับเว็บ |
PERFORMANCE |
ประสิทธิภาพ หมวดหมู่ที่เกี่ยวข้องกับประสิทธิภาพของเว็บไซต์ |
SEO |
การปรับแต่งเว็บไซต์ให้ติดอันดับบนเครื่องมือค้นหา (SEO) ซึ่งเป็นหมวดหมู่ที่เกี่ยวข้องกับความสามารถของเว็บไซต์ในการจัดทำดัชนีโดยเครื่องมือค้นหา |
การพากย์เสียง
กลยุทธ์การทำงานของอุปกรณ์ที่จะใช้ในการวิเคราะห์
Enum | |
---|---|
STRATEGY_UNSPECIFIED |
หาค่าไม่ได้ |
DESKTOP |
ดึงข้อมูลและวิเคราะห์ URL ของเบราว์เซอร์ในเดสก์ท็อป |
MOBILE |
ดึงข้อมูลและวิเคราะห์ URL สำหรับอุปกรณ์เคลื่อนที่ |
PagespeedApiLoadingExperienceV5
ออบเจ็กต์ประสบการณ์การโหลด CrUX ที่มีรายละเอียดข้อมูล CrUX
การแสดง JSON | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
ช่อง | |
---|---|
id |
URL, รูปแบบ หรือต้นทางที่มีเมตริก |
metrics |
แผนที่ของ <metric, data> ออบเจ็กต์ที่มีรายการคู่ |
overall_category |
"หมวดหมู่" ความเร็วที่มนุษย์อ่านได้ของรหัส |
initial_url |
URL ที่ขอ ซึ่งอาจแตกต่างจาก "id" ที่แก้ไขแล้ว |
origin_fallback |
จริง หากผลลัพธ์เป็นต้นทางสำรองจากหน้าเว็บ มิเช่นนั้นจะเป็นเท็จ |
LighthouseResultV5
ออบเจ็กต์ผลลัพธ์ Lighthouse
การแสดง JSON | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
ช่อง | |
---|---|
fetchTime |
เวลาที่ดึงข้อมูลการเรียกใช้นี้ |
requestedUrl |
URL ที่ขอเดิม |
finalUrl |
URL ที่แก้ปัญหาขั้นสุดท้ายซึ่งได้รับการตรวจสอบแล้ว |
lighthouseVersion |
ประภาคารเวอร์ชันที่ใช้ในการสร้าง LHR นี้ |
i18n |
สตริงการปรับให้เป็นสากลที่จำเป็นต้องใช้ในการแสดงผล LHR |
userAgent |
User Agent ที่ใช้เพื่อเรียกใช้ LHR นี้ |
audits |
แผนที่การตรวจสอบใน LHR ออบเจ็กต์ที่มีรายการคู่ |
categoryGroups |
แผนที่ของกลุ่มหมวดหมู่ใน LHR ออบเจ็กต์ที่มีรายการคู่ |
stackPacks[] |
สตริงคำแนะนำของ Stack Pack |
environment |
การตั้งค่าสภาพแวดล้อมที่ใช้เมื่อสร้าง LHR นี้ |
runWarnings |
รายการคำเตือนการเรียกใช้ทั้งหมดใน LHR จะแสดงผลอย่างน้อย |
runtimeError |
ข้อความแสดงข้อผิดพลาดระดับบนสุดที่บ่งชี้ว่ามีปัญหาร้ายแรงพอที่จะทิ้งผลลัพธ์ของ Lighthouse นี้ |
categories |
แผนที่ของหมวดหมู่ใน LHR |
timing |
ข้อมูลเวลาสำหรับ LHR นี้ |
configSettings |
การตั้งค่ากำหนดสำหรับ LHR นี้ |
i18n
ข้อความที่มีข้อมูล i18n สำหรับ LHR - เวอร์ชัน 1
การแสดง JSON | |
---|---|
{
"rendererFormattedStrings": {
object ( |
ช่อง | |
---|---|
rendererFormattedStrings |
สตริงสากลที่มีการจัดรูปแบบเป็นภาษาใน configSettings |
RendererFormattedStrings
ข้อความที่มีสตริงที่จัดรูปแบบแล้วซึ่งใช้ในตัวแสดงผล
การแสดง 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 } |
ช่อง | |
---|---|
varianceDisclaimer |
ข้อจำกัดความรับผิดที่แสดงด้านล่างค่าเมตริกประสิทธิภาพ |
opportunityResourceColumnLabel |
ส่วนหัวสำหรับโอกาสในการลดการโหลดหน้าเว็บโดยประมาณของการตรวจสอบ |
opportunitySavingsColumnLabel |
ส่วนหัวสำหรับลดการโหลดหน้าเว็บโดยประมาณของการตรวจสอบโอกาส |
errorMissingAuditInfo |
สตริงข้อผิดพลาดที่แสดงถัดจากการตรวจสอบที่มีข้อผิดพลาด |
errorLabel |
ป้ายกำกับที่แสดงถัดจากการตรวจสอบหรือเมตริกที่มีข้อผิดพลาด |
warningHeader |
ป้ายกำกับที่แสดงเหนือรายการสัญลักษณ์หัวข้อย่อย |
auditGroupExpandTooltip |
ข้อความเคล็ดลับเครื่องมือบนไอคอนเครื่องหมายบั้งที่ขยายได้ |
passedAuditsGroupTitle |
ส่วนหัวที่แสดงเหนือรายการการตรวจสอบที่กำลังผ่าน |
notApplicableAuditsGroupTitle |
ส่วนหัวที่แสดงเหนือรายการการตรวจสอบที่ไม่มีผลกับหน้าเว็บ |
manualAuditsGroupTitle |
ส่วนหัวที่แสดงเหนือรายการการตรวจสอบที่ไม่มีการใช้คอมพิวเตอร์ในการเรียกใช้ |
toplevelWarningsMessage |
ป้ายกำกับที่แสดงหน้าคำเตือนสำคัญที่อาจทำให้ทั้งรายงานไม่ถูกต้อง |
scorescaleLabel |
ป้ายกำกับที่อธิบายมาตราวัดคะแนน (0-49, 50-89, 90-100) |
crcLongestDurationLabel |
ป้ายกำกับสำหรับค่าที่แสดงในสรุปของเชนคำขอที่สำคัญ |
crcInitialNavigation |
ป้ายกำกับสำหรับคำขอเริ่มต้นในเชนคำขอที่สำคัญ |
lsPerformanceCategoryDescription |
ข้อจำกัดความรับผิดที่แสดงอยู่ใต้ประสิทธิภาพซึ่งอธิบายว่าเครือข่ายอาจเปลี่ยนแปลงได้ |
labDataTitle |
ชื่อหมวดหมู่ประสิทธิภาพข้อมูลในห้องทดลอง |
StackPack
ข้อความที่มีข้อมูลชุดรายการ
การแสดง JSON | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
ช่อง | |
---|---|
id |
รหัสชุดรายการ |
title |
ชื่อแพ็กสแต็ก |
iconDataURL |
URI ข้อมูลของไอคอนสแต็ก |
descriptions |
สตริงคำแนะนำของสแต็กแพ็ก ออบเจ็กต์ที่มีรายการคู่ |
สภาพแวดล้อม
ข้อความที่มีการกำหนดค่าสภาพแวดล้อมสำหรับการเรียกใช้ Lighthouse
การแสดง JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
ช่อง | |
---|---|
networkUserAgent |
สตริง User Agent ที่ส่งผ่านเครือข่าย |
hostUserAgent |
สตริง User Agent ของเวอร์ชัน Chrome ที่ใช้ |
benchmarkIndex |
หมายเลขดัชนีการเปรียบเทียบซึ่งระบุคลาสอุปกรณ์คร่าวๆ |
RuntimeError
ข้อความที่มีการกำหนดค่าข้อผิดพลาดรันไทม์
การแสดง JSON | |
---|---|
{ "code": string, "message": string } |
ช่อง | |
---|---|
code |
รหัสข้อผิดพลาดของ Lighthouse ที่แจกแจง |
message |
ข้อความที่มนุษย์อ่านได้ซึ่งอธิบายรหัสข้อผิดพลาด |
หมวดหมู่
หมวดหมู่ในการเรียกใช้ Lighthouse
การแสดง JSON | |
---|---|
{ "accessibility": { object ( |
ช่อง | |
---|---|
accessibility |
หมวดหมู่การช่วยเหลือพิเศษที่มีการตรวจสอบทั้งหมดที่เกี่ยวข้องกับการช่วยเหลือพิเศษ |
best-practices |
หมวดหมู่แนวทางปฏิบัติแนะนำที่มีแนวทางปฏิบัติแนะนำทั้งหมดที่เกี่ยวข้องกับการตรวจสอบ |
seo |
หมวดหมู่ Search-Engine-Compliance (SEO) ที่มีการตรวจสอบที่เกี่ยวข้องกับ SEO ทั้งหมด |
performance |
หมวดหมู่ประสิทธิภาพที่มีการตรวจสอบที่เกี่ยวข้องกับประสิทธิภาพทั้งหมด |
LighthouseCategoryV5
หมวดหมู่ Lighthouse
การแสดง JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
ช่อง | |
---|---|
id |
ตัวระบุสตริงของหมวดหมู่ |
title |
ชื่อหมวดหมู่ที่อ่านง่าย |
description |
คำอธิบายโดยละเอียดเพิ่มเติมเกี่ยวกับหมวดหมู่และความสำคัญ |
manualDescription |
คำอธิบายสำหรับการตรวจสอบด้วยตนเองในหมวดหมู่ |
auditRefs[] |
อาร์เรย์ของการอ้างอิงสมาชิกตรวจสอบทั้งหมดของหมวดหมู่นี้ |
score |
คะแนนโดยรวมของหมวดหมู่ ค่าเฉลี่ยถ่วงน้ำหนักของการตรวจสอบทั้งหมด (คะแนนของหมวดหมู่สามารถเป็นค่าว่างได้) |
AuditRefs
การอ้างอิงสั้นๆ ถึงการตรวจสอบตามรหัส ใช้เพื่อจัดกลุ่มและถ่วงน้ำหนักการตรวจสอบในหมวดหมู่ที่กำหนด
การแสดง JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
ช่อง | |
---|---|
id |
รหัสอ้างอิงการตรวจสอบ |
weight |
น้ำหนักของคะแนนการตรวจสอบนี้ที่มีต่อคะแนนโดยรวมของหมวดหมู่ |
group |
กลุ่มหมวดหมู่ที่มีการตรวจสอบ (ไม่บังคับ) |
ช่วงเวลา
ข้อความที่มีข้อมูลเวลาด้านประสิทธิภาพสำหรับการเรียกใช้ Lighthouse
การแสดง JSON | |
---|---|
{ "total": number } |
ช่อง | |
---|---|
total |
ระยะเวลาทั้งหมดที่ Lighthouse เรียกใช้ |
ConfigSettings
ข้อความที่มีการตั้งค่าการกำหนดค่าสำหรับการเรียกใช้ Lighthouse
การแสดง JSON | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
ช่อง | |
---|---|
onlyCategories |
รายการหมวดหมู่การตรวจสอบที่เรียกใช้ควรดำเนินการ |
emulatedFormFactor |
รูปแบบของอุปกรณ์ที่การจำลองควรใช้ ช่องนี้เลิกใช้งานแล้ว โปรดใช้ formFactor แทน |
locale |
การตั้งค่าภาษา |
channel |
ลักษณะการเรียกใช้ Lighthouse เช่น จากส่วนขยาย Chrome หรือจากโมดูล npm |
formFactor |
Lighthouse ควรตีความการเรียกใช้นี้อย่างไรในเรื่องการให้คะแนนเมตริกประสิทธิภาพและการข้ามการทดสอบสำหรับอุปกรณ์เคลื่อนที่เท่านั้นในเดสก์ท็อป |
PagespeedVersion
ออบเจ็กต์เวอร์ชัน PageSpeed
การแสดง JSON | |
---|---|
{ "major": string, "minor": string } |
ช่อง | |
---|---|
major |
หมายเลขเวอร์ชันหลักของ PageSpeed ที่ใช้สร้างผลลัพธ์เหล่านี้ |
minor |
หมายเลขเวอร์ชันรองของ PageSpeed ที่ใช้สร้างผลลัพธ์เหล่านี้ |