מפעיל ניתוח של 'מהירות דף' בדף בכתובת האתר שצוינה ומחזיר את הניקוד של 'מהירות דף', רשימת הצעות להפיכת הדף למהיר יותר ומידע נוסף.
בקשת HTTP
GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
category |
קטגוריית Lighthouse שניתן להריץ. אם לא תצוין אף קטגוריה, תוצג רק הקטגוריה 'ביצועים' |
locale |
הלוקאל המשמש להתאמה לשוק המקומי של תוצאות מעוצבות |
strategy |
אסטרטגיית הניתוח (מחשב או נייד) לשימוש, וברירת המחדל היא 'מחשב' |
url |
חובה. כתובת ה-URL לאחזור ולניתוח |
utm_campaign |
שם הקמפיין לניתוח נתונים. |
utm_source |
מקור הקמפיין לניתוח נתונים. |
captchaToken |
אסימון ה-captcha שהועבר בעת מילוי ה-captcha. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
אובייקט התגובה של Pagespeed API.
ייצוג JSON | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
שדות | |
---|---|
kind |
סוג של תוצאה. |
captchaResult |
התוצאה של אימות ה-captcha |
id |
כתובת URL סופית וקנונית של המסמך, לאחר הפניות אוטומטיות של הדף הבא (אם יש). |
loadingExperience |
מדדי חוויית הטעינה של דפים של משתמשי קצה. |
originLoadingExperience |
מדדים של חוויית הטעינה המצטברת של הדף במקור |
analysisUTCTimestamp |
חותמת הזמן של הניתוח הזה לפי שעון UTC. |
lighthouseResult |
תגובת Lighthouse לכתובת ה-URL של הביקורת כאובייקט. |
version |
הגרסה של 'מהירות דף' ששימשה ליצירת התוצאות האלה. |
היקפי ההרשאות
נדרש היקף ההרשאות הבא של 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 ( |
שדות | |
---|---|
id |
כתובת ה-URL, הדפוס או המקור שבהם נמצאים המדדים. |
metrics |
המפה של <Metrics, data>. אובייקט שמכיל רשימה של |
overall_category |
"category" המהירות הקריאה של המזהה. |
initial_url |
כתובת ה-URL המבוקשת, שעשויה להיות שונה מה-"id" שטופל. |
origin_fallback |
הערך הוא True אם התוצאה היא גיבוי מקור מדף. אחרת, false. |
LighthouseResultV5
אובייקט התוצאה של Lighthouse.
ייצוג JSON | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
שדות | |
---|---|
fetchTime |
השעה שבה ההרצה הזו אוחזרה. |
requestedUrl |
כתובת ה-URL המקורית המבוקשת. |
finalUrl |
כתובת ה-URL הסופית שנבדקה. |
lighthouseVersion |
גרסת המגדלור ששימשה ליצירת ה-LHR הזה. |
i18n |
מחרוזות האינטרנציונליות הנדרשות כדי לעבד את ה-LHR. |
userAgent |
סוכן המשתמש ששימש להפעלת ה-LHR הזה. |
audits |
מפה של הביקורות ב-LHR. אובייקט שמכיל רשימה של |
categoryGroups |
מפה של קבוצות קטגוריות ב-LHR. אובייקט שמכיל רשימה של |
stackPacks[] |
מחרוזות העצות של Stack Pack. |
environment |
הגדרות הסביבה ששימשו ליצירת ה-LHR הזה. |
runWarnings |
רשימה של כל האזהרות על הפעלה ב-LHR. תמיד הערך של הפלט יהיה |
runtimeError |
הודעת שגיאה ברמה העליונה – אם היא קיימת, מצביעה על בעיה חמורה מספיק שיהיה צורך למחוק את התוצאה הזו ב-Lighthouse. |
categories |
מפה של הקטגוריות ב-LHR. |
timing |
פרטי תזמון של ה-LHR הזה. |
configSettings |
הגדרות התצורה של ה-LHR הזה. |
הון סיכון
הודעה שמכילה את נתוני i18n של LHR – גרסה 1.
ייצוג JSON | |
---|---|
{
"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 |
כתב הוויתור שמוצג מתחת לערך של מדד ביצועים. |
opportunityResourceColumnLabel |
הכותרת של הזדמנות החיסכון המשוער בטעינת הדף של ביקורת. |
opportunitySavingsColumnLabel |
הכותרת לחיסכון המשוער בטעינות דפים של ביקורות הזדמנויות. |
errorMissingAuditInfo |
מחרוזת השגיאה שמוצגת לצד ביקורת על שגיאות. |
errorLabel |
התווית שמוצגת לצד ביקורת או מדד שיש בהם שגיאה. |
warningHeader |
התווית שמוצגת מעל רשימת תבליטים של אזהרות. |
auditGroupExpandTooltip |
טקסט של הסבר קצר בסמל סוגר זוויתי ניתן להרחבה. |
passedAuditsGroupTitle |
הכותרת שמוצגת מעל רשימת הביקורות שעוברות. |
notApplicableAuditsGroupTitle |
הכותרת המוצגת מעל רשימת ביקורות שלא חלות על דף כלשהו. |
manualAuditsGroupTitle |
הכותרת שמוצגת מעל רשימת ביקורות שלא חושבו במהלך ההפעלה. |
toplevelWarningsMessage |
התווית שהוצגה לפני אזהרות חשובות, שייתכן שגרמה לביטול התוקף של הדוח כולו. |
scorescaleLabel |
התווית שמסבירה את סולם מדדי הניקוד (0-49, 50-89, 90-100). |
crcLongestDurationLabel |
תווית הערכים שמוצגים בסיכום של שרשראות בקשות קריטיות. |
crcInitialNavigation |
התווית של הבקשה הראשונית בשרשרת בקשות קריטית. |
lsPerformanceCategoryDescription |
כתב הוויתור שמוצג מתחת לביצועים, ומסביר שהרשת עשויה להשתנות. |
labDataTitle |
כותרת קטגוריית הביצועים של נתוני שיעור ה-Lab. |
StackPack
הודעה שמכילה מידע על המקבץ.
ייצוג JSON | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
שדות | |
---|---|
id |
מזהה חבילת הערימה. |
title |
השם של חבילת הערימה. |
iconDataURL |
סמל חבילת הערימה ב-URI של נתונים. |
descriptions |
מחרוזות העצות של חבילת הערימה. אובייקט שמכיל רשימה של |
סביבה
הודעה עם הגדרות של הסביבה להפעלת Lighthouse.
ייצוג JSON | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
שדות | |
---|---|
networkUserAgent |
מחרוזת סוכן המשתמש שנשלחה דרך הרשת. |
hostUserAgent |
מחרוזת סוכן המשתמש של גרסת Chrome שבה נעשה שימוש. |
benchmarkIndex |
המספר של מדד ההשוואה לשוק, שמציין סיווג משוער של המכשיר. |
RuntimeError
הודעה שמכילה הגדרה של שגיאה בתחילת ההפעלה.
ייצוג JSON | |
---|---|
{ "code": string, "message": string } |
שדות | |
---|---|
code |
קוד השגיאה של Lighthouse שנספר. |
message |
הודעה שאנשים יכולים לקרוא, עם הסבר על קוד השגיאה. |
קטגוריות
הקטגוריות בהרצה ב-Lighthouse.
ייצוג JSON | |
---|---|
{ "accessibility": { object ( |
שדות | |
---|---|
accessibility |
קטגוריית הנגישות, שכוללת את כל הביקורות הקשורות לנגישות. |
best-practices |
קטגוריית השיטות המומלצות, הכוללת את כל הביקורות שקשורות לשיטות המומלצות. |
seo |
הקטגוריה 'אופטימיזציה למנועי חיפוש' (SEO) שכוללת את כל הביקורות הקשורות לאופטימיזציה למנועי חיפוש. |
performance |
קטגוריית הביצועים, שמכילה את כל הביקורות הקשורות לביצועים. |
LighthouseCategoryV5
קטגוריה של Lighthouse.
ייצוג JSON | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
שדות | |
---|---|
id |
מזהה המחרוזת של הקטגוריה. |
title |
שם הקטגוריה, הידידותי לבני אדם. |
description |
תיאור מפורט יותר של הקטגוריה וחשיבותה. |
manualDescription |
תיאור של הביקורות הידניות בקטגוריה. |
auditRefs[] |
מערך הפניות לכל חברי הביקורת בקטגוריה הזו. |
score |
הציון הכולל של הקטגוריה, הממוצע המשוקלל של כל הביקורות שלה. (הערך של הקטגוריה יכול להיות null.) |
AuditRefs
הפניה קלה לביקורת לפי מזהה, המשמשת לקיבוץ ולשקלול של ביקורות בקטגוריה נתונה.
ייצוג JSON | |
---|---|
{ "id": string, "weight": number, "group": string } |
שדות | |
---|---|
id |
מזהה ההפניה של הביקורת |
weight |
המשקל שניתן לציון בביקורת הזו על הציון הכולל בקטגוריה. |
group |
קבוצת הקטגוריות שאליה שייכת הביקורת (אופציונלי). |
תזמון
הודעה שמכילה את הנתונים של תזמון הביצועים להפעלת Lighthouse.
ייצוג JSON | |
---|---|
{ "total": number } |
שדות | |
---|---|
total |
משך הזמן הכולל של ההרצה של Lighthouse. |
ConfigSettings
הודעה שמכילה את ההגדרות להפעלת Lighthouse.
ייצוג JSON | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
שדות | |
---|---|
onlyCategories |
רשימת הקטגוריות של הביקורות שההרצה צריכה לבצע. |
emulatedFormFactor |
גורם הצורה שבו יש להשתמש באמולציה. השדה הזה הוצא משימוש. במקומו צריך להשתמש ב-formFactor. |
locale |
הגדרת הלוקאל. |
channel |
אופן ההפעלה של Lighthouse, למשל מהתוסף ל-Chrome או מהמודול של ה-NPM. |
formFactor |
איך מערכת Lighthouse צריכה לפרש את ההרצה הזו ביחס לציון מדדי ביצועים ולדילוג על בדיקות שמיועדות לניידים בלבד במחשב. |
PagespeedVersion
האובייקט 'גרסת PageSpeed'.
ייצוג JSON | |
---|---|
{ "major": string, "minor": string } |
שדות | |
---|---|
major |
מספר הגרסה הראשי של 'מהירות דף' ששימש ליצירת התוצאות האלו. |
minor |
מספר הגרסה המשנית של 'מהירות דף' ששימשה ליצירת התוצאות האלה. |