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. Thử ngay.

Yêu cầu

Yêu cầu HTTP

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

Tham số

Tên thông số Giá trị Mô tả
Tham số truy vấn bắt buộc
url string URL cần tìm nạp và phân tích
Tham số truy vấn không bắt buộc
category string 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

Các giá trị được chấp nhận là:
  • "accessibility"
  • "best-practices"
  • "performance"
  • "pwa"
  • "seo"
locale string Ngôn ngữ dùng để bản địa hoá kết quả đã định dạng
strategy string 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

Các giá trị được chấp nhận là:
  • "desktop": Tìm nạp và phân tích URL cho các trình duyệt dành cho máy tính
  • "mobile": Tìm nạp và phân tích URL cho các thiết bị di động
utm_campaign string Tên chiến dịch cho Analytics.
utm_source string Nguồn chiến dịch cho Analytics.

Nội dung yêu cầu

Đừng cung cấp nội dung yêu cầu bằng phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về nội dung phản hồi có cấu trúc như sau:

{
  "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
  }
}
Tên tài sản Giá trị Mô tả Ghi chú
captchaResult string Kết quả xác minh bằng hình ảnh xác thực

Các giá trị được chấp nhận là:
  • "CAPTCHA_BLOCKING"
  • "CAPTCHA_MATCHED"
  • "CAPTCHA_NEEDED"
  • "CAPTCHA_NOT_NEEDED"
  • "CAPTCHA_UNMATCHED"
kind string Đó là một loại kết quả.
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 nested object Các chỉ số về trải nghiệm người dùng cuối trải nghiệm tải trang.
loadingExperience.id string URL, mẫu hoặc nguồn gốc có chứa các chỉ số.
loadingExperience.metrics object
loadingExperience.metrics.(key) object Loại chỉ số.
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 Phiên bản của PageSpeed dùng để tạo những kết quả này.
version.major integer Số phiên bản chính của PageSpeed dùng để tạo những kết quả này.
version.minor integer Số phiên bản nhỏ của PageSpeed dùng để tạo những kết quả này.
loadingExperience.metrics.(key).category string

Các giá trị được chấp nhận là:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.overall_category string

Các giá trị được chấp nhận là:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.initial_url string
loadingExperience.metrics.(key).percentile integer
originLoadingExperience nested object Các chỉ số về trải nghiệm tải trang tổng hợp của nguồn gốc
originLoadingExperience.id string URL, mẫu hoặc nguồn gốc có chứa các chỉ số.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object Loại chỉ số.
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

Các giá trị được chấp nhận là:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.overall_category string

Các giá trị được chấp nhận là:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.initial_url string
analysisUTCTimestamp string Dấu thời gian UTC của bản phân tích này.
lighthouseResult nested object Phản hồi của Lighthouse cho đối tượng URL kiểm tra.
lighthouseResult.requestedUrl string URL được yêu cầu ban đầu.
lighthouseResult.finalUrl string URL đã phân giải cuối cùng đã được kiểm tra.
lighthouseResult.lighthouseVersion string Phiên bản ngọn hải đăng được dùng để tạo LHR này.
lighthouseResult.userAgent string Tác nhân người dùng đã được dùng để chạy LHR này.
lighthouseResult.fetchTime string Thời gian mà lần chạy này được tìm nạp.
lighthouseResult.environment object Các chế độ cài đặt môi trường đã được dùng khi tạo LHR này.
lighthouseResult.environment.networkUserAgent string
lighthouseResult.environment.hostUserAgent string
lighthouseResult.environment.benchmarkIndex double
lighthouseResult.runWarnings[] list Danh sách tất cả cảnh báo chạy trong LHR. Sẽ luôn xuất ra kết quả tối thiểu là `[].
lighthouseResult.configSettings object Chế độ cài đặt cấu hình cho LHR này.
lighthouseResult.configSettings.emulatedFormFactor string Kiểu dáng thiết bị mô phỏng nên sử dụng

Các giá trị được chấp nhận là:
  • "UNKNOWN_FORM_FACTOR"
  • "desktop"
  • "mobile"
  • "none"
lighthouseResult.configSettings.locale string Chế độ cài đặt ngôn ngữ
lighthouseResult.configSettings.onlyCategories nested object
lighthouseResult.audits object Bản đồ các cuộc kiểm tra trong LHR.
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string Mã nhận dạng của cuộc kiểm tra.
lighthouseResult.audits.(key).title string Tiêu đề mà con người có thể đọc được.
lighthouseResult.audits.(key).description string Nội dung mô tả về nội dung kiểm tra.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string Chế độ hiển thị điểm số được liệt kê.

Các giá trị được chấp nhận là:
  • "SCORE_DISPLAY_MODE_UNSPECIFIED"
  • "binary"
  • "error"
  • "informative"
  • "manual"
  • "not_applicable"
  • "numeric"
lighthouseResult.audits.(key).displayValue string Giá trị sẽ hiển thị trên giao diện người dùng cho quá trình kiểm tra này.
lighthouseResult.audits.(key).explanation string Giải thích về lỗi trong kết quả kiểm tra.
lighthouseResult.audits.(key).errorMessage string Một thông báo lỗi từ một lỗi được gửi bên trong quy trình kiểm tra.
lighthouseResult.audits.(key).warnings nested object
lighthouseResult.audits.(key).details object Mục thông tin chi tiết dạng tự do của phiên kiểm tra.
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object Sơ đồ các danh mục trong LHR.
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string Giá trị nhận dạng kiểu chuỗi của danh mục.
lighthouseResult.categories.(key).title string Tên danh mục thân thiện với con người
lighthouseResult.categories.(key).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 đó.
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string Nội dung mô tả cho các hoạt động kiểm tra thủ công trong danh mục.
lighthouseResult.categories.(key).auditRefs[] list 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.
lighthouseResult.categories.(key).auditRefs[].id string Mã tham chiếu kiểm tra.
lighthouseResult.categories.(key).auditRefs[].weight double 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.
lighthouseResult.categories.(key).auditRefs[].group string Nhóm danh mục chứa hoạt động kiểm tra (không bắt buộc).
lighthouseResult.categoryGroups object Bản đồ các nhóm danh mục trong LHR.
lighthouseResult.categoryGroups.(key) object
lighthouseResult.categoryGroups.(key).title string
lighthouseResult.categoryGroups.(key).description string
lighthouseResult.runtimeError object Đối tượng chứa mã và thông báo về mọi lỗi thời gian chạy đã gửi.
lighthouseResult.runtimeError.code string

Các giá trị được chấp nhận là:
  • "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 Thông tin về thời gian cho LHR này.
lighthouseResult.timing.total double Tổng thời gian chạy Lighthouse
lighthouseResult.i18n object Chuỗi quốc tế hoá bắt buộc để kết xuất 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

Hãy dùng thử!

Hãy sử dụng APIs Explorer (Trình khám phá API) bên dưới để gọi phương thức này trên dữ liệu trực tiếp và xem phản hồi.