Pagespeedapi: runpagespeed

מפעיל ניתוח של 'מהירות דף' בדף בכתובת האתר שצוינה ומחזיר ניקוד של 'מהירות דף' - רשימת הצעות להפיכת הדף למהיר יותר ומידע נוסף. רוצים לנסות עכשיו?

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר Value התיאור
הפרמטרים הנדרשים של השאילתה
url string כתובת ה-URL לאחזור ולניתוח
פרמטרים אופציונליים של שאילתה
category string קטגוריית Lighthouse להרצה. אם לא צוינה קטגוריה, רק קטגוריית הביצועים תופעל

הערכים המקובלים הם:
  • "accessibility"
  • "best-practices"
  • "performance"
  • "pwa"
  • "seo"
locale string הלוקאל שמשמש להתאמה לשוק המקומי של תוצאות מעוצבות
strategy string שיטת הניתוח (מחשב או נייד) לשימוש, ושיטת הניתוח היא ברירת המחדל

הערכים המקובלים הם:
  • 'desktop': אחזור וניתוח של כתובת ה-URL לדפדפנים במחשבים
  • 'mobile': אחזור וניתוח של כתובת האתר עבור מכשירים ניידים
utm_campaign string שם הקמפיין לניתוח נתונים.
utm_source string מקור הקמפיין לניתוח נתונים.

גוף הבקשה

אל תספקו גוף הבקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה במבנה הבא:

{
  "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
  }
}
שם הנכס Value התיאור הערות
captchaResult string תוצאת האימות של ה-captcha

הערכים הקבילים הם:
  • "CAPTCHA_BLOCKING"
  • "CAPTCHA_MATCHED"
  • "CAPTCHA_NEEDED"
  • "CAPTCHA_NOT_NEEDED"
  • "CAPTCHA_UNMATCHED"
kind string תוצאה מסוימת.
id string כתובת URL סופית וקנונית של המסמך, לאחר הפניות אוטומטיות לדפים (אם יש).
loadingExperience nested object מדדים של חוויית הטעינה של הדפים של משתמשי קצה.
loadingExperience.id string כתובת ה-URL, הדפוס או המקור שבהם נמצאים המדדים.
loadingExperience.metrics object
loadingExperience.metrics.(key) object סוג המדד.
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 גרסת 'מהירות דף' ששימשה ליצירת התוצאות האלו.
version.major integer מספר הגרסה הראשית של 'מהירות דף' ששימש ליצירת התוצאות האלו.
version.minor integer מספר הגרסה המשנית של 'מהירות דף' ששימשה ליצירת התוצאות האלו.
loadingExperience.metrics.(key).category string

הערכים הקבילים הם:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.overall_category string

הערכים הקבילים הם:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.initial_url string
loadingExperience.metrics.(key).percentile integer
originLoadingExperience nested object מדדים של חוויית הטעינה המצטברת של הדפים במקור
originLoadingExperience.id string כתובת ה-URL, הדפוס או המקור שבהם נמצאים המדדים.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object סוג המדד.
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

הערכים הקבילים הם:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.overall_category string

הערכים הקבילים הם:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.initial_url string
analysisUTCTimestamp string חותמת הזמן לפי UTC של הניתוח הזה.
lighthouseResult nested object תגובת Lighthouse לכתובת URL של הביקורת כאובייקט.
lighthouseResult.requestedUrl string כתובת ה-URL המקורית המבוקשת.
lighthouseResult.finalUrl string כתובת ה-URL הסופית שנבדקה.
lighthouseResult.lighthouseVersion string גרסת המגדלור ששימשה ליצירת ה-LHR הזה.
lighthouseResult.userAgent string סוכן המשתמש ששימש להפעלת ה-LHR הזה.
lighthouseResult.fetchTime string השעה שבה ההרצה הזו אוחזרה.
lighthouseResult.environment object הגדרות הסביבה ששימשו ליצירת ה-LHR הזה.
lighthouseResult.environment.networkUserAgent string
lighthouseResult.environment.hostUserAgent string
lighthouseResult.environment.benchmarkIndex double
lighthouseResult.runWarnings[] list רשימה של כל האזהרות על הרצה ב-LHR. הפלט תמיד יהיה ב-`[]` לפחות.
lighthouseResult.configSettings object הגדרות התצורה של ה-LHR הזה.
lighthouseResult.configSettings.emulatedFormFactor string גורם הצורה שבו האמולציה צריכה להשתמש

הערכים הקבילים הם:
  • "UNKNOWN_FORM_FACTOR"
  • "desktop"
  • "mobile"
  • "none"
lighthouseResult.configSettings.locale string הגדרת הלוקאל
lighthouseResult.configSettings.onlyCategories nested object
lighthouseResult.audits object מפת הביקורות ב-LHR.
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string מזהה הביקורת.
lighthouseResult.audits.(key).title string כותרת קריאה לאנשים.
lighthouseResult.audits.(key).description string תיאור הביקורת.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string מצב התצוגה של הציון הנספר.

הערכים הקבילים הם:
  • "SCORE_DISPLAY_MODE_UNSPECIFIED"
  • "binary"
  • "error"
  • "informative"
  • "manual"
  • "not_applicable"
  • "numeric"
lighthouseResult.audits.(key).displayValue string הערך שצריך להציג בממשק המשתמש עבור הביקורת הזו.
lighthouseResult.audits.(key).explanation string הסבר על השגיאות בבדיקה.
lighthouseResult.audits.(key).errorMessage string הודעת שגיאה עקב שגיאה שאירעה בתוך הביקורת.
lighthouseResult.audits.(key).warnings nested object
lighthouseResult.audits.(key).details object הקטע 'פרטי חופשי' בביקורת.
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object מפה של הקטגוריות ב-LHR.
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string מזהה המחרוזת של הקטגוריה.
lighthouseResult.categories.(key).title string שם הקטגוריה, שמתאים לבני אדם
lighthouseResult.categories.(key).description string תיאור מפורט יותר של הקטגוריה וחשיבותה.
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string תיאור של הביקורות הידניות בקטגוריה.
lighthouseResult.categories.(key).auditRefs[] list מערך הפניות לכל חברי הביקורת בקטגוריה הזו.
lighthouseResult.categories.(key).auditRefs[].id string מזהה ה-ref של הביקורת.
lighthouseResult.categories.(key).auditRefs[].weight double המשקל שיש לציון של הביקורת על הציון הכולל בקטגוריה.
lighthouseResult.categories.(key).auditRefs[].group string קבוצת הקטגוריות שאליה שייכת הביקורת (אופציונלי).
lighthouseResult.categoryGroups object מפה של קבוצות קטגוריות ב-LHR.
lighthouseResult.categoryGroups.(key) object
lighthouseResult.categoryGroups.(key).title string
lighthouseResult.categoryGroups.(key).description string
lighthouseResult.runtimeError object אובייקט שמכיל את הקוד + ההודעה של שגיאות זמן ריצה שנוצרו.
lighthouseResult.runtimeError.code string

הערכים הקבילים הם:
  • "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 פרטי התזמון של ה-LHR הזה.
lighthouseResult.timing.total double משך ההפעלה הכולל של Lighthouse
lighthouseResult.i18n object מחרוזות האינטרנציונליות הנדרשות כדי לעבד את ה-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

רוצה לנסות?

ניתן להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.