Chạy phân tích PageSpeed trên trang tại URL được 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
Thông số | |
---|---|
category |
Bạn có thể chạy một danh mục Lighthouse; nếu không có danh mục nào được cung cấp, thì chỉ có danh mục Hiệu suất sẽ được chạy |
locale |
Ngôn ngữ dùng để bản địa hoá kết quả có định dạng |
strategy |
Chiến lược phân tích (máy tính hoặc thiết bị di động) mà bạn nên sử dụng, và máy tính là chiến lược mặc định |
url |
Bắt buộc. URL để tìm nạp và phân tích |
utm_campaign |
Tên chiến dịch cho Analytics. |
utm_source |
Nguồn phân tích chiến dịch. |
captchaToken |
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 ( |
Trường | |
---|---|
kind |
Đại loại là vậy. |
captchaResult |
Kết quả xác minh bằng hình ảnh xác thực |
id |
URL cuối cùng và được chuẩn hoá của tài liệu, sau khi tuân theo các lệnh chuyển hướng trang (nếu có). |
loadingExperience |
Các chỉ số về trải nghiệm tải trang của người dùng cuối. |
originLoadingExperience |
Các chỉ số về trải nghiệm tải trang tổng hợp của nguồn gốc |
analysisUTCTimestamp |
Dấu thời gian UTC của bản phân tích này. |
lighthouseResult |
Phản hồi Lighthouse cho URL kiểm tra dưới dạng đối tượng. |
version |
Phiên bản PageSpeed được dùng để tạo những 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 trang web đối với tất cả người dùng. |
BEST_PRACTICES |
Thực tiễn tốt nhất, danh mục liên quan đến việc trang web tuân thủ phương pháp hay nhất về web. |
PERFORMANCE |
Hiệu suất, danh mục liên quan đến hiệu suất của một trang web. |
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
Thiết bị đang chạy chiến lược sẽ được 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 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 ( |
Trường | |
---|---|
id |
URL, mẫu hoặc nguồn gốc của chỉ số. |
metrics |
Bản đồ <metrics, data>. Đối tượng chứa danh sách các cặp |
overall_category |
"Danh mục" tốc độ mà con người có thể đọc được của mã nhận dạng. |
initial_url |
URL được yêu cầu, có thể khác với "id" đã được giải quyết. |
origin_fallback |
"True" nếu kết quả là bản sao dự phòng từ một trang, nếu không thì sai. |
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 ( |
Trường | |
---|---|
fetchTime |
Thời gian mà lần chạy này được tìm nạp. |
requestedUrl |
URL được yêu cầu ban đầu. |
finalUrl |
URL cuối cùng đã phân giải đã được kiểm tra. |
lighthouseVersion |
Phiên bản ngọn hải đăng được dùng để tạo LHR này. |
i18n |
Các chuỗi quốc tế hoá cần thiết để hiển thị LHR. |
userAgent |
Tác nhân người dùng đã được dùng để chạy LHR này. |
audits |
Bản đồ hoạt động kiểm tra trong LHR. Đối tượng chứa danh sách các cặp |
categoryGroups |
Bản đồ các nhóm danh mục trong LHR. Đối tượng chứa danh sách các cặp |
stackPacks[] |
Chuỗi thông báo về Gói ngăn xếp. |
environment |
Các chế độ cài đặt môi trường được sử dụng khi tạo LHR này. |
runWarnings |
Danh sách tất cả các cảnh báo chạy trong LHR. Sẽ luôn xuất sang ít nhất |
runtimeError |
Một thông báo lỗi cấp cao nhất, nếu có, sẽ cho biết sự cố đủ nghiêm trọng mà kết quả Lighthouse này có thể cần phải bị loại bỏ. |
categories |
Bản đồ các danh mục trong LHR. |
timing |
Thông tin về thời gian cho LHR này. |
configSettings |
Các 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 ( |
Trường | |
---|---|
rendererFormattedStrings |
Chuỗi quốc tế hoá được định dạng thành ngôn ngữ trong configSettings. |
RendererFormattedStrings
Thông báo chứa các chuỗi đã được đị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 } |
Trường | |
---|---|
varianceDisclaimer |
Tuyên bố từ chối trách nhiệm hiển thị bên dưới một giá trị chỉ số hiệu suất. |
opportunityResourceColumnLabel |
Tiêu đề thể hiện cơ hội tiết kiệm tải trang ước tính của một cuộc kiểm tra. |
opportunitySavingsColumnLabel |
Tiêu đề cho tiết kiệm tải trang ước tính của các cuộc kiểm tra cơ hội. |
errorMissingAuditInfo |
Chuỗi lỗi hiển thị bên cạnh một yêu cầu kiểm tra lỗi. |
errorLabel |
Nhãn được hiển thị bên cạnh một kiểm tra hoặc chỉ số có lỗi. |
warningHeader |
Nhãn hiển thị phía trên một danh sách các cảnh báo có dấu đầu dòng. |
auditGroupExpandTooltip |
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 |
Tiêu đề xuất hiện phía trên danh sách các lượt kiểm tra đạt. |
notApplicableAuditsGroupTitle |
Tiêu đề xuất hiện phía trên danh sách các quy trình kiểm tra không áp dụng cho một trang. |
manualAuditsGroupTitle |
Tiêu đề 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 |
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 |
Nhãn giải thích thang điểm của biểu đồ (0-49, 50-89, 90-100). |
crcLongestDurationLabel |
Nhãn cho các giá trị hiển thị trong bản tóm tắt các chuỗi yêu cầu quan trọng. |
crcInitialNavigation |
Nhãn cho yêu cầu ban đầu trong chuỗi yêu cầu quan trọng. |
lsPerformanceCategoryDescription |
Tuyên bố từ chối trách nhiệm hiển thị bên dưới nội dung giải thích về hiệu suất rằng mạng có thể thay đổi. |
labDataTitle |
Tiêu đề của danh mục hiệu suất dữ liệu của 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, ... } } |
Trường | |
---|---|
id |
Mã gói ngăn xếp. |
title |
Tiêu đề gói ngăn xếp. |
iconDataURL |
URI dữ liệu biểu tượng gói ngăn xếp. |
descriptions |
Chuỗi tư vấn về gói ngăn xếp. Đối tượng chứa danh sách các cặp |
Môi trường
Thông báo chứa cấu hình môi trường cho một lần chạy Lighthouse.
Biểu diễn dưới dạng JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
Trường | |
---|---|
networkUserAgent |
Chuỗi tác nhân người dùng được gửi qua mạng. |
hostUserAgent |
Chuỗi tác nhân người dùng của phiên bản Chrome được sử dụng. |
benchmarkIndex |
Số chỉ mục điểm chuẩn cho biết lớp 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 } |
Trường | |
---|---|
code |
Mã lỗi Lighthouse được liệt kê. |
message |
Một thông báo mà con người có thể đọc được, giải thích mã lỗi. |
Danh mục
Các danh mục trong một lần chạy Lighthouse.
Biểu diễn dưới dạng JSON | |
---|---|
{ "accessibility": { object ( |
Trường | |
---|---|
accessibility |
Danh mục hỗ trợ tiếp cận, chứa tất cả các lượt kiểm tra liên quan đến khả năng hỗ trợ tiếp cận. |
best-practices |
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 |
Danh mục Tối ưu hoá cho công cụ tìm kiếm (SEO), bao gồm tất cả các nội dung kiểm tra liên quan đến SEO. |
performance |
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
Một danh mục Lighthouse.
Biểu diễn dưới dạng JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
Trường | |
---|---|
id |
Giá trị nhận dạng kiểu chuỗi của danh mục. |
title |
Tên danh mục phù hợp với con người. |
description |
Mô tả chi tiết hơn về danh mục và tầm quan trọng của danh mục đó. |
manualDescription |
Nội dung mô tả cho kiểm tra thủ công trong danh mục. |
auditRefs[] |
Một dãy tham chiếu đến tất cả các thành viên kiểm tra của danh mục này. |
score |
Điểm số chung của danh mục, điểm trung bình có trọng số của tất cả các lượt kiểm tra. (Điểm số của danh mục này có thể là giá trị rỗng.) |
AuditRefs
Giá trị tham chiếu đơn giản đến một hoạt động kiểm tra theo mã nhận dạng, dùng để nhóm và trọng số các cuộc kiểm tra trong một danh mục nhất định.
Biểu diễn dưới dạng JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
Trường | |
---|---|
id |
Mã tham chiếu kiểm tra. |
weight |
Tầm quan trọng của điểm số của cuộc kiểm tra này đối với điểm số tổng thể của danh mục. |
group |
Nhóm danh mục chứa cuộc kiểm tra (không bắt buộc). |
Thời gian
Thông báo chứa dữ liệu về thời gian hiệu suất của lần chạy Lighthouse.
Biểu diễn dưới dạng JSON | |
---|---|
{ "total": number } |
Trường | |
---|---|
total |
Tổng thời lượng chạy Lighthouse. |
ConfigSettings
Thông báo chứa chế độ cài đặt cấu hình cho lần chạy Lighthouse.
Biểu diễn dưới dạng JSON | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
Trường | |
---|---|
onlyCategories |
Danh sách các danh mục kiểm tra mà bạn nên tiến hành. |
emulatedFormFactor |
Hệ số hình dạng mà trình mô phỏng nên sử dụng. Trường này không còn được dùng nữa, bạn nên chuyển sang sử dụng hệ số hình dạng. |
locale |
Chế độ cài đặt ngôn ngữ. |
channel |
Cách chạy Lighthouse, ví dụ: từ tiện ích của Chrome hoặc từ mô-đun npm. |
formFactor |
Cách Lighthouse diễn giải quy trình chạy này trong việc tính điểm chỉ số hiệu suất và bỏ qua các thử nghiệm chỉ dành cho thiết bị di động trên máy tính. |
PagespeedVersion
Đối tượng Pagespeed Version.
Biểu diễn dưới dạng JSON | |
---|---|
{ "major": string, "minor": string } |
Trường | |
---|---|
major |
Số phiên bản chính của PageSpeed được sử dụng để tạo các kết quả này. |
minor |
Số phiên bản nhỏ của PageSpeed được sử dụng để tạo các kết quả này. |