Method: pagespeedapi.runpagespeed

เรียกใช้การวิเคราะห์ PageSpeed บนหน้าเว็บที่ URL ที่ระบุและแสดงผลคะแนน PageSpeed รายการคำแนะนำที่จะช่วยให้หน้าเว็บนั้นเร็วขึ้น และข้อมูลอื่นๆ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
category

enum (Category)

หมวดหมู่ Lighthouse ที่จะเรียกใช้ หากไม่มีการกำหนดไว้ ระบบจะเรียกใช้เฉพาะหมวดหมู่ประสิทธิภาพ
locale

string

ภาษาที่ใช้ในการแปลผลลัพธ์ที่จัดรูปแบบ
strategy

enum (Strategy)

กลยุทธ์การวิเคราะห์ (เดสก์ท็อปหรืออุปกรณ์เคลื่อนที่) ที่จะใช้ โดยเดสก์ท็อปคือกลยุทธ์เริ่มต้น
url

string

ต้องระบุ URL ที่จะดึงข้อมูลและวิเคราะห์
utm_campaign

string

ชื่อแคมเปญสำหรับ Analytics
utm_source

string

แหล่งที่มาของแคมเปญสำหรับ Analytics
captchaToken

string

โทเค็น CAPTCHA ถูกส่งเมื่อกรอก CAPTCHA

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ออบเจ็กต์การตอบสนองของ Pagespeed API

การแสดง JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
ช่อง
kind

string

เห็นๆ กันอยู่
captchaResult

string

ผลการตรวจสอบ CAPTCHA
id

string

URL สุดท้ายและ Canonical สำหรับเอกสารหลังจากเปลี่ยนเส้นทางหน้าเว็บไป (หากมี)
loadingExperience

object (PagespeedApiLoadingExperienceV5)

เมตริกของผู้ใช้ปลายทาง และการโหลดหน้าเว็บ
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

เมตริกของประสบการณ์การโหลดหน้าเว็บแบบรวมของต้นทาง
analysisUTCTimestamp

string

การประทับเวลา UTC ของการวิเคราะห์นี้
lighthouseResult

object (LighthouseResultV5)

การตอบสนองของ Lighthouse สำหรับ URL การตรวจสอบในรูปแบบออบเจ็กต์
version

object (PagespeedVersion)

เวอร์ชันของ PageSpeed ที่ใช้ในการสร้างผลลัพธ์เหล่านี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • openid

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0

หมวดหมู่

หมวดหมู่ที่แจกแจงที่ควรวิเคราะห์

Enum
CATEGORY_UNSPECIFIED ตั้งหมวดหมู่ " UnderFINED" เริ่มต้น
ACCESSIBILITY การช่วยเหลือพิเศษ (a11y) คือหมวดหมู่ที่เกี่ยวข้องกับความสามารถของเว็บไซต์ที่ผู้ใช้ทุกคนเข้าถึงได้
BEST_PRACTICES แนวทางปฏิบัติที่ดีที่สุด หมวดหมู่ที่เกี่ยวข้องกับความสอดคล้องของเว็บไซต์กับแนวทางปฏิบัติแนะนำของเว็บ
PERFORMANCE ประสิทธิภาพ หมวดหมู่ที่เกี่ยวข้องกับประสิทธิภาพของเว็บไซต์
SEO การปรับแต่งเว็บไซต์ให้ติดอันดับบนเครื่องมือค้นหา (SEO) หมวดหมู่ที่เกี่ยวข้องกับความสามารถของเว็บไซต์ในการจัดทำดัชนีโดยเครื่องมือค้นหา

กลยุทธ์

กลยุทธ์ของอุปกรณ์ที่จะใช้ในการวิเคราะห์

Enum
STRATEGY_UNSPECIFIED หาค่าไม่ได้
DESKTOP ดึงข้อมูลและวิเคราะห์ URL สำหรับเบราว์เซอร์ในเดสก์ท็อป
MOBILE ดึงข้อมูลและวิเคราะห์ URL สำหรับอุปกรณ์เคลื่อนที่

PagespeedApiLoadingExperienceV5

ออบเจ็กต์ประสบการณ์การโหลด CrUX ที่มีรายละเอียดข้อมูล CrUX

การแสดง JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
ช่อง
id

string

URL, รูปแบบ หรือที่มาซึ่งใช้เมตริกอยู่
metrics

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

แผนที่ของ <metrics, data>

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
overall_category

string

ความเร็ว "หมวดหมู่" ที่มนุษย์อ่านได้ ของรหัส
initial_url

string

URL ที่ขอซึ่งอาจแตกต่างจาก "รหัส" ที่แก้ไขแล้ว
origin_fallback

boolean

เป็นจริงหากผลลัพธ์เป็นต้นทางสำรองจากหน้าเว็บ หากไม่เป็นเช่นนั้น

LighthouseResultV5

ออบเจ็กต์ผลการค้นหา Lighthouse

การแสดง 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)
  }
}
ช่อง
fetchTime

string

เวลาที่ดึงข้อมูลการเรียกใช้นี้
requestedUrl

string

URL เดิมที่ขอ
finalUrl

string

URL สุดท้ายที่ได้รับการแก้ไขซึ่งได้รับการตรวจสอบแล้ว
lighthouseVersion

string

เวอร์ชันประภาคารที่ใช้สร้าง LHR นี้
i18n

object (I18n)

สตริงการปรับให้เป็นสากลที่จำเป็นต่อการแสดงผล LHR
userAgent

string

User Agent ที่ใช้เพื่อเรียกใช้ LHR นี้
audits

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

แมปของการตรวจสอบใน LHR

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
categoryGroups

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

แผนที่ของกลุ่มหมวดหมู่ใน LHR

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
stackPacks[]

object (StackPack)

สตริงคำแนะนำสแต็กแพ็ก
environment

object (Environment)

การตั้งค่าสภาพแวดล้อมที่ใช้เมื่อสร้าง LHR นี้
runWarnings

array (ListValue format)

รายการคำเตือนการเรียกใช้ทั้งหมดใน LHR จะแสดงผลเป็นอย่างน้อย [] เสมอ
runtimeError

object (RuntimeError)

ข้อความแสดงข้อผิดพลาดระดับบนสุดที่ (หากมี) แสดงว่ามีปัญหาร้ายแรงพอที่อาจต้องทิ้งผลลัพธ์ของ Lighthouse นี้
categories

object (Categories)

แผนที่ของหมวดหมู่ใน LHR
timing

object (Timing)

ข้อมูลช่วงเวลาสำหรับ LHR นี้
configSettings

object (ConfigSettings)

การตั้งการกำหนดค่าสำหรับ LHR นี้

I18N

ข้อความที่มีข้อมูล i18n สำหรับ LHR - เวอร์ชัน 1

การแสดง JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
ช่อง
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

string

ข้อจำกัดความรับผิดที่แสดงด้านล่างค่าเมตริกประสิทธิภาพ
opportunityResourceColumnLabel

string

ส่วนหัวของโอกาสในการประหยัดการโหลดหน้าเว็บโดยประมาณของการตรวจสอบ
opportunitySavingsColumnLabel

string

หัวเรื่องสำหรับการประหยัดการโหลดหน้าเว็บโดยประมาณของการตรวจสอบโอกาส
errorMissingAuditInfo

string

สตริงข้อผิดพลาดที่แสดงข้างการตรวจสอบที่ผิดพลาด
errorLabel

string

ป้ายกำกับที่แสดงถัดจากการตรวจสอบหรือเมตริกที่มีข้อผิดพลาด
warningHeader

string

ป้ายกำกับที่แสดงเหนือรายการหัวข้อย่อยของคำเตือน
auditGroupExpandTooltip

string

ข้อความเคล็ดลับเครื่องมือบนไอคอนเครื่องหมายบั้งที่ขยายได้
passedAuditsGroupTitle

string

ส่วนหัวที่แสดงเหนือรายการการตรวจสอบที่ผ่าน
notApplicableAuditsGroupTitle

string

ส่วนหัวที่แสดงเหนือรายการการตรวจสอบที่ไม่เกี่ยวข้องกับหน้าเว็บ
manualAuditsGroupTitle

string

ส่วนหัวที่แสดงเหนือรายการการตรวจสอบที่ไม่ได้ใช้คอมพิวเตอร์ในการเรียกใช้
toplevelWarningsMessage

string

ป้ายกำกับดังกล่าวแสดงคำเตือนสำคัญที่เกิดขึ้นก่อนหน้าซึ่งอาจทำให้รายงานทั้งฉบับไม่ถูกต้อง
scorescaleLabel

string

ป้ายกำกับที่อธิบายมาตราวัดคะแนน (0-49, 50-89, 90-100)
crcLongestDurationLabel

string

ป้ายกำกับสำหรับค่าที่แสดงในสรุปห่วงโซ่คำขอที่สำคัญ
crcInitialNavigation

string

ป้ายกำกับสำหรับคำขอเริ่มต้นในสายคำขอที่สำคัญ
lsPerformanceCategoryDescription

string

ข้อจำกัดความรับผิดที่แสดงภายใต้ประสิทธิภาพที่อธิบายว่าเครือข่ายอาจแตกต่างกันไป
labDataTitle

string

ชื่อหมวดหมู่ประสิทธิภาพข้อมูลในห้องทดลอง

StackPack

ข้อความที่มีข้อมูลสแต็กแพ็ก

การแสดง JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
ช่อง
id

string

รหัสสแต็กแพ็ก
title

string

ชื่อสแต็กแพ็ก
iconDataURL

string

URI ข้อมูลไอคอนสแต็กแพ็ก
descriptions

map (key: string, value: string)

สตริงคำแนะนำสแต็กแพ็ก

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

สภาพแวดล้อม

ข้อความที่มีการกำหนดค่าสภาพแวดล้อมสำหรับการเรียกใช้ Lighthouse

การแสดง JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
ช่อง
networkUserAgent

string

สตริง User Agent ที่ส่งผ่านเครือข่าย
hostUserAgent

string

สตริง User Agent ของเวอร์ชัน Chrome ที่ใช้
benchmarkIndex

number

หมายเลขดัชนีเปรียบเทียบที่ระบุคลาสอุปกรณ์อย่างคร่าวๆ

RuntimeError

ข้อความที่มีการกำหนดค่าข้อผิดพลาดรันไทม์

การแสดง JSON 
{
  "code": string,
  "message": string
}
ช่อง
code

string

รหัสข้อผิดพลาดของ Lighthouse ที่แจกแจง
message

string

ข้อความที่มนุษย์อ่านได้ซึ่งอธิบายถึงรหัสข้อผิดพลาด

หมวดหมู่

หมวดหมู่ในการเรียกใช้ Lighthouse

การแสดง JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
ช่อง
accessibility

object (LighthouseCategoryV5)

หมวดหมู่การช่วยเหลือพิเศษที่มีการตรวจสอบที่เกี่ยวข้องกับการช่วยเหลือพิเศษทั้งหมด
best-practices

object (LighthouseCategoryV5)

หมวดหมู่แนวทางปฏิบัติแนะนำ ซึ่งมีแนวทางปฏิบัติแนะนำทั้งหมดที่เกี่ยวข้องกับการตรวจสอบ
seo

object (LighthouseCategoryV5)

หมวดหมู่การปรับแต่งเว็บไซต์ให้ติดอันดับบนเครื่องมือค้นหา (SEO) ที่มีการตรวจสอบที่เกี่ยวข้องกับ SEO ทั้งหมด
performance

object (LighthouseCategoryV5)

หมวดหมู่ประสิทธิภาพที่มีการตรวจสอบที่เกี่ยวข้องกับประสิทธิภาพทั้งหมด

LighthouseCategoryV5

หมวดหมู่ Lighthouse

การแสดง JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
ช่อง
id

string

ตัวระบุสตริงของหมวดหมู่
title

string

ชื่อหมวดหมู่ที่ใช้ง่าย
description

string

คำอธิบายหมวดหมู่โดยละเอียดและความสำคัญของหมวดหมู่
manualDescription

string

คำอธิบายสำหรับการตรวจสอบด้วยตนเองในหมวดหมู่
auditRefs[]

object (AuditRefs)

อาร์เรย์ของการอ้างอิงถึงสมาชิกผู้ตรวจสอบทั้งหมดของหมวดหมู่นี้
score

value (Value format)

คะแนนโดยรวมของหมวดหมู่ ซึ่งเป็นค่าเฉลี่ยถ่วงน้ำหนักของการตรวจสอบทั้งหมด (คะแนนของหมวดหมู่เป็นค่าว่างได้)

AuditRefs

การอ้างอิงเล็กน้อยถึงการตรวจสอบตามรหัส ซึ่งใช้เพื่อจัดกลุ่มและถ่วงน้ำหนักการตรวจสอบในหมวดหมู่หนึ่งๆ

การแสดง JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
ช่อง
id

string

รหัสอ้างอิงการตรวจสอบ
weight

number

น้ำหนักของคะแนนการตรวจสอบนี้มีผลต่อคะแนนหมวดหมู่โดยรวม
group

string

กลุ่มหมวดหมู่ที่มีการตรวจสอบ (ไม่บังคับ)

ช่วงเวลา

ข้อความที่มีข้อมูลเวลาของประสิทธิภาพสำหรับการเรียกใช้ Lighthouse

การแสดง JSON 
{
  "total": number
}
ช่อง
total

number

ระยะเวลารวมของการเรียกใช้ Lighthouse

ConfigSettings

ข้อความที่มีการตั้งค่ากำหนดสำหรับการเรียกใช้ Lighthouse

การแสดง JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
ช่อง
onlyCategories

value (Value format)

รายการหมวดหมู่ของการตรวจสอบที่ผู้เรียกใช้ควรดำเนินการ
emulatedFormFactor
(deprecated)

string

รูปแบบของอุปกรณ์ที่การจำลองควรใช้ ช่องนี้เลิกใช้งานแล้ว ควรใช้ formFactor แทน
locale

string

การตั้งค่าภาษา
channel

string

วิธีการทำงานของ Lighthouse เช่น จากส่วนขยาย Chrome หรือจากโมดูล NPM
formFactor

string

วิธีที่ Lighthouse ควรตีความการเรียกใช้นี้โดยพิจารณาจากการให้คะแนนเมตริกประสิทธิภาพและการข้ามการทดสอบเฉพาะอุปกรณ์เคลื่อนที่ในเดสก์ท็อป

PagespeedVersion

ออบเจ็กต์ Pagespeed Version

การแสดง JSON 
{
  "major": string,
  "minor": string
}
ช่อง
major

string

หมายเลขเวอร์ชันหลักของ PageSpeed ที่ใช้ในการสร้างผลลัพธ์เหล่านี้
minor

string

หมายเลขเวอร์ชันย่อยของ PageSpeed ที่ใช้ในการสร้างผลลัพธ์เหล่านี้