Pagespeedapi: runpagespeed

指定された URL のページに対して PageSpeed 分析を実行し、PageSpeed スコア、ページの読み込み速度を上げるための提案リスト、その他の情報を返します。 実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名	値	説明
必須のクエリ パラメータ
url	string	取得して分析するための URL
省略可能なクエリ パラメータ
category	string	実行する Lighthouse のカテゴリ。指定しない場合、パフォーマンス カテゴリのみが実行されます。 有効な値は次のとおりです。 "accessibility" "best-practices" "performance" "pwa" "seo"
locale	string	書式設定された結果のローカライズに使用される言語 / 地域
strategy	string	使用する分析戦略（パソコンまたはモバイル）。デフォルトはパソコンです。 指定できる値は次のとおりです。 "desktop": パソコン ブラウザ用に URL を取得して分析します 「mobile」: モバイル デバイス用に URL を取得して分析します
utm_campaign	string	分析用のキャンペーン名。
utm_source	string	分析用のキャンペーン ソース。

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "captchaResult": string,
  "kind": "pagespeedonline#result",
  "id": string,
  "loadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "originLoadingExperience": {
    "id": string,
    "metrics": {
      (key): {
        "percentile": integer,
        "distributions": [
          {
            "min": integer,
            "max": integer,
            "proportion": double
          }
        ],
        "category": string
      }
    },
    "overall_category": string,
    "initial_url": string
  },
  "lighthouseResult": {
    "requestedUrl": string,
    "finalUrl": string,
    "lighthouseVersion": string,
    "userAgent": string,
    "fetchTime": string,
    "environment": {
      "networkUserAgent": string,
      "hostUserAgent": string,
      "benchmarkIndex": double
    },
    "runWarnings": [
      (value)
    ],
    "configSettings": {
      "emulatedFormFactor": string,
      "locale": string,
      "onlyCategories": (value),
      "onlyCategories": (value)
    },
    "audits": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "scoreDisplayMode": string,
        "displayValue": string,
        "explanation": string,
        "errorMessage": string,
        "warnings": (value),
        "warnings": (value),
        "details": {
          (key): (value)
        }
      }
    },
    "categories": {
      (key): {
        "id": string,
        "title": string,
        "description": string,
        "score": (value),
        "score": (value),
        "manualDescription": string,
        "auditRefs": [
          {
            "id": string,
            "weight": double,
            "group": string
          }
        ]
      }
    },
    "categoryGroups": {
      (key): {
        "title": string,
        "description": string
      }
    },
    "runtimeError": {
      "code": string,
      "message": string
    },
    "timing": {
      "total": double
    },
    "i18n": {
      "rendererFormattedStrings": {
        "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
      }
    }
  },
  "analysisUTCTimestamp": string,
  "version": {
    "major": integer,
    "minor": integer
  }
}

プロパティ名	値	説明	メモ
captchaResult	string	キャプチャによる検証の結果 使用できる値は次のとおりです。 "CAPTCHA_BLOCKING" "CAPTCHA_MATCHED" "CAPTCHA_NEEDED" "CAPTCHA_NOT_NEEDED" "CAPTCHA_UNMATCHED"
kind	string	結果の種類。
id	string	ドキュメントの正規 URL と最終ページ URL（ページのリダイレクトがある場合）。
loadingExperience	nested object	エンドユーザーのページ読み込みエクスペリエンスの指標。
loadingExperience.id	string	指標が存在する URL、パターン、またはオリジン。
loadingExperience.metrics	object
loadingExperience.metrics.(key)	object	指標のタイプ。
loadingExperience.metrics.(key).distributions[]	list
loadingExperience.metrics.(key).distributions[].min	integer
loadingExperience.metrics.(key).distributions[].max	integer
loadingExperience.metrics.(key).distributions[].proportion	double
version	object	この検索結果の表示に使用された PageSpeed のバージョンです。
version.major	integer	この検索結果の生成に使用された PageSpeed のメジャー バージョン番号です。
version.minor	integer	これらの結果の生成に使用された PageSpeed のマイナー バージョン番号です。
loadingExperience.metrics.(key).category	string	有効な値は次のとおりです。 "AVERAGE" "FAST" "NONE" "SLOW"
loadingExperience.overall_category	string	有効な値は次のとおりです。 "AVERAGE" "FAST" "NONE" "SLOW"
loadingExperience.initial_url	string
loadingExperience.metrics.(key).percentile	integer
originLoadingExperience	nested object	オリジンの集計ページ読み込みエクスペリエンスの指標
originLoadingExperience.id	string	指標が存在する URL、パターン、またはオリジン。
originLoadingExperience.metrics	object
originLoadingExperience.metrics.(key)	object	指標のタイプ。
originLoadingExperience.metrics.(key).percentile	integer
originLoadingExperience.metrics.(key).distributions[]	list
originLoadingExperience.metrics.(key).distributions[].min	integer
originLoadingExperience.metrics.(key).distributions[].max	integer
originLoadingExperience.metrics.(key).distributions[].proportion	double
originLoadingExperience.metrics.(key).category	string	有効な値は次のとおりです。 "AVERAGE" "FAST" "NONE" "SLOW"
originLoadingExperience.overall_category	string	有効な値は次のとおりです。 "AVERAGE" "FAST" "NONE" "SLOW"
originLoadingExperience.initial_url	string
analysisUTCTimestamp	string	この分析の UTC タイムスタンプ。
lighthouseResult	nested object	監査 URL に対するオブジェクトとしての Lighthouse のレスポンス。
lighthouseResult.requestedUrl	string	リクエストされた元の URL。
lighthouseResult.finalUrl	string	監査対象となった最終的な解決 URL。
lighthouseResult.lighthouseVersion	string	この LHR の作成に使用された灯台のバージョン。
lighthouseResult.userAgent	string	この LHR の実行に使用されたユーザー エージェント。
lighthouseResult.fetchTime	string	この実行が取得された時刻。
lighthouseResult.environment	object	この LHR の作成時に使用された環境設定。
lighthouseResult.environment.networkUserAgent	string
lighthouseResult.environment.hostUserAgent	string
lighthouseResult.environment.benchmarkIndex	double
lighthouseResult.runWarnings[]	list	LHR に表示されるすべての実行警告のリスト。常に少なくとも「[]」に出力されます。
lighthouseResult.configSettings	object	この LHR の設定。
lighthouseResult.configSettings.emulatedFormFactor	string	エミュレーションで使用するフォーム ファクタ。 有効な値は次のとおりです。 "UNKNOWN_FORM_FACTOR" "desktop" "mobile" "none"
lighthouseResult.configSettings.locale	string	言語 / 地域の設定
lighthouseResult.configSettings.onlyCategories	nested object
lighthouseResult.audits	object	LHR の監査のマップ。
lighthouseResult.audits.(key)	nested object
lighthouseResult.audits.(key).id	string	監査の ID。
lighthouseResult.audits.(key).title	string	人が読める形式のタイトル。
lighthouseResult.audits.(key).description	string	監査の説明。
lighthouseResult.audits.(key).score	nested object
lighthouseResult.audits.(key).scoreDisplayMode	string	列挙型スコア表示モード。 有効な値は次のとおりです。 "SCORE_DISPLAY_MODE_UNSPECIFIED" "binary" "error" "informative" "manual" "not_applicable" "numeric"
lighthouseResult.audits.(key).displayValue	string	この監査の UI に表示される値。
lighthouseResult.audits.(key).explanation	string	監査でのエラーの説明。
lighthouseResult.audits.(key).errorMessage	string	監査内でスローされたエラーからのエラー メッセージ。
lighthouseResult.audits.(key).warnings	nested object
lighthouseResult.audits.(key).details	object	監査の自由形式の詳細セクション。
lighthouseResult.audits.(key).details.(key)	any value
lighthouseResult.categories	object	LHR のカテゴリのマップ。
lighthouseResult.categories.(key)	nested object
lighthouseResult.categories.(key).id	string	カテゴリの文字列識別子。
lighthouseResult.categories.(key).title	string	わかりやすいカテゴリ名です
lighthouseResult.categories.(key).description	string	カテゴリとその重要性の詳しい説明。
lighthouseResult.categories.(key).score	nested object
lighthouseResult.categories.(key).manualDescription	string	カテゴリの手動監査の説明。
lighthouseResult.categories.(key).auditRefs[]	list	このカテゴリのすべての監査メンバーへの参照の配列。
lighthouseResult.categories.(key).auditRefs[].id	string	監査参照 ID。
lighthouseResult.categories.(key).auditRefs[].weight	double	この監査のスコアがカテゴリスコア全体に対する重み付け。
lighthouseResult.categories.(key).auditRefs[].group	string	監査が属するカテゴリ グループ（省略可）。
lighthouseResult.categoryGroups	object	LHR のカテゴリ グループのマップ。
lighthouseResult.categoryGroups.(key)	object
lighthouseResult.categoryGroups.(key).title	string
lighthouseResult.categoryGroups.(key).description	string
lighthouseResult.runtimeError	object	スローされたランタイム エラーのコードとメッセージを含むオブジェクト。
lighthouseResult.runtimeError.code	string	有効な値は次のとおりです。 "ERRORED_DOCUMENT_REQUEST" "FAILED_DOCUMENT_REQUEST" "INSECURE_DOCUMENT_REQUEST" "INVALID_SPEEDLINE" "NO_DCL" "NO_DOCUMENT_REQUEST" "NO_ERROR" "NO_FCP" "NO_NAVSTART" "NO_SCREENSHOTS" "NO_SPEEDLINE_FRAMES" "NO_TRACING_STARTED" "PARSING_PROBLEM" "PROTOCOL_TIMEOUT" "READ_FAILED" "SPEEDINDEX_OF_ZERO" "TRACING_ALREADY_STARTED" "UNKNOWN_ERROR"
lighthouseResult.runtimeError.message	string
lighthouseResult.timing	object	この LHR の時間情報。
lighthouseResult.timing.total	double	Lighthouse の実行時間の合計
lighthouseResult.i18n	object	LHR のレンダリングに必要な国際化文字列。
lighthouseResult.i18n.rendererFormattedStrings	object
lighthouseResult.i18n.rendererFormattedStrings.varianceDisclaimer	string
lighthouseResult.i18n.rendererFormattedStrings.opportunityResourceColumnLabel	string
lighthouseResult.i18n.rendererFormattedStrings.opportunitySavingsColumnLabel	string
lighthouseResult.i18n.rendererFormattedStrings.errorMissingAuditInfo	string
lighthouseResult.i18n.rendererFormattedStrings.errorLabel	string
lighthouseResult.i18n.rendererFormattedStrings.warningHeader	string
lighthouseResult.i18n.rendererFormattedStrings.auditGroupExpandTooltip	string
lighthouseResult.i18n.rendererFormattedStrings.passedAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.notApplicableAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.manualAuditsGroupTitle	string
lighthouseResult.i18n.rendererFormattedStrings.toplevelWarningsMessage	string
lighthouseResult.i18n.rendererFormattedStrings.scorescaleLabel	string
lighthouseResult.i18n.rendererFormattedStrings.crcLongestDurationLabel	string
lighthouseResult.i18n.rendererFormattedStrings.crcInitialNavigation	string
lighthouseResult.i18n.rendererFormattedStrings.lsPerformanceCategoryDescription	string
lighthouseResult.i18n.rendererFormattedStrings.labDataTitle	string

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。