Pagespeedapi: runpagespeed

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

درخواست

درخواست HTTP

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

پارامترها

نام پارامتر ارزش توضیحات
پارامترهای پرس و جوی مورد نیاز
url string آدرس اینترنتی (URL) برای دریافت و تحلیل
پارامترهای پرس و جو اختیاری
category string یک دسته‌بندی Lighthouse برای اجرا؛ اگر هیچ کدام داده نشده باشد، فقط دسته‌بندی Performance اجرا خواهد شد.

مقادیر قابل قبول عبارتند از:
  • « accessibility »
  • « best-practices »
  • « performance »
  • « 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 پاسخ Lighthouse برای آدرس اینترنتی حسابرسی به عنوان یک شیء.
lighthouseResult. requestedUrl string آدرس اینترنتی (URL) درخواستی اصلی.
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 مقداری که باید برای این حسابرسی در رابط کاربری نمایش داده شود.
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

امتحانش کن!

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