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 と最終ページ 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 パフォーマンス: ウェブサイトのパフォーマンスに関連するカテゴリです。
PWA プログレッシブ ウェブアプリ（PWA）。ウェブサイトを PWA として実行する機能に関連するカテゴリです。
SEO 検索エンジン最適化（SEO）。検索エンジンのインデックスに登録されるウェブサイトの機能に関連するカテゴリです。

戦略

分析で使用するデバイス実行戦略。

列挙型
STRATEGY_UNSPECIFIED UNDEFINED（未定義）。
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

スタックパック アイコンのデータ 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

エラーコードを説明する、人が読める形式のメッセージ。

Categories

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)

プログレッシブ ウェブアプリ（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 のマイナー バージョン番号です。