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 ביצועים, קטגוריה הקשורה לביצועי האתר.
SEO אופטימיזציה למנועי חיפוש (SEO), קטגוריה הקשורה ליכולת של אתר להיכלל באינדקס של מנועי חיפוש.

אסטרטגיה

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

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

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))

המפה של <Metrics, data>.

אובייקט שמכיל רשימה של "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 של 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

הודעה שמכילה מידע על המקבץ.

ייצוג 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)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
שדות
accessibility

object (LighthouseCategoryV5)

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

object (LighthouseCategoryV5)

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

object (LighthouseCategoryV5)

הקטגוריה 'אופטימיזציה למנועי חיפוש' (SEO) שכוללת את כל הביקורות הקשורות לאופטימיזציה למנועי חיפוש.
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)

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

AuditRefs

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

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

string

מזהה ההפניה של הביקורת
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'.

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

string

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

string

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