Method: pagespeedapi.runpagespeed

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של שאילתה

פרמטרים
category

enum (Category)

קטגוריית Lighthouse להרצה. אם לא צוינה קטגוריה, תפעל רק קטגוריית הביצועים
locale

string

הלוקאל שמשמש להתאמה לשוק המקומי של תוצאות מעוצבות
strategy

enum (Strategy)

אסטרטגיית הניתוח (מחשב או נייד) לשימוש, וברירת המחדל היא מחשב
url

string

חובה. כתובת ה-URL לאחזור ולניתוח
utm_campaign

string

שם הקמפיין לניתוח נתונים.
utm_source

string

מקור הקמפיין לניתוח נתונים.
captchaToken

string

אסימון ה-captcha שהועבר בעת מילוי ה-captcha.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

אובייקט התגובה של Pagespeed API.

ייצוג JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
שדות
kind

string

תוצאה מסוימת.
captchaResult

string

תוצאת האימות של ה-captcha
id

string

כתובת URL סופית וקנונית של המסמך, לאחר הפניות אוטומטיות לדפים (אם יש).
loadingExperience

object (PagespeedApiLoadingExperienceV5)

מדדים של חוויית הטעינה של הדפים של משתמשי קצה.
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

מדדים של חוויית הטעינה המצטברת של הדפים במקור
analysisUTCTimestamp

string

חותמת הזמן לפי UTC של הניתוח הזה.
lighthouseResult

object (LighthouseResultV5)

תגובת Lighthouse לכתובת URL של הביקורת כאובייקט.
version

object (PagespeedVersion)

גרסת 'מהירות דף' ששימשה ליצירת התוצאות האלו.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • openid

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

קטגוריה

הקטגוריות המספורות שיש לנתח.

טיפוסים בני מנייה (enums)
CATEGORY_UNSPECIFIED קטגוריית ברירת המחדל UNDEFINED.
ACCESSIBILITY נגישות (a11y), קטגוריה הקשורה ליכולת של אתר להיות נגיש לכל המשתמשים.
BEST_PRACTICES שיטות מומלצות, קטגוריה הקשורה לתאימות של אתר לשיטות מומלצות לעבודה עם אתרים.
PERFORMANCE ביצועים, קטגוריה הקשורה לביצועי אתר.
PWA אפליקציה מסוג Progressive Web App (PWA), קטגוריה שקשורה ליכולת של אתר לפעול כ-PWA.
SEO אופטימיזציה של מנועי חיפוש (SEO), קטגוריה הקשורה ליכולת של אתר להוסיף אותו לאינדקס על ידי מנועי חיפוש.

האסטרטגיה

אסטרטגיית ההפעלה של המכשיר לשימוש בניתוח.

טיפוסים בני מנייה (enums)
STRATEGY_UNSPECIFIED לא מוגדר.
DESKTOP מאחזרים ומנתחים את כתובת ה-URL עבור דפדפני מחשב.
MOBILE אחזור וניתוח של כתובת האתר עבור מכשירים ניידים.

PagespeedApiLoadingExperienceV5

אובייקט חוויית הטעינה של CrUX שמכיל פירוטים של נתוני CrUX.

ייצוג JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
שדות
id

string

כתובת ה-URL, הדפוס או המקור שבהם נמצאים המדדים.
metrics

map (key: string, value: object (UserPageLoadMetricV5))

המפה של <מדדים, נתונים>.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }
overall_category

string

המהירות הקריאת לאנשים של המזהה (category) של המזהה.
initial_url

string

כתובת ה-URL המבוקשת, שעשויה להיות שונה מה-"id" שזוהה.
origin_fallback

boolean

True אם התוצאה היא מקור חלופי מדף, False אם לא.

LighthouseResultV5

אובייקט התוצאה של Lighthouse.

ייצוג JSON 
{
  "fetchTime": string,
  "requestedUrl": string,
  "finalUrl": string,
  "lighthouseVersion": string,
  "i18n": {
    object (I18n)
  },
  "userAgent": string,
  "audits": {
    string: {
      object (LighthouseAuditResultV5)
    },
    ...
  },
  "categoryGroups": {
    string: {
      object (CategoryGroupV5)
    },
    ...
  },
  "stackPacks": [
    {
      object (StackPack)
    }
  ],
  "environment": {
    object (Environment)
  },
  "runWarnings": array,
  "runtimeError": {
    object (RuntimeError)
  },
  "categories": {
    object (Categories)
  },
  "timing": {
    object (Timing)
  },
  "configSettings": {
    object (ConfigSettings)
  }
}
שדות
fetchTime

string

השעה שבה ההרצה הזו אוחזרה.
requestedUrl

string

כתובת ה-URL המקורית המבוקשת.
finalUrl

string

כתובת ה-URL הסופית שנבדקה.
lighthouseVersion

string

גרסת המגדלור ששימשה ליצירת ה-LHR הזה.
i18n

object (I18n)

מחרוזות האינטרנציונליות הנדרשות כדי לעבד את ה-LHR.
userAgent

string

סוכן המשתמש ששימש להפעלת ה-LHR הזה.
audits

map (key: string, value: object (LighthouseAuditResultV5))

מפת הביקורות ב-LHR.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }
categoryGroups

map (key: string, value: object (CategoryGroupV5))

מפה של קבוצות קטגוריות ב-LHR.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }
stackPacks[]

object (StackPack)

מחרוזות הייעוץ של Stack Pack.
environment

object (Environment)

הגדרות הסביבה ששימשו ליצירת ה-LHR הזה.
runWarnings

array (ListValue format)

רשימה של כל האזהרות על הרצה ב-LHR. הפלט תמיד יהיה ב-[] לפחות.
runtimeError

object (RuntimeError)

הודעת שגיאה ברמה העליונה מצביעה על בעיה חמורה מספיק, שייתכן שיהיה צורך למחוק את התוצאה הזו ב-Lighthouse.
categories

object (Categories)

מפה של הקטגוריות ב-LHR.
timing

object (Timing)

פרטי התזמון של ה-LHR הזה.
configSettings

object (ConfigSettings)

הגדרות התצורה של ה-LHR הזה.

ה-I18n

הודעה שמכילה את נתוני i18n של LHR – גרסה 1.

ייצוג JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
שדות
rendererFormattedStrings

object (RendererFormattedStrings)

מחרוזות שמותאמות לשוק הבינלאומי בפורמט של הלוקאל ב-configSettings.

RendererFormattedStrings

הודעה שמכילה את המחרוזות המעוצבות ששימשו בכלי לרינדור.

ייצוג JSON 
{
  "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
}
שדות
varianceDisclaimer

string

כתב הוויתור שמוצג מתחת לערך של מדד הביצועים.
opportunityResourceColumnLabel

string

הכותרת של ההזדמנות המשוערת לחיסכון בטעינת דף של ביקורת.
opportunitySavingsColumnLabel

string

הכותרת של החיסכון המשוער בטעינת הדף של ביקורות הזדמנויות.
errorMissingAuditInfo

string

מחרוזת השגיאה שמוצגת לצד ביקורת על שגיאות.
errorLabel

string

התווית שמוצגת לצד ביקורת או מדד שיש בהם שגיאה.
warningHeader

string

התווית המוצגת מעל רשימת תבליטים של אזהרות.
auditGroupExpandTooltip

string

טקסט ההסבר הקצר על סמל של ראש חץ מתרחב.
passedAuditsGroupTitle

string

הכותרת שמוצגת מעל רשימת הביקורות שעוברות.
notApplicableAuditsGroupTitle

string

הכותרת שמוצגת מעל לרשימת ביקורות שאינן רלוונטיות לדף מסוים.
manualAuditsGroupTitle

string

הכותרת שמוצגת מעל לרשימת ביקורות שלא חושבו במהלך ההפעלה.
toplevelWarningsMessage

string

התווית שהוצגה לפני אזהרות חשובות, שבעקבותיה יכול להיות שהדוח כולו לא תקף.
scorescaleLabel

string

התווית שבה מוסבר סולם הציון (0-49, 50-89, 90-100).
crcLongestDurationLabel

string

תווית הערכים שמוצגת בסיכום של שרשראות בקשות קריטיות.
crcInitialNavigation

string

התווית של הבקשה הראשונית בשרשרת בקשות קריטית.
lsPerformanceCategoryDescription

string

כתב הוויתור המוצג מתחת לביצועים ומסביר שהרשת עשויה להשתנות.
labDataTitle

string

כותרת קטגוריית הביצועים של נתוני שיעור ה-Lab.

StackPack

הודעה שמכילה מידע על Stack Pack.

ייצוג JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
שדות
id

string

מזהה חבילת הקריסות.
title

string

השם של חבילת המקבצים.
iconDataURL

string

סמל חבילת המקבצים URI.
descriptions

map (key: string, value: string)

מחרוזות העצות של חבילות סטאק.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }

סביבה

הודעה שמכילה את התצורה של הסביבה להרצה של Lighthouse.

ייצוג JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
שדות
networkUserAgent

string

מחרוזת סוכן המשתמש שנשלחה דרך הרשת.
hostUserAgent

string

מחרוזת סוכן המשתמש של גרסת Chrome שבה נעשה שימוש.
benchmarkIndex

number

המספר של מדד ההשוואה לשוק שמציין סיווג משוער של מכשיר.

RuntimeError

הודעה שמכילה הגדרות של שגיאות בזמן ריצה.

ייצוג JSON 
{
  "code": string,
  "message": string
}
שדות
code

string

קוד השגיאה של Lighthouse שנספר.
message

string

הודעה שאנשים יכולים לקרוא, שמסבירה את קוד השגיאה.

קטגוריות

הקטגוריות בהפעלת Lighthouse.

ייצוג JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
שדות
accessibility

object (LighthouseCategoryV5)

קטגוריית הנגישות, הכוללת את כל הביקורות הקשורות לנגישות.
best-practices

object (LighthouseCategoryV5)

קטגוריית השיטות המומלצות, הכוללת את כל הביקורות שקשורות לשיטות המומלצות.
seo

object (LighthouseCategoryV5)

הקטגוריה 'אופטימיזציה למנועי חיפוש' (SEO) כוללת את כל הביקורות שקשורות לאופטימיזציה למנועי חיפוש.
pwa

object (LighthouseCategoryV5)

הקטגוריה Progressive-Web-App (PWA), שכוללת את כל הביקורות שקשורות ל-PWA.
performance

object (LighthouseCategoryV5)

קטגוריית הביצועים, הכוללת את כל הביקורות הקשורות לביצועים.

LighthouseCategoryV5

קטגוריה של Lighthouse.

ייצוג JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
שדות
id

string

מזהה המחרוזת של הקטגוריה.
title

string

שם הקטגוריה, שמתאים לבני אדם.
description

string

תיאור מפורט יותר של הקטגוריה וחשיבותה.
manualDescription

string

תיאור של הביקורות הידניות בקטגוריה.
auditRefs[]

object (AuditRefs)

מערך הפניות לכל חברי הביקורת בקטגוריה הזו.
score

value (Value format)

הציון הכולל של הקטגוריה, הממוצע המשוקלל של כל הביקורות שלה. (הציון של הקטגוריה יכול להיות אפס).

AuditRefs

הפניה קלה לביקורת לפי מזהה, המשמשת לקיבוץ ושקלול של ביקורות בקטגוריה נתונה.

ייצוג JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
שדות
id

string

מזהה ה-ref של הביקורת.
weight

number

המשקל שיש לציון של הביקורת על הציון הכולל בקטגוריה.
group

string

קבוצת הקטגוריות שאליה שייכת הביקורת (אופציונלי).

תזמון

הודעה שמכילה את הנתונים של תזמון הביצועים להרצה של Lighthouse.

ייצוג JSON 
{
  "total": number
}
שדות
total

number

משך ההפעלה הכולל של Lighthouse.

ConfigSettings

הודעה שמכילה את ההגדרות להרצת Lighthouse.

ייצוג JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
שדות
onlyCategories

value (Value format)

רשימת הקטגוריות של הביקורות שההרצה צריכה לבצע.
emulatedFormFactor
(deprecated)

string

גורם הצורה שבו האמולציה צריכה להשתמש. השדה הזה הוצא משימוש. במקומו צריך להשתמש ב-formFactor.
locale

string

הגדרת הלוקאל.
channel

string

איך Lighthouse הופעל, למשל בתוסף ל-Chrome או במודול npm.
formFactor

string

איך מערכת Lighthouse צריכה לפרש את ההפעלה הזו בהקשר של ציון מדדי ביצועים ודילוג על בדיקות לניידים בלבד במחשב.

PagespeedVersion

האובייקט Pagespeed Version.

ייצוג JSON 
{
  "major": string,
  "minor": string
}
שדות
major

string

מספר הגרסה הראשית של 'מהירות דף' ששימש ליצירת התוצאות האלו.
minor

string

מספר הגרסה המשנית של 'מהירות דף' ששימשה ליצירת התוצאות האלו.