Method: pagespeedapi.runpagespeed

لإجراء تحليل سرعة الصفحة على الصفحة على عنوان 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

تمثيل 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

الطابع الزمني للتوقيت العالمي المتفق عليه لهذا التحليل.
lighthouseResult

object (LighthouseResultV5)

استجابة Lighthouse لعنوان URL للتدقيق باعتباره كائنًا
version

object (PagespeedVersion)

إصدار 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 (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)

سلاسل نصائح حزمة المكدس.
environment

object (Environment)

إعدادات البيئة التي تم استخدامها عند إنشاء LHR هذا.
runWarnings

array (ListValue format)

قائمة بجميع تحذيرات التشغيل في LHR. سيتم دائمًا إخراج النص إلى ما لا يقل عن [].
runtimeError

object (RuntimeError)

يشير ظهور رسالة خطأ من المستوى الأعلى، في حال توفّرها، إلى حدوث مشكلة خطيرة بدرجة كافية تتطلّب تجاهل نتيجة Lighthouse هذه.
categories

object (Categories)

خريطة الفئات في LHR
timing

object (Timing)

معلومات التوقيت لهذا المكان.
configSettings

object (ConfigSettings)

إعدادات الضبط لهذا الجهاز.

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

تمثّل هذه السمة عنوان فئة أداء البيانات المعملية.

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)

تمثل هذه السمة النتيجة الإجمالية للفئة، والمتوسط المُرجّح لجميع عمليات التدقيق. (يمكن أن تكون نتيجة الفئة صفرًا.)

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

تشير هذه السمة إلى رقم الإصدار الرئيسي لPageSpeed المستخدَم لإنشاء هذه النتائج.
minor

string

تمثل هذه السمة رقم الإصدار الثانوي من PageSpeed المستخدم لإنشاء هذه النتائج.