Method: pagespeedapi.runpagespeed

Chạy quy trình phân tích Tốc độ trang trên trang tại URL được chỉ định và trả về điểm Tốc độ trang, danh sách các đề xuất giúp trang đó nhanh hơn cùng 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

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ẽ 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) sẽ 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 cho Analytics.
captchaToken

string

Mã thông báo hình ảnh xác thực đã được chuyển khi bạn điền vào 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 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)
  }
}
Trường
kind

string

Đó là một loại kết quả.
captchaResult

string

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

string

URL cuối cùng và được chuẩn hoá cho tài liệu, sau các lần chuyển hướng trang sau đây (nếu có).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

Các chỉ số về trải nghiệm người dùng cuối trải nghiệm tải trang.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

Các chỉ số về trải nghiệm tải trang tổng hợp của 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 của Lighthouse cho đối tượng URL kiểm tra.
version

object (PagespeedVersion)

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

Phạm vi cấp phép

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

  • openid

Để biết thêm thông tin, hãy xem bài viết 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 KHÔNG XÁC ĐỊNH mặc định.
ACCESSIBILITY Khả năng truy cập (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 trang web đối 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.
SEO Tối ưu hoá cho công cụ tìm kiếm (SEO), một danh mục liên quan đến khả năng một trang web được các công cụ tìm kiếm lập chỉ mục.

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 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
}
Trường
id

string

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

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

Bản đồ về <chỉ số, dữ liệu>.

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 "mã nhận dạng" đã giải quyết.
origin_fallback

boolean

"True" nếu kết quả là một nguồn gốc dự phòng từ một trang, nếu không thì là 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)
  }
}
Trường
fetchTime

string

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

string

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

string

URL đã phân giải cuối cùng đã đượ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)

Chuỗi quốc tế hoá bắt buộ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 đồ các cuộc 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))

Bản đồ 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 lời khuyên 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 dữ liệu sang ít nhất [].
runtimeError

object (RuntimeError)

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

object (Categories)

Sơ đồ 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 của LHR – Phiên bản 1.

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

object (RendererFormattedStrings)

Các chuỗi được 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 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

string

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

string

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

string

Tiêu đề cho khả năng tiết kiệm tải trang ước tính trong việc kiểm tra cơ hội.
errorMissingAuditInfo

string

Chuỗi lỗi hiển thị bên cạnh kết quả kiểm tra có lỗi.
errorLabel

string

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

string

Nhãn hiển thị phía trên danh sách các cảnh báo có dấu đầu dòng.
auditGroupExpandTooltip

string

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

string

Tiêu đề xuất hiện 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 kiểm tra không áp dụng cho trang.
manualAuditsGroupTitle

string

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

string

Nhãn xuất hiện 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á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 hiệu suất rằng mạng có thể thay đổi.
labDataTitle

string

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

string

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

string

Tiêu đề của 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 trên Lighthouse.

Biểu diễn dưới dạng JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
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 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

string

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

string

Một thông báo dễ đọc, giải thích mã lỗi.

Loại

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

Biểu diễn dưới dạng JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
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 khả 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 phương pháp 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.
performance

object (LighthouseCategoryV5)

Danh mục hiệu suất, chứa tất cả các bài 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
}
Trường
id

string

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

string

Tên danh mục thân thiện với con người.
description

string

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

string

Nội dung mô tả cho các hoạt động kiểm tra thủ công trong danh mục.
auditRefs[]

object (AuditRefs)

Một mảng tham chiếu đến tất cả các thành phần kiểm tra thuộc danh mục này.
score

value (Value format)

Điểm tổng thể của danh mục, giá trị trung bình có trọng số của tất cả các lượt kiểm tra thuộc danh mục đó. (Điểm của danh mục có thể là giá trị rỗng.)

AuditRefs

Tham chiếu nhẹ đến một cuộc kiểm tra theo mã nhận dạng, dùng để kiểm tra 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
}
Trường
id

string

Mã tham chiếu kiểm tra.
weight

number

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

string

Nhóm danh mục chứa hoạt động 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 của hiệu suất để chạy trên Lighthouse.

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

number

Tổng thời gian 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

value (Value format)

Danh sách các danh mục kiểm tra mà bạn nên thực hiện.
emulatedFormFactor
(deprecated)

string

Kiểu dáng mà quy trình 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 dùng hệ số dạng.
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 sẽ diễn giải lần chạy này liên quan đến việc tính điểm các chỉ số hiệu suất và bỏ qua các bài kiểm tra chỉ dành cho thiết bị di động trong máy tính để bàn.

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
}
Trường
major

string

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

string

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