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

Yêu cầu

Yêu cầu HTTP

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

Các tham số

Tên thông số Giá trị Nội dung 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 Bạn nên 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

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) nên sử dụng, máy tính sẽ 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 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 để phân tích.

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ề một 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ị Nội dung 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 Đại khái là thế.
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 nested object Chỉ số về trải nghiệm tải trang của người dùng cuối.
loadingExperience.id string URL, mẫu hoặc nguồn gốc chứa các chỉ số.
loadingExperience.metrics object
loadingExperience.metrics.(key) object Loại của 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 PageSpeed dùng để tạo các kết quả này.
version.major integer Số phiên bản chính của PageSpeed được dùng để tạo các kết quả này.
version.minor integer Số phiên bản nhỏ của PageSpeed được dùng để tạo các kết quả này.
loadingExperience.metrics.(key).category string

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

Các giá trị có thể 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 tại nguồn gốc
originLoadingExperience.id string URL, mẫu hoặc nguồn gốc chứa các chỉ số.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object Loại của 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ó thể chấp nhận là:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.overall_category string

Các giá trị có thể 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 Lighthouse cho đối tượng url kiểm tra.
lighthouseResult.requestedUrl string URL được yêu cầu ban đầu.
lighthouseResult.finalUrl string URL cuối cùng đã được phân giải đã đượ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 tìm nạp lần chạy này.
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 ít nhất `[]`.
lighthouseResult.configSettings object Chế độ cài đặt cấu hình cho LHR này.
lighthouseResult.configSettings.emulatedFormFactor string Hệ số hình dạng của quy trình mô phỏng phải 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 đồ hoạt động kiểm tra trong LHR.
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string Mã 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ề cuộc kiểm tra.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string Chế độ hiển thị điểm liệt kê.

Các giá trị có thể 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 Nội dung giải thích về các lỗi trong quá trình kiểm tra.
lighthouseResult.audits.(key).errorMessage string Thông báo lỗi từ một lỗi được tạo ra bên trong quá 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 kiểm tra.
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object Bản đồ các danh mục trong LHR.
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string Giá trị nhận dạng chuỗi của danh mục.
lighthouseResult.categories.(key).title string Tên danh mục mà con người có thể đọc được
lighthouseResult.categories.(key).description string Mô tả chi tiết hơn về danh mục và tầm quan trọng của nó.
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string Nội dung mô tả về các lượt kiểm tra thủ công trong danh mục.
lighthouseResult.categories.(key).auditRefs[] list 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.
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 số của bài kiểm tra này đối với điểm số tổng thể của danh mục.
lighthouseResult.categories.(key).auditRefs[].group string Nhóm danh mục chứa bài kiểm tra (không bắt buộc).
lighthouseResult.categoryGroups object Liên kết 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 được gửi.
lighthouseResult.runtimeError.code string

Các giá trị có thể 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 lượng hoạt động của Lighthouse
lighthouseResult.i18n object Các chuỗi quốc tế hoá cần 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 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.