Method: pagespeedapi.runpagespeed

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
category

enum ( Category )

دسته فانوس دریایی برای اجرا. اگر هیچ کدام داده نشود، فقط دسته عملکرد اجرا خواهد شد

locale

string

محلی که برای بومی سازی نتایج قالب بندی شده استفاده می شود

strategy

enum ( Strategy )

استراتژی تجزیه و تحلیل (رومیزی یا تلفن همراه) برای استفاده، و دسکتاپ پیش فرض است

url

string

مورد نیاز. URL برای واکشی و تجزیه و تحلیل

utm_campaign

string

نام کمپین برای تجزیه و تحلیل.

utm_source

string

منبع کمپین برای تجزیه و تحلیل

captchaToken

string

کد کپچا هنگام پر کردن یک کپچا عبور کرد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

شی پاسخ API Pagespeed.

نمایندگی JSON 
{
  "kind": string,
  "captchaResult": string,
  "id": string,
  "loadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "originLoadingExperience": {
    object (PagespeedApiLoadingExperienceV5)
  },
  "analysisUTCTimestamp": string,
  "lighthouseResult": {
    object (LighthouseResultV5)
  },
  "version": {
    object (PagespeedVersion)
  }
}
فیلدها
kind

string

نوعی نتیجه.

captchaResult

string

کپچا نتیجه را تأیید می کند

id

string

URL متعارف و نهایی برای سند، پس از دنبال کردن تغییر مسیرهای صفحه (در صورت وجود).

loadingExperience

object ( PagespeedApiLoadingExperienceV5 )

معیارهای تجربه بارگیری صفحه کاربران نهایی.

originLoadingExperience

object ( PagespeedApiLoadingExperienceV5 )

معیارهای تجمیع تجربه بارگیری صفحه مبدا

analysisUTCTimestamp

string

مهر زمانی UTC این تحلیل.

lighthouseResult

object ( LighthouseResultV5 )

پاسخ فانوس دریایی برای URL ممیزی به عنوان یک شی.

version

object ( PagespeedVersion )

نسخه PageSpeed ​​مورد استفاده برای تولید این نتایج.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • openid

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

دسته بندی

مقوله های برشماری که باید تحلیل شوند.

Enums
CATEGORY_UNSPECIFIED دسته بندی پیش فرض UNDEFINED.
ACCESSIBILITY دسترس‌پذیری (a11y)، دسته‌بندی مربوط به ظرفیت یک وب‌سایت برای دسترسی به همه کاربران.
BEST_PRACTICES بهترین روش ها، دسته بندی مربوط به انطباق وب سایت با بهترین روش وب.
PERFORMANCE عملکرد، دسته بندی مربوط به عملکرد یک وب سایت.
SEO بهینه سازی موتورهای جستجو (SEO)، دسته بندی مربوط به توانایی یک وب سایت برای نمایه شدن توسط موتورهای جستجو.

استراتژی

استراتژی در حال اجرا دستگاه که در تجزیه و تحلیل استفاده می شود.

Enums
STRATEGY_UNSPECIFIED تعریف نشده
DESKTOP URL را برای مرورگرهای دسکتاپ واکشی و تجزیه و تحلیل کنید.
MOBILE واکشی و تجزیه و تحلیل URL برای دستگاه های تلفن همراه.

PagespeedApiLoadingExperienceV5

شی تجربه بارگیری CrUX که شامل تجزیه و تحلیل داده های CrUX است.

نمایندگی JSON 
{
  "id": string,
  "metrics": {
    string: {
      object (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
فیلدها
id

string

نشانی وب، الگو یا مبدا که معیارها روی آن هستند.

metrics

map (key: string, value: object ( UserPageLoadMetricV5 ))

نقشه <metrics, data>.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

overall_category

string

سرعت قابل خواندن توسط انسان "دسته" شناسه.

initial_url

string

URL درخواستی، که ممکن است با "id" حل شده متفاوت باشد.

origin_fallback

boolean

درست است اگر نتیجه بازگشت مبدأ از یک صفحه باشد، در غیر این صورت نادرست است.

LighthouseResultV5

جسم نتیجه فانوس دریایی.

نمایندگی JSON 
{
  "fetchTime": string,
  "requestedUrl": string,
  "finalUrl": string,
  "lighthouseVersion": string,
  "i18n": {
    object (I18n)
  },
  "userAgent": string,
  "audits": {
    string: {
      object (LighthouseAuditResultV5)
    },
    ...
  },
  "categoryGroups": {
    string: {
      object (CategoryGroupV5)
    },
    ...
  },
  "stackPacks": [
    {
      object (StackPack)
    }
  ],
  "environment": {
    object (Environment)
  },
  "runWarnings": array,
  "runtimeError": {
    object (RuntimeError)
  },
  "categories": {
    object (Categories)
  },
  "timing": {
    object (Timing)
  },
  "configSettings": {
    object (ConfigSettings)
  }
}
فیلدها
fetchTime

string

زمانی که این اجرا واکشی شد.

requestedUrl

string

آدرس اصلی درخواست شده

finalUrl

string

آدرس اینترنتی حل شده نهایی که مورد بازرسی قرار گرفت.

lighthouseVersion

string

نسخه فانوس دریایی که برای تولید این LHR استفاده شد.

i18n

object ( I18n )

رشته های بین المللی سازی که برای ارائه LHR لازم است.

userAgent

string

عامل کاربری که برای اجرای این LHR استفاده شده است.

audits

map (key: string, value: object ( LighthouseAuditResultV5 ))

نقشه ممیزی در LHR.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

categoryGroups

map (key: string, value: object ( CategoryGroupV5 ))

نقشه گروه های دسته بندی در LHR.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

stackPacks[]

object ( StackPack )

رشته های مشاوره Stack Pack.

environment

object ( Environment )

تنظیمات محیطی که هنگام ساخت این LHR استفاده شد.

runWarnings

array ( ListValue format)

لیست تمام هشدارهای اجرا شده در LHR. همیشه حداقل به [] خروجی می دهد.

runtimeError

object ( RuntimeError )

یک پیام خطای سطح بالا که در صورت وجود، نشان‌دهنده یک مشکل جدی است که ممکن است لازم باشد این نتیجه Lighthouse نادیده گرفته شود.

categories

object ( Categories )

نقشه دسته ها در LHR.

timing

object ( Timing )

اطلاعات زمان برای این LHR.

configSettings

object ( ConfigSettings )

تنظیمات پیکربندی این LHR.

I18n

پیام حاوی اطلاعات i18n برای LHR - نسخه 1.

نمایندگی JSON 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
فیلدها
rendererFormattedStrings

object ( RendererFormattedStrings )

رشته های بین المللی شده ای که در تنظیمات تنظیمات بر اساس محلی قالب بندی شده اند.

RendererFormattedStrings

پیامی که رشته های قالب بندی شده استفاده شده در رندر را نگه می دارد.

نمایندگی JSON 
{
  "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
}
فیلدها
varianceDisclaimer

string

سلب مسئولیت در زیر یک مقدار متریک عملکرد نشان داده شده است.

opportunityResourceColumnLabel

string

عنوان فرصت تخمینی صرفه جویی در بارگذاری صفحه یک ممیزی.

opportunitySavingsColumnLabel

string

عنوان صرفه جویی در بارگذاری صفحه در ممیزی فرصت.

errorMissingAuditInfo

string

رشته خطا در کنار ممیزی خطا نشان داده شده است.

errorLabel

string

برچسبی که در کنار یک حسابرسی یا معیاری که دارای خطا است نشان داده شده است.

warningHeader

string

برچسبی که در بالا لیستی از هشدارها نشان داده شده است.

auditGroupExpandTooltip

string

متن راهنمای ابزار روی نماد شورون قابل ارتقا.

passedAuditsGroupTitle

string

عنوانی که در بالای فهرستی از ممیزی هایی که در حال تصویب هستند نشان داده شده است.

notApplicableAuditsGroupTitle

string

عنوان نشان داده شده در بالا فهرستی از ممیزی هایی است که برای یک صفحه اعمال نمی شود.

manualAuditsGroupTitle

string

عنوان در بالا فهرستی از ممیزی هایی که در مرحله اجرا کامپیوتری نشده اند نشان داده شده است.

toplevelWarningsMessage

string

برچسب قبل از هشدارهای مهم نشان داده شده است که ممکن است کل گزارش را باطل کرده باشد.

scorescaleLabel

string

برچسبی که امتیاز را توضیح می دهد، مقیاس سنج (0-49، 50-89، 90-100) را نشان می دهد.

crcLongestDurationLabel

string

برچسب مقادیر نشان داده شده در خلاصه زنجیره های درخواست بحرانی.

crcInitialNavigation

string

برچسب درخواست اولیه در یک زنجیره درخواست بحرانی.

lsPerformanceCategoryDescription

string

سلب مسئولیت در زیر عملکرد نشان داده شده است و توضیح می دهد که شبکه می تواند متفاوت باشد.

labDataTitle

string

عنوان دسته عملکرد داده های آزمایشگاهی.

StackPack

پیام حاوی اطلاعات Stack Pack.

نمایندگی JSON 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
فیلدها
id

string

شناسه بسته پشته.

title

string

عنوان بسته پشته.

iconDataURL

string

نماد بسته پشته داده uri.

descriptions

map (key: string, value: string)

رشته های مشاوره بسته پشته.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

محیط زیست

پیام حاوی پیکربندی محیط برای اجرای Lighthouse.

نمایندگی JSON 
{
  "networkUserAgent": string,
  "hostUserAgent": string,
  "benchmarkIndex": number
}
فیلدها
networkUserAgent

string

رشته عامل کاربر که از طریق شبکه ارسال شده است.

hostUserAgent

string

رشته عامل کاربر نسخه کروم استفاده شده.

benchmarkIndex

number

عدد شاخص بنچمارک که کلاس دستگاه را نشان می‌دهد.

خطای زمان اجرا

پیام حاوی پیکربندی خطای زمان اجرا.

نمایندگی JSON 
{
  "code": string,
  "message": string
}
فیلدها
code

string

کد خطای فانوس دریایی شمارش شده.

message

string

یک پیام قابل خواندن توسط انسان که کد خطا را توضیح می دهد.

دسته بندی ها

دسته بندی ها در یک فانوس دریایی اجرا می شوند.

نمایندگی JSON 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
فیلدها
accessibility

object ( LighthouseCategoryV5 )

دسته دسترس‌پذیری، شامل همه ممیزی‌های مربوط به دسترسی است.

best-practices

object ( LighthouseCategoryV5 )

دسته بهترین شیوه‌ها، شامل تمام ممیزی‌های مرتبط با بهترین شیوه‌ها.

seo

object ( LighthouseCategoryV5 )

دسته بندی بهینه سازی موتورهای جستجو (SEO) که شامل تمام ممیزی های مربوط به سئو می باشد.

performance

object ( LighthouseCategoryV5 )

دسته عملکرد، شامل تمام ممیزی های مربوط به عملکرد است.

Lighthouse CategoryV5

دسته فانوس دریایی.

نمایندگی JSON 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
فیلدها
id

string

شناسه رشته دسته.

title

string

نام انسان پسند دسته.

description

string

توضیح دقیق تر از مقوله و اهمیت آن.

manualDescription

string

شرحی برای ممیزی های دستی در دسته.

auditRefs[]

object ( AuditRefs )

مجموعه ای از ارجاعات به همه اعضای حسابرسی این دسته.

score

value ( Value format)

امتیاز کلی دسته، میانگین وزنی تمام ممیزی های آن. (امتیاز دسته، می تواند صفر باشد.)

AuditRefs

یک ارجاع سبک به ممیزی با شناسه، که برای گروه بندی و وزن ممیزی در یک دسته خاص استفاده می شود.

نمایندگی JSON 
{
  "id": string,
  "weight": number,
  "group": string
}
فیلدها
id

string

شناسه مرجع حسابرسی

weight

number

وزنی که امتیاز این ممیزی بر نمره کلی دسته دارد.

group

string

گروه دسته ای که حسابرسی به آن تعلق دارد (اختیاری).

زمان بندی

پیام حاوی داده های زمان بندی عملکرد برای اجرای Lighthouse.

نمایندگی JSON 
{
  "total": number
}
فیلدها
total

number

کل مدت اجرای فانوس.

تنظیمات پیکربندی

پیام حاوی تنظیمات پیکربندی برای اجرای Lighthouse.

نمایندگی JSON 
{
  "onlyCategories": value,
  "emulatedFormFactor": string,
  "locale": string,
  "channel": string,
  "formFactor": string
}
فیلدها
onlyCategories

value ( Value format)

فهرست دسته بندی های ممیزی که اجرا باید انجام دهد.

emulatedFormFactor
(deprecated)

string

فاکتور شکلی که شبیه سازی باید استفاده کند. این فیلد منسوخ شده است، به جای آن باید از formFactor استفاده شود.

locale

string

تنظیمات محلی.

channel

string

Lighthouse چگونه اجرا شد، به عنوان مثال از افزونه Chrome یا از ماژول npm.

formFactor

string

چگونه Lighthouse باید این اجرا را با توجه به امتیازدهی معیارهای عملکرد و نادیده گرفتن تست‌های تلفن همراه در دسکتاپ تفسیر کند.

PagespeedVersion

شیء Pagespeed Version.

نمایندگی JSON 
{
  "major": string,
  "minor": string
}
فیلدها
major

string

شماره نسخه اصلی PageSpeed ​​برای تولید این نتایج استفاده شده است.

minor

string

شماره نسخه جزئی PageSpeed ​​که برای تولید این نتایج استفاده شده است.