Pagespeedapi: runpagespeed

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

בקשה

בקשת HTTP

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

פרמטרים

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

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

הערכים הקבילים הם:
  • ‫desktop: אחזור וניתוח של כתובת ה-URL לדפדפני מחשב
  • ‫"mobile": אחזור וניתוח של כתובת ה-URL למכשירים ניידים
utm_campaign string שם הקמפיין ב-Analytics.
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
  }
}
שם הנכס ערך תיאור הערות
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 הגרסה של PageSpeed ששימשה ליצירת התוצאות האלה.
version.major integer מספר הגרסה הראשית של PageSpeed ששימש ליצירת התוצאות האלה.
version.minor integer מספר הגרסה המשנית של PageSpeed ששימש ליצירת התוצאות האלה.
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 גרסת Lighthouse ששימשה ליצירת ה-LHR הזה.
lighthouseResult.userAgent string סוכן המשתמש ששימש להפעלת הדוח הזה.
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 מזהה ההפניה של הביקורת.
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 שבהמשך כדי להפעיל את השיטה הזו על נתונים פעילים ולראות את התגובה.