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

اسم الحملة في "إحصاءات Google"

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

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

lighthouseResult

object (LighthouseResultV5)

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

version

object (PagespeedVersion)

إصدار سرعة الصفحة المستخدم لإنشاء هذه النتائج.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • openid

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.

الفئة

الفئات المعدّة التي يجب تحليلها.

عمليات التعداد
CATEGORY_UNSPECIFIED الفئة التلقائية "غير محدّد".
ACCESSIBILITY إمكانية الوصول (a11y)، الفئة المتعلقة بقدرة موقع الويب على أن تكون في متناول جميع المستخدمين.
BEST_PRACTICES أفضل الممارسات، الفئة المتعلقة بتوافق موقع الويب مع أفضل ممارسات الويب.
PERFORMANCE الأداء، الفئة المتعلقة بأداء موقع الويب.
SEO تحسين محركات البحث (SEO)، وهي الفئة التي تتعلق بإمكانية فهرسة موقع الويب بواسطة محركات البحث.

الاستراتيجية

يشير ذلك المصطلح إلى استراتيجية تشغيل الجهاز التي سيتم استخدامها في التحليل.

عمليات التعداد
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

صحيح إذا كانت النتيجة مصدرًا احتياطيًا من صفحة، وخطأ في الحالات الأخرى.

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)

معلومات التوقيت في موقع LHR هذا.

configSettings

object (ConfigSettings)

إعدادات الضبط لـ LHR هذا.

عرض تقديمي عالمي 18

رسالة تحتوي على بيانات 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 Version

تمثيل JSON
{
  "major": string,
  "minor": string
}
الحقول
major

string

رقم الإصدار الرئيسي لسرعة الصفحة المستخدم لإنشاء هذه النتائج.

minor

string

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