Pagespeedapi: runpagespeed

لتشغيل تحليل PageSpeed للصفحة على عنوان URL المحدد، وعرض نتائج PageSpeed، وقائمة اقتراحات لجعل تلك الصفحة أسرع، وغير ذلك من المعلومات. تجربة ذلك الآن

الطلب

طلب HTTP

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

المَعلمات

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

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

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

نص الطلب

لا توفِّر نص طلب بهذه الطريقة.

الإجابة

في حال نجاحها، تعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "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
  }
}
اسم الموقع القيمة الوصف Notes
captchaResult string نتيجة التحقّق من اختبار CAPTCHA

القيم المقبولة هي:
  • "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 تمثّل هذه السمة نسخة المنارة التي تم استخدامها لإنشاء جدول LHR هذا.
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 إعدادات الضبط لـ LHR هذا.
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 يشير ذلك المصطلح إلى سلاسل التدويل المطلوبة لعرض شاشة LHR.
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

تجربة

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