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

تمثيل 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 الأداء، الفئة المتعلقة بأداء الموقع الإلكتروني.
PWA تطبيق الويب التقدّمي (PWA)، فئة تتعلّق بإمكانية تشغيل موقع إلكتروني كتطبيق ويب تقدّمي (PWA).
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

صحيح إذا كانت النتيجة عبارة عن مصدر احتياطي من الصفحة، والخطأ 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.
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

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

StackPack

رسالة تحتوي على معلومات حزمة المكدس.

تمثيل JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
الحقول
id

string

رقم تعريف حزمة المكدس
title

string

تمثّل هذه السمة عنوان حزمة المكدس.
iconDataURL

string

معرّف الموارد المنتظم (URI) للبيانات لرمز حزمة Stack.
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)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
الحقول
accessibility

object (LighthouseCategoryV5)

فئة تسهيل الاستخدام، تشمل جميع عمليات التدقيق ذات الصلة بإمكانية الوصول.
best-practices

object (LighthouseCategoryV5)

فئة أفضل الممارسات، تشمل جميع عمليات التدقيق ذات الصلة بأفضل الممارسات.
seo

object (LighthouseCategoryV5)

فئة تحسين محركات البحث (SEO)، التي تحتوي على جميع عمليات التدقيق المتعلقة بتحسين محركات البحث.
pwa

object (LighthouseCategoryV5)

فئة تطبيق الويب التقدّمي (PWA)، التي تتضمّن جميع عمليات التدقيق المتعلّقة بتطبيق الويب التقدّمي
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 المستخدم لإنشاء هذه النتائج.