Pagespeedapi: runpagespeed

تُجري هذه الطريقة تحليل PageSpeed على الصفحة المتوفرة في عنوان URL المحدّد، وتعرض نتائج PageSpeed وقائمة بالاقتراحات لتسريع تحميل الصفحة ومعلومات أخرى. جرِّب ذلك الآن.

طلب

طلب HTTP

GET https://www.googleapis.com/pagespeedonline/v5/runPagespeed

المعلمات

اسم المعلَمة القيمة الوصف
مَعلمات طلب البحث المطلوبة
url string عنوان URL المطلوب جلبه وتحليله
مَعلمات طلب البحث الاختيارية
category string فئة Lighthouse المطلوب تنفيذها. في حال عدم تحديد أي فئة، سيتم تنفيذ فئة "الأداء" فقط

القيم المقبولة هي:
  • "accessibility"
  • "best-practices"
  • "performance"
  • "seo"
locale string المنطقة المستخدَمة لتحديد اللغة المناسبة للنتائج المنسَّقة
strategy string إستراتيجية التحليل (الكمبيوتر المكتبي أو الجهاز الجوّال) التي سيتم استخدامها، والكمبيوتر المكتبي هو الإعداد التلقائي

القيم المقبولة هي:
  • ‫"desktop": لجلب عنوان URL وتحليله للمتصفّحات على أجهزة الكمبيوتر
  • ‫"mobile": لجلب عنوان URL وتحليله للأجهزة الجوّالة
utm_campaign string اسم الحملة المستخدَم في "إحصاءات Google".
utm_source string مصدر الحملة في "إحصاءات Google"

نص الطلب

لا تقدّم نص طلب مع هذه الطريقة.

الردّ

في حال نجاح العملية، يعرض هذا الإجراء نص استجابة بالبنية التالية:

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "originLoadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "lighthouseResult": {
    "requestedUrl": string,
    "finalUrl": string,
    "lighthouseVersion": string,
    "userAgent": string,
    "fetchTime": string,
    "environment": {
      "networkUserAgent": string,
      "hostUserAgent": string,
      "benchmarkIndex": double
    },
    "runWarnings": [
      (value)
    ],
    "configSettings": {
      "emulatedFormFactor": string,
      "locale": string,
      "onlyCategories": (value),
      "onlyCategories": (value)
    },
    "audits": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "scoreDisplayMode": string,
        "displayValue": string,
        "explanation": string,
        "errorMessage": string,
        "warnings": (value),
        "warnings": (value),
        "details": {
          (key): (value)
        }
      }
    },
    "categories": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "manualDescription": string,
        "auditRefs": [
          {
            "id": string,
            "weight": double,
            "group": string
          }
        ]
      }
    },
    "categoryGroups": {
      (key): {
        "title": string,
        "description": string
      }
    },
    "runtimeError": {
      "code": string,
      "message": string
    },
    "timing": {
      "total": double
    },
    "i18n": {
      "rendererFormattedStrings": {
        "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
      }
    }
  },
  "analysisUTCTimestamp": string,
  "version": {
    "major": integer,
    "minor": integer
  }
}
اسم السمة القيمة الوصف ملاحظات
captchaResult string نتيجة التحقّق من اختبار التحقّق البشري

القيم المقبولة هي:
  • "CAPTCHA_BLOCKING"
  • "CAPTCHA_MATCHED"
  • "CAPTCHA_NEEDED"
  • "CAPTCHA_NOT_NEEDED"
  • "CAPTCHA_UNMATCHED"
kind string نوع النتيجة
id string تمثّل هذه السمة عنوان URL الأساسي والنهائي للمستند، بعد اتّباع عمليات إعادة توجيه الصفحة (إن وُجدت).
loadingExperience nested object مقاييس تجربة تحميل الصفحة لدى المستخدمين النهائيين
loadingExperience.id string عنوان URL أو النمط أو المصدر الذي تتوفّر فيه المقاييس.
loadingExperience.metrics object
loadingExperience.metrics.(key) object نوع المقياس.
loadingExperience.metrics.(key).distributions[] list
loadingExperience.metrics.(key).distributions[].min integer
loadingExperience.metrics.(key).distributions[].max integer
loadingExperience.metrics.(key).distributions[].proportion double
version object إصدار PageSpeed المستخدَم لإنشاء هذه النتائج
version.major integer رقم الإصدار الرئيسي من PageSpeed المستخدَم لإنشاء هذه النتائج.
version.minor integer رقم الإصدار الثانوي من PageSpeed الذي تم استخدامه لإنشاء هذه النتائج.
loadingExperience.metrics.(key).category string

القيم المقبولة هي:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.overall_category string

القيم المقبولة هي:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
loadingExperience.initial_url string
loadingExperience.metrics.(key).percentile integer
originLoadingExperience nested object مقاييس تجربة تحميل الصفحة المجمَّعة للمصدر
originLoadingExperience.id string عنوان URL أو النمط أو المصدر الذي تتوفّر فيه المقاييس.
originLoadingExperience.metrics object
originLoadingExperience.metrics.(key) object نوع المقياس.
originLoadingExperience.metrics.(key).percentile integer
originLoadingExperience.metrics.(key).distributions[] list
originLoadingExperience.metrics.(key).distributions[].min integer
originLoadingExperience.metrics.(key).distributions[].max integer
originLoadingExperience.metrics.(key).distributions[].proportion double
originLoadingExperience.metrics.(key).category string

القيم المقبولة هي:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.overall_category string

القيم المقبولة هي:
  • "AVERAGE"
  • "FAST"
  • "NONE"
  • "SLOW"
originLoadingExperience.initial_url string
analysisUTCTimestamp string الطابع الزمني للتوقيت العالمي المتفق عليه لهذا التحليل.
lighthouseResult nested object استجابة Lighthouse لعنوان URL الخاص بالتدقيق كعنصر.
lighthouseResult.requestedUrl string عنوان URL الأصلي المطلوب.
lighthouseResult.finalUrl string عنوان URL النهائي الذي تم تدقيقه.
lighthouseResult.lighthouseVersion string إصدار Lighthouse المستخدَم لإنشاء تقرير Lighthouse هذا
lighthouseResult.userAgent string وكيل المستخدم الذي تم استخدامه لتشغيل تقرير LHR هذا.
lighthouseResult.fetchTime string الوقت الذي تم فيه استرداد عملية التشغيل هذه
lighthouseResult.environment object إعدادات بيئة الاختبار التي تم استخدامها عند إنشاء تقرير LHR هذا
lighthouseResult.environment.networkUserAgent string
lighthouseResult.environment.hostUserAgent string
lighthouseResult.environment.benchmarkIndex double
lighthouseResult.runWarnings[] list قائمة بجميع تحذيرات التشغيل في LHR سيتم دائمًا إخراج البيانات إلى `[]` على الأقل.
lighthouseResult.configSettings object إعدادات الضبط الخاصة بهذا المورد المحدود.
lighthouseResult.configSettings.emulatedFormFactor string شكل الجهاز الذي يجب أن يستخدمه المحاكي

القيم المقبولة هي:
  • "UNKNOWN_FORM_FACTOR"
  • "desktop"
  • "mobile"
  • "none"
lighthouseResult.configSettings.locale string إعدادات اللغة
lighthouseResult.configSettings.onlyCategories nested object
lighthouseResult.audits object خريطة عمليات التدقيق في LHR
lighthouseResult.audits.(key) nested object
lighthouseResult.audits.(key).id string معرّف التدقيق.
lighthouseResult.audits.(key).title string تمثّل هذه السمة العنوان الذي يمكن للمستخدم قراءته.
lighthouseResult.audits.(key).description string تمثّل هذه السمة وصف التدقيق.
lighthouseResult.audits.(key).score nested object
lighthouseResult.audits.(key).scoreDisplayMode string وضع عرض النتيجة المُعدَّدة

القيم المقبولة هي:
  • "SCORE_DISPLAY_MODE_UNSPECIFIED"
  • "binary"
  • "error"
  • "informative"
  • "manual"
  • "not_applicable"
  • "numeric"
lighthouseResult.audits.(key).displayValue string القيمة التي يجب عرضها في واجهة المستخدم لعملية التدقيق هذه.
lighthouseResult.audits.(key).explanation string توضيح للأخطاء في التدقيق
lighthouseResult.audits.(key).errorMessage string رسالة خطأ من خطأ تم طرحه داخل التدقيق
lighthouseResult.audits.(key).warnings nested object
lighthouseResult.audits.(key).details object قسم التفاصيل الحرة في التدقيق
lighthouseResult.audits.(key).details.(key) any value
lighthouseResult.categories object خريطة الفئات في تقرير LHR
lighthouseResult.categories.(key) nested object
lighthouseResult.categories.(key).id string تمثّل هذه السمة المعرّف السلسلي للفئة.
lighthouseResult.categories.(key).title string الاسم المناسب للفئة
lighthouseResult.categories.(key).description string وصف أكثر تفصيلاً للفئة وأهميتها
lighthouseResult.categories.(key).score nested object
lighthouseResult.categories.(key).manualDescription string وصف عمليات التدقيق اليدوية في الفئة
lighthouseResult.categories.(key).auditRefs[] list مصفوفة تتضمّن مراجع لجميع أعضاء التدقيق في هذه الفئة.
lighthouseResult.categories.(key).auditRefs[].id string رقم تعريف المرجع الخاص بالتدقيق
lighthouseResult.categories.(key).auditRefs[].weight double تمثّل هذه السمة مدى تأثير نتيجة التدقيق هذه في النتيجة الإجمالية للفئة.
lighthouseResult.categories.(key).auditRefs[].group string تمثّل هذه السمة مجموعة الفئات التي ينتمي إليها التدقيق (اختيارية).
lighthouseResult.categoryGroups object خريطة لمجموعات الفئات في LHR
lighthouseResult.categoryGroups.(key) object
lighthouseResult.categoryGroups.(key).title string
lighthouseResult.categoryGroups.(key).description string
lighthouseResult.runtimeError object عنصر يحتوي على الرمز + الرسالة الخاصة بأي أخطاء وقت التشغيل التي تم طرحها.
lighthouseResult.runtimeError.code string

القيم المقبولة هي:
  • "ERRORED_DOCUMENT_REQUEST"
  • "FAILED_DOCUMENT_REQUEST"
  • "INSECURE_DOCUMENT_REQUEST"
  • "INVALID_SPEEDLINE"
  • "NO_DCL"
  • "NO_DOCUMENT_REQUEST"
  • "NO_ERROR"
  • "NO_FCP"
  • "NO_NAVSTART"
  • "NO_SCREENSHOTS"
  • "NO_SPEEDLINE_FRAMES"
  • "NO_TRACING_STARTED"
  • "PARSING_PROBLEM"
  • "PROTOCOL_TIMEOUT"
  • "READ_FAILED"
  • "SPEEDINDEX_OF_ZERO"
  • "TRACING_ALREADY_STARTED"
  • "UNKNOWN_ERROR"
lighthouseResult.runtimeError.message string
lighthouseResult.timing object معلومات التوقيت الخاصة بهذا التقرير LHR.
lighthouseResult.timing.total double إجمالي مدة تشغيل Lighthouse
lighthouseResult.i18n object سلاسل التدويل المطلوبة لعرض تقرير Lighthouse.
lighthouseResult.i18n.rendererFormattedStrings object
lighthouseResult.i18n.rendererFormattedStrings.varianceDisclaimer string
lighthouseResult.i18n.rendererFormattedStrings.opportunityResourceColumnLabel string
lighthouseResult.i18n.rendererFormattedStrings.opportunitySavingsColumnLabel string
lighthouseResult.i18n.rendererFormattedStrings.errorMissingAuditInfo string
lighthouseResult.i18n.rendererFormattedStrings.errorLabel string
lighthouseResult.i18n.rendererFormattedStrings.warningHeader string
lighthouseResult.i18n.rendererFormattedStrings.auditGroupExpandTooltip string
lighthouseResult.i18n.rendererFormattedStrings.passedAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.notApplicableAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.manualAuditsGroupTitle string
lighthouseResult.i18n.rendererFormattedStrings.toplevelWarningsMessage string
lighthouseResult.i18n.rendererFormattedStrings.scorescaleLabel string
lighthouseResult.i18n.rendererFormattedStrings.crcLongestDurationLabel string
lighthouseResult.i18n.rendererFormattedStrings.crcInitialNavigation string
lighthouseResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription string
lighthouseResult.i18n.rendererFormattedStrings.labDataTitle string

جرِّبها الآن.

استخدِم "مستكشف واجهات برمجة التطبيقات" أدناه لطلب البيانات من خلال هذه الطريقة والاطّلاع على الردّ.