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

ชื่อแคมเปญสำหรับการวิเคราะห์
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 ประสิทธิภาพ หมวดหมู่ที่เกี่ยวข้องกับประสิทธิภาพของเว็บไซต์
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 นี้

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)

หมวดหมู่ Search-Engine-Compliance (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

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

string

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

string

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