Pagespeedapi: runpagespeed

تجزیه و تحلیل PageSpeed ​​را روی صفحه در URL مشخص شده اجرا می کند و امتیازات PageSpeed، لیستی از پیشنهادات برای سریعتر کردن آن صفحه و سایر اطلاعات را برمی گرداند. الآن امتحانش کن .

درخواست

درخواست HTTP

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

مولفه های

نام پارامتر ارزش شرح
پارامترهای پرس و جو مورد نیاز
url string URL برای واکشی و تجزیه و تحلیل
پارامترهای پرس و جو اختیاری
category string دسته فانوس دریایی برای اجرا. اگر هیچ کدام داده نشود، فقط دسته عملکرد اجرا خواهد شد

مقادیر قابل قبول عبارتند از:
  • " accessibility "
  • " best-practices "
  • " performance "
  • " pwa "
  • " seo "
locale string محلی که برای بومی سازی نتایج قالب بندی شده استفاده می شود
strategy string استراتژی تجزیه و تحلیل (رومیزی یا تلفن همراه) برای استفاده، و دسکتاپ پیش فرض است

مقادیر قابل قبول عبارتند از:
  • " desktop ": URL را برای مرورگرهای دسکتاپ واکشی و تجزیه و تحلیل کنید
  • " mobile ": URL را برای دستگاه های تلفن همراه واکشی و تجزیه و تحلیل کنید
utm_campaign string نام کمپین برای تجزیه و تحلیل.
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_BLOCKING "
  • " CAPTCHA_MATCHED "
  • " CAPTCHA_NEEDED "
  • " CAPTCHA_NOT_NEEDED "
  • " CAPTCHA_UNMATCHED "
kind string نوعی نتیجه.
id string URL متعارف و نهایی برای سند، پس از دنبال کردن تغییر مسیرهای صفحه (در صورت وجود).
loadingExperience nested object معیارهای تجربه بارگیری صفحه کاربران نهایی.
loadingExperience. id string نشانی وب، الگو یا مبدا که معیارها روی آن هستند.
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 نشانی وب، الگو یا مبدا که معیارها روی آن هستند.
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 مهر زمانی UTC این تحلیل.
lighthouseResult nested object پاسخ فانوس دریایی برای URL ممیزی به عنوان یک شی.
lighthouseResult. requestedUrl string آدرس اصلی درخواست شده
lighthouseResult. finalUrl string آدرس اینترنتی حل شده نهایی که ممیزی شد.
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 مقداری که باید در UI برای این ممیزی نمایش داده شود.
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 کل مدت اجرای فانوس
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

آن را امتحان کنید!

از APIs Explorer زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.