Method: pagespeedapi.runpagespeed

Chạy phân tích PageSpeed trên trang tại URL đã chỉ định và trả về điểm PageSpeed, danh sách các đề xuất để giúp trang đó hoạt động nhanh hơn và các thông tin khác.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Các tham số
category

enum (Category)

Một danh mục Lighthouse để chạy; nếu không có danh mục nào được cung cấp, chỉ có danh mục Hiệu suất sẽ được chạy
locale

string

Ngôn ngữ dùng để bản địa hoá kết quả đã định dạng
strategy

enum (Strategy)

Chiến lược phân tích (máy tính hoặc thiết bị di động) nên sử dụng, và máy tính là chiến lược mặc định
url

string

Bắt buộc. URL cần tìm nạp và phân tích
utm_campaign

string

Tên chiến dịch cho Analytics.
utm_source

string

Nguồn chiến dịch để phân tích.
captchaToken

string

Mã thông báo hình ảnh xác thực được chuyển khi điền hình ảnh xác thực.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Đối tượng phản hồi của Pagespeed API.

Biểu diễn dưới dạng JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
Các trường
kind

string

Đại khái là thế.
captchaResult

string

Kết quả xác minh bằng hình ảnh xác thực
id

string

URL được chuẩn hoá và cuối cùng của tài liệu, sau khi thực hiện các lệnh chuyển hướng trang (nếu có).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Chỉ số về trải nghiệm tải trang của người dùng cuối.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Các chỉ số về trải nghiệm tải trang tổng hợp tại nguồn gốc
analysisUTCTimestamp

string

Dấu thời gian UTC của bản phân tích này.
lighthouseResult

object (LighthouseResultV5)

Phản hồi Lighthouse cho đối tượng url kiểm tra.
version

object (PagespeedVersion)

Phiên bản PageSpeed dùng để tạo các kết quả này.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • openid

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

Danh mục

Các danh mục được liệt kê cần được phân tích.

Enum
CATEGORY_UNSPECIFIED Danh mục UNDEFINED mặc định.
ACCESSIBILITY Hỗ trợ tiếp cận (a11y), danh mục liên quan đến khả năng truy cập của một trang web mà tất cả người dùng đều có thể truy cập.
BEST_PRACTICES Các phương pháp hay nhất, danh mục liên quan đến mức độ tuân thủ của một trang web với các phương pháp hay nhất dành cho web.
PERFORMANCE Hiệu suất, danh mục liên quan đến hiệu suất của trang web.
PWA Ứng dụng web tiến bộ (PWA), danh mục liên quan đến khả năng chạy của một trang web dưới dạng PWA.
SEO Tối ưu hoá cho công cụ tìm kiếm (SEO), danh mục liên quan đến khả năng được các công cụ tìm kiếm lập chỉ mục của một trang web.

Chiến lược

Chiến lược đang chạy thiết bị được sử dụng trong bản phân tích.

Enum
STRATEGY_UNSPECIFIED KHÔNG XÁC ĐỊNH.
DESKTOP Tìm nạp và phân tích URL cho trình duyệt dành cho máy tính.
MOBILE Tìm nạp và phân tích URL cho thiết bị di động.

PagespeedApiLoadingExperienceV5

Đối tượng trải nghiệm tải CrUX có chứa thông tin chi tiết về dữ liệu CrUX.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
Các trường
id

string

URL, mẫu hoặc nguồn gốc chứa các chỉ số.
metrics

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

Bản đồ <metric, data>.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
overall_category

string

"Danh mục" tốc độ mà con người có thể đọc được của mã nhận dạng.
initial_url

string

URL được yêu cầu, có thể khác với "id" đã được giải quyết.
origin_fallback

boolean

"True" nếu kết quả là bản dự phòng từ một trang, nếu không trả về false.

LighthouseResultV5

Đối tượng kết quả Lighthouse.

Biểu diễn dưới dạng 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)
  }
}
Các trường
fetchTime

string

Thời gian tìm nạp lần chạy này.
requestedUrl

string

URL được yêu cầu ban đầu.
finalUrl

string

URL cuối cùng đã được phân giải đã được kiểm tra.
lighthouseVersion

string

Phiên bản ngọn hải đăng được dùng để tạo LHR này.
i18n

object (I18n)

Các chuỗi quốc tế hoá cần có để kết xuất LHR.
userAgent

string

Tác nhân người dùng được dùng để chạy LHR này.
audits

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

Bản đồ hoạt động kiểm tra trong LHR.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
categoryGroups

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

Liên kết các nhóm danh mục trong LHR.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
stackPacks[]

object (StackPack)

Chuỗi thông báo về Gói ngăn xếp.
environment

object (Environment)

Các chế độ cài đặt môi trường được dùng khi tạo LHR này.
runWarnings

array (ListValue format)

Danh sách tất cả cảnh báo chạy trong LHR. Sẽ luôn xuất thành ít nhất [].
runtimeError

object (RuntimeError)

Một thông báo lỗi cấp cao nhất cho biết sự cố đủ nghiêm trọng để có thể loại bỏ kết quả Lighthouse này nếu có.
categories

object (Categories)

Bản đồ các danh mục trong LHR.
timing

object (Timing)

Thông tin về thời gian cho LHR này.
configSettings

object (ConfigSettings)

Chế độ cài đặt cấu hình cho LHR này.

I18n

Thông báo chứa dữ liệu i18n cho LHR – Phiên bản 1.

Biểu diễn dưới dạng JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
Các trường
rendererFormattedStrings

object (RendererFormattedStrings)

Chuỗi quốc tế hoá được định dạng theo ngôn ngữ trong configSettings.

RendererFormattedStrings

Thông báo giữ các chuỗi đã định dạng được dùng trong trình kết xuất.

Biểu diễn dưới dạng 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
}
Các trường
varianceDisclaimer

string

Tuyên bố từ chối trách nhiệm hiển thị bên dưới giá trị chỉ số hiệu suất.
opportunityResourceColumnLabel

string

Tiêu đề về cơ hội tiết kiệm tải trang ước tính của một cuộc kiểm tra.
opportunitySavingsColumnLabel

string

Tiêu đề thể hiện mức tải trang ước tính trong quá trình kiểm tra cơ hội.
errorMissingAuditInfo

string

Chuỗi lỗi hiển thị bên cạnh yêu cầu kiểm tra lỗi.
errorLabel

string

Nhãn được hiển thị bên cạnh một kiểm tra hoặc chỉ số có lỗi.
warningHeader

string

Nhãn xuất hiện phía trên danh sách các cảnh báo được đánh dấu đầu dòng.
auditGroupExpandTooltip

string

Văn bản chú giải công cụ trên biểu tượng hình chữ V có thể mở rộng.
passedAuditsGroupTitle

string

Tiêu đề hiển thị phía trên danh sách các bài kiểm tra đạt.
notApplicableAuditsGroupTitle

string

Tiêu đề được hiển thị phía trên danh sách các cuộc kiểm tra không áp dụng cho một trang.
manualAuditsGroupTitle

string

Tiêu đề được hiển thị phía trên danh sách các cuộc kiểm tra không được máy tính trong lần chạy.
toplevelWarningsMessage

string

Nhãn hiển thị trước những cảnh báo quan trọng có thể đã làm mất hiệu lực của toàn bộ báo cáo.
scorescaleLabel

string

Nhãn giải thích thang đo điểm số (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

Nhãn cho các giá trị xuất hiện trong bản tóm tắt của các chuỗi yêu cầu quan trọng.
crcInitialNavigation

string

Nhãn cho yêu cầu ban đầu trong một chuỗi yêu cầu quan trọng.
lsPerformanceCategoryDescription

string

Tuyên bố từ chối trách nhiệm xuất hiện trong phần giải thích về hiệu suất rằng mạng có thể khác nhau.
labDataTitle

string

Tiêu đề của danh mục hiệu suất dữ liệu trong phòng thí nghiệm.

StackPack

Thông báo chứa thông tin về Gói ngăn xếp.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
Các trường
id

string

Mã gói ngăn xếp.
title

string

Tiêu đề gói ngăn xếp.
iconDataURL

string

URI dữ liệu biểu tượng gói ngăn xếp.
descriptions

map (key: string, value: string)

Chuỗi lời khuyên về gói ngăn xếp.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Môi trường

Thông báo chứa cấu hình môi trường để chạy Lighthouse.

Biểu diễn dưới dạng JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
Các trường
networkUserAgent

string

Chuỗi tác nhân người dùng được gửi qua mạng.
hostUserAgent

string

Chuỗi tác nhân người dùng của phiên bản Chrome được sử dụng.
benchmarkIndex

number

Số chỉ mục điểm chuẩn cho biết loại thiết bị tương đối.

RuntimeError

Thông báo chứa cấu hình lỗi thời gian chạy.

Biểu diễn dưới dạng JSON 
{
  "code": string,
  "message": string
}
Các trường
code

string

Mã lỗi Lighthouse được liệt kê.
message

string

Một thông báo mà người dùng có thể đọc được để giải thích mã lỗi.

Danh mục

Các danh mục trong lần chạy Lighthouse.

Biểu diễn dưới dạng JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
Các trường
accessibility

object (LighthouseCategoryV5)

Danh mục hỗ trợ tiếp cận, chứa tất cả các bài kiểm tra liên quan đến tính năng hỗ trợ tiếp cận.
best-practices

object (LighthouseCategoryV5)

Danh mục các phương pháp hay nhất, chứa tất cả các bài kiểm tra liên quan đến các phương pháp hay nhất.
seo

object (LighthouseCategoryV5)

Danh mục Tối ưu hoá cho công cụ tìm kiếm (SEO) bao gồm tất cả các bài kiểm tra liên quan đến SEO.
pwa

object (LighthouseCategoryV5)

Danh mục Progressive-Web-App (PWA) chứa tất cả các bài kiểm tra liên quan đến pwa.
performance

object (LighthouseCategoryV5)

Danh mục hiệu suất, chứa tất cả các cuộc kiểm tra liên quan đến hiệu suất.

LighthouseCategoryV5

Danh mục Lighthouse.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
Các trường
id

string

Giá trị nhận dạng chuỗi của danh mục.
title

string

Tên danh mục mà con người có thể đọc được.
description

string

Mô tả chi tiết hơn về danh mục và tầm quan trọng của nó.
manualDescription

string

Nội dung mô tả về các lượt kiểm tra thủ công trong danh mục.
auditRefs[]

object (AuditRefs)

Một loạt tham chiếu đến tất cả các thành viên kiểm tra thuộc danh mục này.
score

value (Value format)

Điểm số chung của danh mục, giá trị trung bình có trọng số của tất cả các lần kiểm tra. (Điểm của danh mục, có thể rỗng.)

AuditRefs

Tham chiếu nhẹ đến một cuộc kiểm tra theo mã nhận dạng, dùng để nhóm và kiểm tra trọng số trong một danh mục nhất định.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
Các trường
id

string

Mã tham chiếu kiểm tra
weight

number

Tầm quan trọng của điểm số của bài kiểm tra này đối với điểm số tổng thể của danh mục.
group

string

Nhóm danh mục chứa bài kiểm tra (không bắt buộc).

Thời gian

Thông báo chứa dữ liệu thời gian thực hiện để chạy Lighthouse.

Biểu diễn dưới dạng JSON 
{
  "total": number
}
Các trường
total

number

Tổng thời lượng Lighthouse chạy.

ConfigSettings

Thông báo chứa chế độ cài đặt cấu hình để chạy Lighthouse.

Biểu diễn dưới dạng JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
Các trường
onlyCategories

value (Value format)

Danh sách các danh mục kiểm tra mà quy trình chạy nên tiến hành.
emulatedFormFactor
(deprecated)

string

Hệ số hình dạng mà mô phỏng nên sử dụng. Trường này không còn được dùng nữa, thay vào đó, bạn nên sử dụng formFactor.
locale

string

Chế độ cài đặt ngôn ngữ.
channel

string

Cách chạy Lighthouse, ví dụ: từ tiện ích của Chrome hoặc từ mô-đun npm.
formFactor

string

Cách Lighthouse diễn giải quy trình chạy này liên quan đến việc tính điểm chỉ số hiệu suất và bỏ qua các bài kiểm thử chỉ dành cho thiết bị di động trên máy tính.

PagespeedVersion

Đối tượng Pagespeed Version (Phiên bản tốc độ trang).

Biểu diễn dưới dạng JSON 
{
  "major": string,
  "minor": string
}
Các trường
major

string

Số phiên bản chính của PageSpeed được dùng để tạo các kết quả này.
minor

string

Số phiên bản nhỏ của PageSpeed được dùng để tạo các kết quả này.