Pagespeedapi: runpagespeed

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

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์	ค่า	คำอธิบาย
พารามิเตอร์การค้นหาที่จำเป็น
url	string	URL ที่จะดึงข้อมูลและวิเคราะห์
พารามิเตอร์การค้นหาที่ไม่บังคับ
category	string	หมวดหมู่ Lighthouse ที่จะเรียกใช้ หากไม่มีการกำหนดไว้ ระบบจะเรียกใช้เฉพาะหมวดหมู่ประสิทธิภาพ ค่าที่ยอมรับได้ มีดังนี้ "accessibility" "best-practices" "performance" "pwa" "seo"
locale	string	ภาษาที่ใช้ในการแปลผลลัพธ์ที่จัดรูปแบบ
strategy	string	กลยุทธ์การวิเคราะห์ (เดสก์ท็อปหรืออุปกรณ์เคลื่อนที่) ที่จะใช้ โดยเดสก์ท็อปคือกลยุทธ์เริ่มต้น ค่าที่ยอมรับได้ มีดังนี้ "desktop": ดึงข้อมูลและวิเคราะห์ URL สำหรับเบราว์เซอร์ในเดสก์ท็อป "mobile": ดึงข้อมูลและวิเคราะห์ URL สำหรับอุปกรณ์เคลื่อนที่
utm_campaign	string	ชื่อแคมเปญสำหรับ Analytics
utm_source	string	แหล่งที่มาของแคมเปญสำหรับ Analytics

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

โปรดอย่าให้เนื้อหาคำขอตามวิธีการนี้

คำตอบ

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

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "originLoadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "lighthouseResult": {
    "requestedUrl": string,
    "finalUrl": string,
    "lighthouseVersion": string,
    "userAgent": string,
    "fetchTime": string,
    "environment": {
      "networkUserAgent": string,
      "hostUserAgent": string,
      "benchmarkIndex": double
    },
    "runWarnings": [
      (value)
    ],
    "configSettings": {
      "emulatedFormFactor": string,
      "locale": string,
      "onlyCategories": (value),
      "onlyCategories": (value)
    },
    "audits": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "scoreDisplayMode": string,
        "displayValue": string,
        "explanation": string,
        "errorMessage": string,
        "warnings": (value),
        "warnings": (value),
        "details": {
          (key): (value)
        }
      }
    },
    "categories": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "manualDescription": string,
        "auditRefs": [
          {
            "id": string,
            "weight": double,
            "group": string
          }
        ]
      }
    },
    "categoryGroups": {
      (key): {
        "title": string,
        "description": string
      }
    },
    "runtimeError": {
      "code": string,
      "message": string
    },
    "timing": {
      "total": double
    },
    "i18n": {
      "rendererFormattedStrings": {
        "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
      }
    }
  },
  "analysisUTCTimestamp": string,
  "version": {
    "major": integer,
    "minor": integer
  }
}

ชื่อพร็อพเพอร์ตี้	ค่า	คำอธิบาย	หมายเหตุ
captchaResult	string	ผลการตรวจสอบ CAPTCHA ค่าที่ยอมรับได้ มีดังนี้ "CAPTCHA_BLOCKING" "CAPTCHA_MATCHED" "CAPTCHA_NEEDED" "CAPTCHA_NOT_NEEDED" "CAPTCHA_UNMATCHED"
kind	string	เห็นๆ กันอยู่
id	string	URL สุดท้ายและ Canonical สำหรับเอกสารหลังจากเปลี่ยนเส้นทางหน้าเว็บไป (หากมี)
loadingExperience	nested object	เมตริกของผู้ใช้ปลายทาง และการโหลดหน้าเว็บ
loadingExperience.id	string	URL, รูปแบบ หรือที่มาซึ่งใช้เมตริกอยู่
loadingExperience.metrics	object
loadingExperience.metrics.(key)	object	ประเภทของเมตริก
loadingExperience.metrics.(key).distributions[]	list
loadingExperience.metrics.(key).distributions[].min	integer
loadingExperience.metrics.(key).distributions[].max	integer
loadingExperience.metrics.(key).distributions[].proportion	double
version	object	เวอร์ชันของ PageSpeed ที่ใช้ในการสร้างผลลัพธ์เหล่านี้
version.major	integer	หมายเลขเวอร์ชันหลักของ PageSpeed ที่ใช้ในการสร้างผลลัพธ์เหล่านี้
version.minor	integer	หมายเลขเวอร์ชันย่อยของ PageSpeed ที่ใช้ในการสร้างผลลัพธ์เหล่านี้
loadingExperience.metrics.(key).category	string	ค่าที่ยอมรับได้ มีดังนี้ "AVERAGE" "FAST" "NONE" "SLOW"
loadingExperience.overall_category	string	ค่าที่ยอมรับได้ มีดังนี้ "AVERAGE" "FAST" "NONE" "SLOW"
loadingExperience.initial_url	string
loadingExperience.metrics.(key).percentile	integer
originLoadingExperience	nested object	เมตริกของประสบการณ์การโหลดหน้าเว็บแบบรวมของต้นทาง
originLoadingExperience.id	string	URL, รูปแบบ หรือที่มาซึ่งใช้เมตริกอยู่
originLoadingExperience.metrics	object
originLoadingExperience.metrics.(key)	object	ประเภทของเมตริก
originLoadingExperience.metrics.(key).percentile	integer
originLoadingExperience.metrics.(key).distributions[]	list
originLoadingExperience.metrics.(key).distributions[].min	integer
originLoadingExperience.metrics.(key).distributions[].max	integer
originLoadingExperience.metrics.(key).distributions[].proportion	double
originLoadingExperience.metrics.(key).category	string	ค่าที่ยอมรับได้ มีดังนี้ "AVERAGE" "FAST" "NONE" "SLOW"
originLoadingExperience.overall_category	string	ค่าที่ยอมรับได้ มีดังนี้ "AVERAGE" "FAST" "NONE" "SLOW"
originLoadingExperience.initial_url	string
analysisUTCTimestamp	string	การประทับเวลา UTC ของการวิเคราะห์นี้
lighthouseResult	nested object	การตอบสนองของ Lighthouse สำหรับ URL การตรวจสอบในรูปแบบออบเจ็กต์
lighthouseResult.requestedUrl	string	URL เดิมที่ขอ
lighthouseResult.finalUrl	string	URL สุดท้ายที่ได้รับการแก้ไขซึ่งได้รับการตรวจสอบแล้ว
lighthouseResult.lighthouseVersion	string	เวอร์ชันประภาคารที่ใช้สร้าง LHR นี้
lighthouseResult.userAgent	string	User Agent ที่ใช้เพื่อเรียกใช้ LHR นี้
lighthouseResult.fetchTime	string	เวลาที่ดึงข้อมูลการเรียกใช้นี้
lighthouseResult.environment	object	การตั้งค่าสภาพแวดล้อมที่ใช้เมื่อสร้าง LHR นี้
lighthouseResult.environment.networkUserAgent	string
lighthouseResult.environment.hostUserAgent	string
lighthouseResult.environment.benchmarkIndex	double
lighthouseResult.runWarnings[]	list	รายการคำเตือนการเรียกใช้ทั้งหมดใน LHR จะแสดงผลเป็น `[]` เป็นอย่างน้อยเสมอ
lighthouseResult.configSettings	object	การตั้งการกำหนดค่าสำหรับ LHR นี้
lighthouseResult.configSettings.emulatedFormFactor	string	รูปแบบของอุปกรณ์ที่การจำลองควรใช้ ค่าที่ยอมรับได้ มีดังนี้ "UNKNOWN_FORM_FACTOR" "desktop" "mobile" "none"
lighthouseResult.configSettings.locale	string	การตั้งค่าภาษา
lighthouseResult.configSettings.onlyCategories	nested object
lighthouseResult.audits	object	แมปของการตรวจสอบใน LHR
lighthouseResult.audits.(key)	nested object
lighthouseResult.audits.(key).id	string	รหัสการตรวจสอบ
lighthouseResult.audits.(key).title	string	ชื่อที่มนุษย์อ่านได้
lighthouseResult.audits.(key).description	string	คำอธิบายของการตรวจสอบ
lighthouseResult.audits.(key).score	nested object
lighthouseResult.audits.(key).scoreDisplayMode	string	โหมดแสดงคะแนนแบบแจกแจง ค่าที่ยอมรับได้ มีดังนี้ "SCORE_DISPLAY_MODE_UNSPECIFIED" "binary" "error" "informative" "manual" "not_applicable" "numeric"
lighthouseResult.audits.(key).displayValue	string	ค่าที่ควรแสดงใน UI สำหรับการตรวจสอบนี้
lighthouseResult.audits.(key).explanation	string	คําอธิบายข้อผิดพลาดในการตรวจสอบ
lighthouseResult.audits.(key).errorMessage	string	ข้อความแสดงข้อผิดพลาดจากข้อผิดพลาดที่เกิดขึ้นภายในการตรวจสอบ
lighthouseResult.audits.(key).warnings	nested object
lighthouseResult.audits.(key).details	object	ส่วนรายละเอียดรูปแบบอิสระของการตรวจสอบ
lighthouseResult.audits.(key).details.(key)	any value
lighthouseResult.categories	object	แผนที่ของหมวดหมู่ใน LHR
lighthouseResult.categories.(key)	nested object
lighthouseResult.categories.(key).id	string	ตัวระบุสตริงของหมวดหมู่
lighthouseResult.categories.(key).title	string	ชื่อหมวดหมู่ที่ใช้ง่าย
lighthouseResult.categories.(key).description	string	คำอธิบายหมวดหมู่โดยละเอียดและความสำคัญของหมวดหมู่
lighthouseResult.categories.(key).score	nested object
lighthouseResult.categories.(key).manualDescription	string	คำอธิบายสำหรับการตรวจสอบด้วยตนเองในหมวดหมู่
lighthouseResult.categories.(key).auditRefs[]	list	อาร์เรย์ของการอ้างอิงถึงสมาชิกผู้ตรวจสอบทั้งหมดของหมวดหมู่นี้
lighthouseResult.categories.(key).auditRefs[].id	string	รหัสอ้างอิงการตรวจสอบ
lighthouseResult.categories.(key).auditRefs[].weight	double	น้ำหนักของคะแนนการตรวจสอบนี้มีผลต่อคะแนนหมวดหมู่โดยรวม
lighthouseResult.categories.(key).auditRefs[].group	string	กลุ่มหมวดหมู่ที่มีการตรวจสอบ (ไม่บังคับ)
lighthouseResult.categoryGroups	object	แผนที่ของกลุ่มหมวดหมู่ใน LHR
lighthouseResult.categoryGroups.(key)	object
lighthouseResult.categoryGroups.(key).title	string
lighthouseResult.categoryGroups.(key).description	string
lighthouseResult.runtimeError	object	ออบเจ็กต์ที่มีรหัส + ข้อความของข้อผิดพลาดรันไทม์ที่ปรากฏ
lighthouseResult.runtimeError.code	string	ค่าที่ยอมรับได้ มีดังนี้ "ERRORED_DOCUMENT_REQUEST" "FAILED_DOCUMENT_REQUEST" "INSECURE_DOCUMENT_REQUEST" "INVALID_SPEEDLINE" "NO_DCL" "NO_DOCUMENT_REQUEST" "NO_ERROR" "NO_FCP" "NO_NAVSTART" "NO_SCREENSHOTS" "NO_SPEEDLINE_FRAMES" "NO_TRACING_STARTED" "PARSING_PROBLEM" "PROTOCOL_TIMEOUT" "READ_FAILED" "SPEEDINDEX_OF_ZERO" "TRACING_ALREADY_STARTED" "UNKNOWN_ERROR"
lighthouseResult.runtimeError.message	string
lighthouseResult.timing	object	ข้อมูลช่วงเวลาสำหรับ LHR นี้
lighthouseResult.timing.total	double	ระยะเวลารวมของการเรียกใช้ Lighthouse
lighthouseResult.i18n	object	สตริงการปรับให้เป็นสากลที่จำเป็นต่อการแสดงผล LHR
lighthouseResult.i18n.rendererFormattedStrings	object
lighthouseResult.i18n.rendererFormattedStrings.varianceDisclaimer	string
lighthouseResult.i18n.rendererFormattedStrings.opportunityResourceColumnLabel	string
lighthouseResult.i18n.rendererFormattedStrings.opportunitySavingsColumnLabel	string
lighthouseResult.i18n.rendererFormattedStrings.errorMissingAuditInfo	string
lighthouseResult.i18n.rendererFormattedStrings.errorLabel	string
lighthouseResult.i18n.rendererFormattedStrings.warningHeader	string
lighthouseResult.i18n.rendererFormattedStrings.auditGroupExpandTooltip	string
lighthouseResult.i18n.rendererFormattedStrings.passedAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.notApplicableAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.manualAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.toplevelWarningsMessage	string
lighthouseResult.i18n.rendererFormattedStrings.scorescaleLabel	string
lighthouseResult.i18n.rendererFormattedStrings.crcLongestDurationLabel	string
lighthouseResult.i18n.rendererFormattedStrings.crcInitialNavigation	string
lighthouseResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription	string
lighthouseResult.i18n.rendererFormattedStrings.labDataTitle	string

ลองใช้งาน

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ