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
  }
}
اسم الموقع القيمة الوصف ملاحظات
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 إصدار سرعة الصفحة المستخدم لإنشاء هذه النتائج.
version.major integer رقم الإصدار الرئيسي لسرعة الصفحة المستخدم لإنشاء هذه النتائج.
version.minor integer الرقم الثانوي لسرعة الصفحة المستخدم لإنشاء هذه النتائج.
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

جرّب الآن

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