Method: pagespeedapi.runpagespeed

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

בקשת 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.

קטגוריה

הקטגוריות שצוינו שצריך לנתח.

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

אסטרטגיה

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

טיפוסים בני מנייה (enum)
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))

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

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

string

"קטגוריה" מהירות קריאה קריאה לאנשים של המזהה.
initial_url

string

כתובת ה-URL המבוקשת, שעשויה להיות שונה מה'מזהה' שסומן.
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

הודעה שמכילה מידע על חבילת הערימה.

ייצוג 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), המכילה את כל הביקורות הקשורות ל-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 Version של.

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

string

מספר הגרסה הראשית של PageSpeed ששימש ליצירת התוצאות האלה.
minor

string

מספר הגרסה המשנית של PageSpeed ששימש ליצירת התוצאות האלה.