Pagespeedapi: runpagespeed

Chạy quy trình phân tích PageSpeed trên trang tại URL đã chỉ định, đồng thời trả về điểm PageSpeed, danh sách các đề xuất để tăng tốc độ tải trang đó 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

Thông số

Tên thông số Giá trị Mô tả
Tham số truy vấn bắt buộc
url string URL để 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ỉ 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"
  • "seo"
locale string Ngôn ngữ dùng để bản địa hoá kết quả được đị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ử dụng và máy tính là chiến lược mặc định

Các giá trị có thể chấp nhận là:
  • "desktop": Tìm nạp và phân tích URL cho trình duyệt 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 số liệu phân tích.
utm_source string Nguồn chiến dịch cho Analytics.

Nội dung yêu cầu

Khô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 phần nội dung phản hồi có cấu trúc 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 mã xác thực hình ảnh

Các giá trị được chấp nhận là:
  • "CAPTCHA_BLOCKING"
  • "CAPTCHA_MATCHED"
  • "CAPTCHA_NEEDED"
  • "CAPTCHA_NOT_NEEDED"
  • "CAPTCHA_UNMATCHED"
kind string Loại kết quả.
id string URL được chuẩn hoá và URL cuối cùng của tài liệu, sau khi chuyển hướng trang (nếu có).
loadingExperience nested object Các 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 mà các chỉ số nằm trên đó.
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 PageSpeed được 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 phụ 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 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 mà các chỉ số nằm trên đó.
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 URL kiểm tra dưới dạng một đối tượng.
lighthouseResult.requestedUrl string URL được yêu cầu ban đầu.
lighthouseResult.finalUrl string URL cuối cùng đã được phân giải và được kiểm tra.
lighthouseResult.lighthouseVersion string Phiên bản Lighthouse đượ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 truy xuất 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ác cảnh báo khi chạy trong LHR. Sẽ luôn xuất ra ít nhất là "[]".
lighthouseResult.configSettings object Chế độ cài đặt cấu hình cho LHR này.
lighthouseResult.configSettings.emulatedFormFactor string Kiểu dáng mà hoạt động mô phỏng sẽ 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 hoạt động kiểm tra trong LHR.
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string Mã nhận dạng của hoạt động 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ề quy trình 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ẽ xuất hiện trên giao diện người dùng cho hoạt động kiểm tra này.
lighthouseResult.audits.(key).explanation string 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 đã xảy ra 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 tự do của quy trình 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 thân thiện với người dùng
lighthouseResult.categories.(key).description string 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 quy trình kiểm tra thủ công trong danh mục.
lighthouseResult.categories.(key).auditRefs[] list Một mảng gồm các thông tin tham chiếu đến tất cả thành viên kiểm tra của danh mục này.
lighthouseResult.categories.(key).auditRefs[].id string Mã tham chiếu kiểm tra.
lighthouseResult.categories.(key).auditRefs[].weight double Trọng số mà điểm số của quy trình kiểm tra này có trên điểm số tổng thể của danh mục.
lighthouseResult.categories.(key).auditRefs[].group string Nhóm danh mục mà hoạt động kiểm tra thuộc về (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ã + thông báo của mọi lỗi thời gian chạy đã được 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 lượng chạy Lighthouse
lighthouseResult.i18n object Các chuỗi quốc tế hoá cần thiết để hiển thị 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 Trình khám phá API bên dưới để gọi phương thức này trên dữ liệu thực và xem phản hồi.