لإجراء تحليل سرعة الصفحة على الصفحة على عنوان URL المحدّد، وعرض نتائج PageSpeed وقائمة اقتراحات لجعل تلك الصفحة أسرع بالإضافة إلى معلومات أخرى.
طلب 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
تمثيل JSON | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
الحقول | |
---|---|
kind |
نوع النتيجة. |
captchaResult |
نتيجة التحقق من اختبار CAPTCHA |
id |
عنوان URL الأساسي والنهائي للمستند، بعد عمليات إعادة توجيه الصفحة (إن وُجدت) |
loadingExperience |
مقاييس تجربة تحميل الصفحات لدى المستخدمين النهائيين. |
originLoadingExperience |
مقاييس تجربة تحميل الصفحة المجمَّعة للمصدر |
analysisUTCTimestamp |
الطابع الزمني للتوقيت العالمي المتفق عليه لهذا التحليل. |
lighthouseResult |
استجابة Lighthouse لعنوان URL للتدقيق باعتباره كائنًا |
version |
إصدار PageSpeed المستخدم لإنشاء هذه النتائج. |
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
openid
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.
الفئة
الفئات العددية التي يجب تحليلها.
عمليات التعداد | |
---|---|
CATEGORY_UNSPECIFIED |
الفئة التلقائية "غير محدّد". |
ACCESSIBILITY |
أدوات تسهيل الاستخدام (a11y)، وهي فئة تتعلّق بقدرة الموقع الإلكتروني على أن يكون متاحًا لجميع المستخدمين. |
BEST_PRACTICES |
أفضل الممارسات، الفئة المتعلقة بتوافق الموقع الإلكتروني مع أفضل الممارسات على الويب |
PERFORMANCE |
الأداء، الفئة المتعلقة بأداء الموقع الإلكتروني. |
SEO |
فئة تحسين محركات البحث (SEO)، وهي فئة تتعلّق بإمكانية فهرسة الموقع الإلكتروني بواسطة محرّكات البحث. |
الاستراتيجية
استراتيجية تشغيل الجهاز التي سيتم استخدامها في التحليل.
عمليات التعداد | |
---|---|
STRATEGY_UNSPECIFIED |
غير معروف. |
DESKTOP |
استرجاع عنوان URL وتحليله لمتصفّحات سطح المكتب |
MOBILE |
يمكنك جلب عنوان URL للأجهزة الجوّالة وتحليله. |
PagespeedApiLoadingExperienceV5
عنصر تجربة التحميل في تقرير تجربة المستخدم على Chrome الذي يحتوي على تقسيمات بيانات CrUX.
تمثيل JSON | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
الحقول | |
---|---|
id |
عنوان URL أو النمط أو المصدر الذي تتوفّر فيه المقاييس. |
metrics |
خريطة <المقاييس, البيانات>. عنصر يحتوي على قائمة من أزواج |
overall_category |
تمثّل هذه السمة السرعة التي يمكن للإنسان فهمها "فئة" المعرّف. |
initial_url |
عنوان URL المطلوب، والذي قد يختلف عن "رقم التعريف" الذي تم حله. |
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[] |
سلاسل نصائح حزمة المكدس. |
environment |
إعدادات البيئة التي تم استخدامها عند إنشاء LHR هذا. |
runWarnings |
قائمة بجميع تحذيرات التشغيل في LHR. سيتم دائمًا إخراج النص إلى ما لا يقل عن |
runtimeError |
يشير ظهور رسالة خطأ من المستوى الأعلى، في حال توفّرها، إلى حدوث مشكلة خطيرة بدرجة كافية تتطلّب تجاهل نتيجة Lighthouse هذه. |
categories |
خريطة الفئات في LHR |
timing |
معلومات التوقيت لهذا المكان. |
configSettings |
إعدادات الضبط لهذا الجهاز. |
I18n
رسالة تحتوي على بيانات 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 |
تمثّل هذه السمة عنوان فئة أداء البيانات المعملية. |
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 |
تمثل هذه السمة النتيجة الإجمالية للفئة، والمتوسط المُرجّح لجميع عمليات التدقيق. (يمكن أن تكون نتيجة الفئة صفرًا.) |
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 |
تشير هذه السمة إلى رقم الإصدار الرئيسي لPageSpeed المستخدَم لإنشاء هذه النتائج. |
minor |
تمثل هذه السمة رقم الإصدار الثانوي من PageSpeed المستخدم لإنشاء هذه النتائج. |