指定された URL のページに対して PageSpeed 分析を実行し、PageSpeed スコア、そのページを高速化するための提案のリストなどの情報を返します。
HTTP リクエスト
GET https://pagespeedonline.googleapis.com/pagespeedonline/v5/runPagespeed
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
category |
実行する Lighthouse カテゴリ。指定しない場合は、パフォーマンス カテゴリのみが実行されます。 |
locale |
書式設定された結果のローカライズに使用される言語 / 地域 |
strategy |
使用する分析戦略(パソコンまたはモバイル)(デフォルトはパソコン) |
url |
必須。取得して分析する URL |
utm_campaign |
分析用のキャンペーン名。 |
utm_source |
分析用のキャンペーン ソース。 |
captchaToken |
キャプチャの入力時に渡されるキャプチャ トークン。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
Pagespeed API レスポンス オブジェクト。
JSON 表現 | |
---|---|
{ "kind": string, "captchaResult": string, "id": string, "loadingExperience": { object ( |
フィールド | |
---|---|
kind |
結果の種類。 |
captchaResult |
キャプチャ検証の結果 |
id |
ページのリダイレクト後のドキュメントの正規化された最終ページ URL(ある場合)。 |
loadingExperience |
エンドユーザーのページ読み込みエクスペリエンスの指標。 |
originLoadingExperience |
オリジンのページ読み込みエクスペリエンスの集計指標 |
analysisUTCTimestamp |
この分析の UTC タイムスタンプ。 |
lighthouseResult |
オブジェクトとしての監査 URL に対する Lighthouse のレスポンス。 |
version |
これらの結果の生成に使用した PageSpeed のバージョン。 |
認可スコープ
次の OAuth スコープが必要です。
openid
詳細については、OAuth 2.0 の概要をご覧ください。
カテゴリ
分析対象の列挙カテゴリ。
列挙型 | |
---|---|
CATEGORY_UNSPECIFIED |
デフォルトの UNDEFINED カテゴリ。 |
ACCESSIBILITY |
アクセシビリティ(a11y)は、ウェブサイトのアクセシビリティに関するカテゴリで、すべてのユーザーがアクセスできます。 |
BEST_PRACTICES |
ベスト プラクティス、ウェブのベスト プラクティスへのウェブサイトの適合性に関するカテゴリ。 |
PERFORMANCE |
パフォーマンス: ウェブサイトのパフォーマンスに関連するカテゴリ。 |
SEO |
検索エンジン最適化(SEO)。検索エンジンがインデックスに登録するウェブサイトの機能に関連するカテゴリです。 |
戦略
分析で使用するデバイス実行方法。
列挙型 | |
---|---|
STRATEGY_UNSPECIFIED |
未定義。 |
DESKTOP |
パソコンのブラウザで URL を取得して分析します。 |
MOBILE |
モバイル デバイスの URL を取得して分析します。 |
PagespeedApiLoadingExperienceV5
CrUX データの内訳を含む CrUX 読み込みエクスペリエンス オブジェクト。
JSON 表現 | |
---|---|
{
"id": string,
"metrics": {
string: {
object ( |
フィールド | |
---|---|
id |
指標が存在する URL、パターン、またはオリジン。 |
metrics |
<metrics, data> のマップ。
|
overall_category |
ID の人が読める形式の速度「カテゴリ」。 |
initial_url |
リクエストされた URL。解決された「id」とは異なる場合があります。 |
origin_fallback |
結果がページからのオリジンの代替である場合は true、そうでない場合は false です。 |
LighthouseResultV5
Lighthouse の結果オブジェクト。
JSON 表現 | |
---|---|
{ "fetchTime": string, "requestedUrl": string, "finalUrl": string, "lighthouseVersion": string, "i18n": { object ( |
フィールド | |
---|---|
fetchTime |
この実行が取得された時刻。 |
requestedUrl |
リクエストされた元の URL。 |
finalUrl |
監査対象の最終的な解決 URL。 |
lighthouseVersion |
この LHR の生成に使用された灯台のバージョン。 |
i18n |
LHR のレンダリングに必要な国際化文字列。 |
userAgent |
この LHR の実行に使用されたユーザー エージェント。 |
audits |
LHR の監査のマップ。
|
categoryGroups |
LHR のカテゴリ グループのマップ。
|
stackPacks[] |
Stack Pack アドバイス文字列。 |
environment |
この LHR の作成時に使用した環境設定。 |
runWarnings |
LHR 内のすべての実行警告のリスト。常に少なくとも |
runtimeError |
トップレベルのエラー メッセージ。存在する場合は、この Lighthouse の結果を破棄する必要があるほど重大な問題があることを示します。 |
categories |
LHR のカテゴリのマップ。 |
timing |
この LHR のタイミング情報。 |
configSettings |
この LHR の構成設定。 |
国際化
LHR - バージョン 1 の i18n データを含むメッセージ。
JSON 表現 | |
---|---|
{
"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 |
パフォーマンス指標の値の下に表示される免責条項。 |
opportunityResourceColumnLabel |
監査によって推定されるページ読み込みの削減機会の見出し。 |
opportunitySavingsColumnLabel |
オポチュニティの監査によって削減される推定ページ読み込みの見出し。 |
errorMissingAuditInfo |
エラー監査の横に表示されるエラー文字列。 |
errorLabel |
エラーが発生した監査または指標の横に表示されるラベル。 |
warningHeader |
警告の箇条書きの上に表示されるラベル。 |
auditGroupExpandTooltip |
展開可能なシェブロン アイコンのツールチップ テキスト。 |
passedAuditsGroupTitle |
合格している監査のリストの上に表示される見出し。 |
notApplicableAuditsGroupTitle |
ページに適用されない監査のリストの上に表示される見出し。 |
manualAuditsGroupTitle |
上部に表示される見出しは、実行時にコンピュータで処理されなかった監査のリストです。 |
toplevelWarningsMessage |
重要な警告の前に表示されたラベルが原因で、レポート全体が無効化されている可能性があります。 |
scorescaleLabel |
スコアを説明するラベルは、スケール(0 ~ 49、50 ~ 89、90 ~ 100)を測定します。 |
crcLongestDurationLabel |
重要なリクエスト チェーンの概要に表示される値のラベル。 |
crcInitialNavigation |
クリティカル リクエスト チェーンの最初のリクエストのラベル。 |
lsPerformanceCategoryDescription |
パフォーマンスの下に表示される免責条項。ネットワークによって異なる可能性があることを説明します。 |
labDataTitle |
ラボデータのパフォーマンス カテゴリのタイトル。 |
StackPack
スタックパック情報を含むメッセージ。
JSON 表現 | |
---|---|
{ "id": string, "title": string, "iconDataURL": string, "descriptions": { string: string, ... } } |
フィールド | |
---|---|
id |
スタックパック ID。 |
title |
スタックパックのタイトル。 |
iconDataURL |
Stackpack アイコンのデータ URI。 |
descriptions |
スタックパックのアドバイス文字列。
|
環境
Lighthouse 実行の環境設定を含むメッセージ。
JSON 表現 | |
---|---|
{ "networkUserAgent": string, "hostUserAgent": string, "benchmarkIndex": number } |
フィールド | |
---|---|
networkUserAgent |
ネットワーク経由で送信されたユーザー エージェント文字列。 |
hostUserAgent |
使用している Chrome バージョンのユーザー エージェント文字列。 |
benchmarkIndex |
大まかなデバイスクラスを示すベンチマーク インデックス番号。 |
RuntimeError
ランタイム エラー構成を含むメッセージ。
JSON 表現 | |
---|---|
{ "code": string, "message": string } |
フィールド | |
---|---|
code |
Lighthouse の列挙エラーコード。 |
message |
エラーコードを説明する、人が読める形式のメッセージ。 |
カテゴリ
Lighthouse の実行のカテゴリ。
JSON 表現 | |
---|---|
{ "accessibility": { object ( |
フィールド | |
---|---|
accessibility |
ユーザー補助カテゴリ。ユーザー補助に関連するすべての監査が含まれます。 |
best-practices |
監査に関連するすべてのベスト プラクティスを含む、ベスト プラクティスのカテゴリ。 |
seo |
SEO 関連のすべての監査を含む、検索エンジン最適化(SEO)カテゴリ。 |
performance |
パフォーマンスに関連するすべての監査を含むパフォーマンス カテゴリ。 |
LighthouseCategoryV5
Lighthouse のカテゴリ。
JSON 表現 | |
---|---|
{
"id": string,
"title": string,
"description": string,
"manualDescription": string,
"auditRefs": [
{
object ( |
フィールド | |
---|---|
id |
カテゴリの文字列 ID。 |
title |
人間が理解しやすいカテゴリ名です。 |
description |
カテゴリとその重要度の詳細な説明。 |
manualDescription |
カテゴリの手動監査の説明。 |
auditRefs[] |
このカテゴリのすべての監査メンバーへの参照の配列。 |
score |
カテゴリの全体的なスコア(すべての監査の加重平均)。(カテゴリのスコア。null の場合もあります)。 |
AuditRefs
ID による監査の簡易参照で、特定のカテゴリの監査をグループ化して重み付けするために使用されます。
JSON 表現 | |
---|---|
{ "id": string, "weight": number, "group": string } |
フィールド | |
---|---|
id |
監査参照 ID。 |
weight |
この監査のスコアがカテゴリ全体のスコアに与える影響の重み付け。 |
group |
監査が属するカテゴリ グループ(省略可)。 |
タイミング
Lighthouse 実行のパフォーマンス時間データを含むメッセージです。
JSON 表現 | |
---|---|
{ "total": number } |
フィールド | |
---|---|
total |
Lighthouse の実行時間の合計。 |
ConfigSettings
Lighthouse 実行の構成設定を含むメッセージ。
JSON 表現 | |
---|---|
{ "onlyCategories": value, "emulatedFormFactor": string, "locale": string, "channel": string, "formFactor": string } |
フィールド | |
---|---|
onlyCategories |
実行で実施する必要がある監査のカテゴリのリスト。 |
emulatedFormFactor |
エミュレーションで使用するフォーム ファクタ。このフィールドは非推奨です。代わりに formFactor を使用してください。 |
locale |
言語 / 地域の設定。 |
channel |
Lighthouse の実行方法(Chrome 拡張機能や npm モジュールなど) |
formFactor |
Lighthouse では、パフォーマンス指標のスコア判定と、パソコンでのモバイル専用テストのスキップに関して、この実行をどのように解釈すべきか。 |
PagespeedVersion
Pagespeed Version オブジェクト。
JSON 表現 | |
---|---|
{ "major": string, "minor": string } |
フィールド | |
---|---|
major |
これらの結果の生成に使用された PageSpeed のメジャー バージョン番号です。 |
minor |
これらの結果の生成に使用された PageSpeed のマイナー バージョン番号です。 |