Method: pagespeedapi.runpagespeed

对位于指定网址的网页运行 PageSpeed 分析，并返回 PageSpeed 得分、提升网页加载速度的建议列表以及其他信息。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
category

enum (Category)

要运行的 Lighthouse 类别；如果未指定任何类别，系统将仅运行“Performance”类别
locale

string

用于本地化格式化结果的语言区域
strategy

enum (Strategy)

要使用的分析策略（桌面设备或移动设备），默认桌面设备为桌面设备
url

string

必需。要提取和分析的网址
utm_campaign

string

用于分析的广告系列名称。
utm_source

string

用于分析的广告系列来源。
captchaToken

string

填写人机识别系统时传递的人机识别系统令牌。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

Pagespeed API 响应对象。

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

经过网页重定向（如有）后的规范化和最终到达网址。
loadingExperience

object (PagespeedApiLoadingExperienceV5)

最终用户的网页加载体验指标。
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

来源的汇总网页加载体验指标
analysisUTCTimestamp

string

此分析的世界协调时间 (UTC) 时间戳。
lighthouseResult

object (LighthouseResultV5)

将审核网址作为对象的 Lighthouse 响应。
version

object (PagespeedVersion)

生成这些结果时所用的 PageSpeed 版本。

授权范围

需要以下 OAuth 作用域：

  • openid

有关详情，请参阅 OAuth 2.0 概览。

Category

应分析的枚举类别。

枚举
CATEGORY_UNSPECIFIED 默认的 UNDEFINED 类别。
ACCESSIBILITY 无障碍 (a11y)，类别涉及到网站可供所有用户访问的能力。
BEST_PRACTICES 最佳做法，即网站遵循网络最佳做法的类别。
PERFORMANCE 效果，与网站性能相关的类别。
PWA 渐进式 Web 应用 (PWA)，与网站作为 PWA 运行的能力相关的类别。
SEO 搜索引擎优化 (SEO)，这是一个与网站被搜索引擎编入索引的能力相关的类别。

策略

要在分析中使用的设备运行策略。

枚举
STRATEGY_UNSPECIFIED UNDEFINED。
DESKTOP 获取并分析桌面浏览器的网址。
MOBILE 获取并分析移动设备的网址。

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

ID 的人类可读速度“类别”。
initial_url

string

请求的网址，可能与解析的“id”不同。
origin_fallback

boolean

如果结果是网页的源站回退，则返回 true，否则返回 false。

LighthouseResultV5

Lighthouse 结果对象。

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)

堆栈包建议字符串。
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 的配置设置。

本地化

包含 LHR - Version 1 的国际化数据的消息。

JSON 表示法 
{
  "rendererFormattedStrings": {
    object (RendererFormattedStrings)
  }
}
字段
rendererFormattedStrings

object (RendererFormattedStrings)

国际化字符串，格式化为 configSettings 中的语言区域。

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

可展开的 V 形图标上的提示文本。
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

包含堆栈包信息的消息。

JSON 表示法 
{
  "id": string,
  "title": string,
  "iconDataURL": string,
  "descriptions": {
    string: string,
    ...
  }
}
字段
id

string

堆栈包 ID。
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

所用 Chrome 版本的用户代理字符串。
benchmarkIndex

number

表示粗略的设备类别的基准索引编号。

RuntimeError

包含运行时错误配置的消息。

JSON 表示法 
{
  "code": string,
  "message": string
}
字段
code

string

枚举的 Lighthouse 错误代码。
message

string

解释错误代码的直观易懂的消息。

类别

Lighthouse 中的类别运行。

JSON 表示法 
{
  "accessibility": {
    object (LighthouseCategoryV5)
  },
  "best-practices": {
    object (LighthouseCategoryV5)
  },
  "seo": {
    object (LighthouseCategoryV5)
  },
  "pwa": {
    object (LighthouseCategoryV5)
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
字段
accessibility

object (LighthouseCategoryV5)

无障碍功能类别，包含所有与无障碍功能相关的审核。
best-practices

object (LighthouseCategoryV5)

最佳实践类别，包含所有与最佳实践相关的审计。
seo

object (LighthouseCategoryV5)

搜索引擎优化 (SEO) 类别，包含所有搜索引擎优化 (SEO) 相关审核。
pwa

object (LighthouseCategoryV5)

渐进式 Web 应用 (PWA) 类别，包含所有与 pwa 相关的审核。
performance

object (LighthouseCategoryV5)

性能类别，包含所有与性能相关的审核。

LighthouseCategoryV5

Lighthouse 类别。

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)

相应类别的总体得分，即其所有审核的加权平均值。（类别的得分可以为 null。）

AuditRefs

按 ID 对审核的浅层引用，用于对指定类别中的审核进行分组和权重。

JSON 表示法 
{
  "id": string,
  "weight": number,
  "group": string
}
字段
id

string

审核参考 ID。
weight

number

此项评估的得分在总体类别得分中所占的权重。
group

string

此审核所属的类别群组（可选）。

计时

包含 Lighthouse 运行性能时间数据的消息。

JSON 表示法 
{
  "total": number
}
字段
total

number

Lighthouse 运行的总时长。

ConfigSettings

包含 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 的次要版本号。