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

แหล่งที่มาของแคมเปญสำหรับการวิเคราะห์
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

Canonical URL และเป็น URL สุดท้ายสําหรับเอกสาร หลังจากติดตามการเปลี่ยนเส้นทางหน้าเว็บ (หากมี)
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 หมวดหมู่ "ยังไม่ได้ระบุ" เริ่มต้น
ACCESSIBILITY การช่วยเหลือพิเศษ (a11y) ซึ่งเป็นหมวดหมู่ที่เกี่ยวข้องกับความสามารถของเว็บไซต์ที่ผู้ใช้ทั้งหมดจะเข้าถึงได้
BEST_PRACTICES แนวทางปฏิบัติที่ดีที่สุด หมวดหมู่ที่เกี่ยวข้องกับความสอดคล้องของเว็บไซต์กับแนวทางปฏิบัติที่ดีที่สุดสำหรับเว็บ
PERFORMANCE ประสิทธิภาพ หมวดหมู่ที่เกี่ยวข้องกับประสิทธิภาพของเว็บไซต์
PWA Progressive Web App (PWA) ซึ่งเป็นหมวดหมู่ที่เกี่ยวข้องกับความสามารถของเว็บไซต์ในการทำงานแบบ PWA
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))

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

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

string

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

string

URL ที่ขอ ซึ่งอาจแตกต่างจาก "id" ที่แก้ไขแล้ว
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)

สตริงคำแนะนำของ Stack Pack
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 นี้

อินนิงที่ 18

ข้อความที่มีข้อมูล 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)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
ช่อง
accessibility

object (LighthouseCategoryV5)

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

object (LighthouseCategoryV5)

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

object (LighthouseCategoryV5)

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

object (LighthouseCategoryV5)

หมวดหมู่ Progressive-Web-App (PWA) ที่มีการตรวจสอบที่เกี่ยวข้องกับ PWA ทั้งหมด
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

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

string

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

string

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