Method: pagespeedapi.runpagespeed

指定された URL のページに対して PageSpeed 分析を実行し、PageSpeed スコア、そのページを高速化するための提案のリストなどの情報を返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
category

enum (Category)

実行する Lighthouse カテゴリ。指定しない場合は、パフォーマンス カテゴリのみが実行されます。
locale

string

書式設定された結果のローカライズに使用される言語 / 地域
strategy

enum (Strategy)

使用する分析戦略（パソコンまたはモバイル）（デフォルトはパソコン）
url

string

必須。取得して分析する URL
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

ページのリダイレクト後のドキュメントの正規化された最終ページ URL（ある場合）。
loadingExperience

object (PagespeedApiLoadingExperienceV5)

エンドユーザーのページ読み込みエクスペリエンスの指標。
originLoadingExperience

object (PagespeedApiLoadingExperienceV5)

オリジンのページ読み込みエクスペリエンスの集計指標
analysisUTCTimestamp

string

この分析の UTC タイムスタンプ。
lighthouseResult

object (LighthouseResultV5)

オブジェクトとしての監査 URL に対する Lighthouse のレスポンス。
version

object (PagespeedVersion)

これらの結果の生成に使用した 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 (UserPageLoadMetricV5)
    },
    ...
  },
  "overall_category": string,
  "initial_url": string,
  "origin_fallback": boolean
}
フィールド
id

string

指標が存在する URL、パターン、またはオリジン。
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

リクエストされた URL。解決された「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

リクエストされた元の URL。
finalUrl

string

監査対象の最終的な解決 URL。
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 の構成設定。

国際化

LHR - バージョン 1 の i18n データを含むメッセージ。

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

展開可能なシェブロン アイコンのツールチップ テキスト。
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

Stackpack アイコンのデータ 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)
  },
  },
  "performance": {
    object (LighthouseCategoryV5)
  }
}
フィールド
accessibility

object (LighthouseCategoryV5)

ユーザー補助カテゴリ。ユーザー補助に関連するすべての監査が含まれます。
best-practices

object (LighthouseCategoryV5)

監査に関連するすべてのベスト プラクティスを含む、ベスト プラクティスのカテゴリ。
seo

object (LighthouseCategoryV5)

SEO 関連のすべての監査を含む、検索エンジン最適化（SEO）カテゴリ。
performance

object (LighthouseCategoryV5)

パフォーマンスに関連するすべての監査を含むパフォーマンス カテゴリ。

LighthouseCategoryV5

Lighthouse のカテゴリ。

JSON 表現 
{
  "id": string,
  "title": string,
  "description": string,
  "manualDescription": string,
  "auditRefs": [
    {
      object (AuditRefs)
    }
  ],
  "score": value
}
フィールド
id

string

カテゴリの文字列 ID。
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 のマイナー バージョン番号です。