CrUX API

CrUX API では、集計された実際のユーザー エクスペリエンス データに、ページとオリジンの粒度で低レイテンシでアクセスできます。

一般的なユースケース

CrUX API を使用すると、「https://example.com オリジンの指標を取得」など、特定の URI のユーザー エクスペリエンス指標をクエリできます。

CrUX API キー

CrUX API を使用するには、Google Cloud API キーが必要です。[認証情報] ページで認証情報を作成し、Chrome UX Report API で使用できるようにプロビジョニングできます。

API キーを作成すると、アプリケーションですべてのリクエスト URL にクエリ パラメータ key=[YOUR_API_KEY] を追加できます。クエリの例をご覧ください。

API キーは URL に埋め込んでも安全です。エンコーディングの必要はありません。

データモデル

このセクションでは、リクエストとレスポンスのデータ構造について詳しく説明します。

記録

ページまたはサイトに関する個別の情報。レコードには、識別子と特定のディメンションの組み合わせに固有のデータを含めることができます。レコードには、1 つ以上の指標のデータを含めることができます。

識別子

識別子は、検索するレコードを指定します。CrUX では、これらの識別子はウェブページとウェブサイトです。

起源

識別子がオリジンの場合、そのオリジンの全ページに存在するすべてのデータが集約されます。たとえば、http://www.example.com オリジンに次のサイトマップで記述されたページがあるとします。

http://www.example.com/
http://www.example.com/foo.html
http://www.example.com/bar.html

つまり、オリジンを http://www.example.com に設定して Chrome UX レポートをクエリすると、http://www.example.com/、http://www.example.com/foo.html、http://www.example.com/bar.html のデータはそのオリジンの下にあるすべてのページであるため、まとめて集計されて返されます。

URL

識別子が URL の場合は、その特定の URL のデータのみが返されます。もう一度 http://www.example.com オリジン サイトマップを見てみましょう。

http://www.example.com/
http://www.example.com/foo.html
http://www.example.com/bar.html

識別子が http://www.example.com/foo.html の値を持つ URL に設定されている場合は、そのページのデータのみが返されます。

ディメンション

ディメンションは、レコードの集計対象である特定のデータグループを表します。たとえば、フォーム ファクタが PHONE の場合、レコードにモバイル デバイスで発生した読み込みに関する情報が含まれていることを示します。各ディメンションには特定の数の値が含まれ、そのディメンションが暗黙的に指定されていない場合は、そのディメンションがすべての値に対して集計されることを意味します。たとえば、フォーム ファクタを指定しない場合は、任意のフォーム ファクタで行われた読み込みに関する情報がレコードに含まれていることを示します。

フォーム・ファクタ

エンドユーザーがページに移動するために使用したデバイスクラス。これは、PHONE、TABLET、DESKTOP に分割された一般的なデバイスクラスです。

有効な接続タイプ

有効な接続タイプは、そのページにアクセスしたときにデバイスで推定される接続品質です。これは一般的なクラスで、offline、slow-2G、2G、3G、4G に分割されています。

指標

指標は、統計的集計としてヒストグラム、パーセンタイル、分数でレポートされます。

浮動小数点値は小数点第 4 位に四捨五入されます（cumulative_layout_shift 指標は文字列として二重にエンコードされるため、浮動小数点数とはみなされず、文字列内の小数点以下 2 桁にレポートされます）。

ヒストグラム

指標がヒストグラムで表されている場合は、その指標の特定の範囲に該当するページ読み込みの割合が表示されます。

指標の例の単純な 3 ビンのヒストグラムは次のようになります。

{
  "histogram": [
    {
      "start": 0,
      "end": 1000,
      "density": 0.3818
    },
    {
      "start": 1000,
      "end": 3000,
      "density": 0.4991
    },
    {
      "start": 3000,
      "density": 0.1192
    }
  ]
}

このデータは、ページ読み込みの 38.18% で、サンプル指標が 0 ～ 1,000 ミリ秒の間に測定されたことを示しています。指標の単位はこのヒストグラムに含まれません。この例では、ミリ秒と想定します。

また、ページ読み込みの 49.91% で指標値が 1,000 ～ 3,000 ミリ秒、11.92% で 3,000 ミリ秒を超える値が表示されていました。

パーセンタイル

指標には、詳細な分析に役立つパーセンタイルが含まれている場合もあります。その指標の指定されたパーセンタイルで特定の指標値を報告します。最終的なビニングデータではなく、利用可能なデータ全体に基づいているため、最終的なビニング ヒストグラムに基づく補間されたパーセンタイルと必ずしも一致するわけではありません。

{
  "percentiles": {
    "p75": 2063
  }
}

この例では、ページ読み込みの 75% 以上が指標値 <= 2063 で測定されました。

注: 各パーセンタイルの値は合成によって導き出されたものであり、示された値をユーザーが実際に経験したことを意味するものではなく、ページの読み込みの一部で指標値が指定された値を下回ったことを示すものです。

分数

割合は、特定の方法でラベル付けできるページ読み込みの割合を示します。この場合、指標値はこれらのラベルです。

たとえば、form_factors 指標は、特定のクエリがカバーするフォーム ファクタ（またはデバイス）の内訳をリストする fractions オブジェクトで構成されています。

"form_factors": {
  "fractions": {
    "desktop": 0.0377,
    "tablet": 0.0288,
    "phone": 0.9335
  }
}

この例では、ページ読み込みの 3.77% はパソコンで、2.88% はタブレット、93.35% はスマートフォンで測定され、合計 100% となっています。

指標の値のタイプ

CrUX API の指標名	データ型	メートル法の単位	統計集計	ドキュメント
cumulative_layout_shift	文字列としてエンコードされた小数点以下 2 桁の倍精度	単位なし	3 つのビンがあるヒストグラム、p75 のパーセンタイル	cls
first_contentful_paint	int	ミリ秒	3 つのビンがあるヒストグラム、p75 のパーセンタイル	NFC
first_input_delay （非推奨）	int	ミリ秒	3 つのビンがあるヒストグラム、p75 のパーセンタイル	FID
interaction_to_next_paint	int	ミリ秒	3 つのビンがあるヒストグラム、p75 のパーセンタイル	inp
largest_contentful_paint	int	ミリ秒	3 つのビンがあるヒストグラム、p75 のパーセンタイル	lcp
experimental_time_to_first_byte	int	ミリ秒	3 つのビンがあるヒストグラム、p75 のパーセンタイル	ttfb
form_factors	小数点第 4 位の倍精度	パーセント	フォーム ファクタから割合へのマッピング	フォーム ファクタ
navigation_types	小数点第 4 位の倍精度	パーセント	ナビゲーション タイプから分数へのマッピング	ナビゲーション タイプ

BigQuery 指標名のマッピング

CrUX API の指標名	BigQuery の指標名
cumulative_layout_shift	layout_instability.cumulative_layout_shift
first_contentful_paint	first_contentful_paint
first_input_delay	first_input.delay
interaction_to_next_paint	interaction_to_next_paint
largest_contentful_paint	largest_contentful_paint
experimental_time_to_first_byte	experimental.time_to_first_byte
navigation_types	navigation_types
form_factors	なし

注: CrUX BigQuery では、ヒストグラム密度はフォーム ファクタ全体でオリジンごとに最大 100% 加算されるため、API でサポートされている form_factors 指標は、代わりに first_contentful_paint のヒストグラム密度として表されます。

収集期間

2022 年 10 月の時点で、CrUX API には collectionPeriod オブジェクトが含まれ、firstDate フィールドと endDate フィールドが集計期間の開始日と終了日を表すようになりました。次に例を示します。

    "collectionPeriod": {
      "firstDate": {
        "year": 2022,
        "month": 9,
        "day": 12
      },
      "lastDate": {
        "year": 2022,
        "month": 10,
        "day": 9
      }
    }

これにより、その日のデータがまだ更新されているか、前日と同じデータが返されているかについて、より詳細に把握できます。

CrUX API は、1 日分の完了データを待機するため、今日の日付より約 2 日遅れています。また、API で利用可能になるまでに多少の処理時間がかかります。使用されるタイムゾーンは太平洋標準時（PST）で、夏時間による変更はありません。

クエリの例

クエリは、https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=[YOUR_API_KEY]" への POST リクエストを使用して JSON オブジェクトとして送信されます。POST 本文で、クエリデータを JSON オブジェクトとして指定します。

{
  "origin": "https://example.com",
  "formFactor": "PHONE",
  "metrics": [
    "largest_contentful_paint",
    "experimental_time_to_first_byte"
  ]
}

たとえば、これは次のコマンドラインを使用して curl から呼び出すことができます（API_KEY は実際のキーに置き換えます）。

curl -s --request POST 'https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=API_KEY' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --data '{"formFactor":"PHONE","origin":"https://www.example.com","metrics":["largest_contentful_paint", "experimental_time_to_first_byte"]}'

注: 上記の例は、macOS または Linux ベースのシステム向けです（Windows 用の Git BASH シェルを含む）。システムによっては若干の変更が必要になる場合があります。たとえば、cmd.exe コマンドラインではパラメータに一重引用符や行継続（\）を使用できないため、二重引用符（\" で必要に応じて内側の引用符をエスケープ）を使用し、さらに 1 行を使用する必要があります。

API を介してページレベルのデータを使用するには、クエリで origin ではなく url プロパティを渡します。

{
  "url": "https://example.com/page",
  "formFactor": "PHONE",
  "metrics": [
    "largest_contentful_paint",
    "experimental_time_to_first_byte"
  ]
}

metrics プロパティが設定されていない場合は、使用可能なすべての指標が返されます。

• cumulative_layout_shift
• first_contentful_paint
• first_input_delay （非推奨）
• interaction_to_next_paint
• largest_contentful_paint
• experimental_time_to_first_byte
• navigation_types
• form_factors（リクエストで formFactor が指定されていない場合にのみ報告）

formFactor 値を指定しない場合、すべてのフォーム ファクタで値が集計されます。

クエリのその他の例については、Chrome UX Report API を使用するをご覧ください。

データ パイプライン

CrUX データセットはパイプラインで処理され、データの統合、集計、フィルタリングを行ってから、API で使用できるようになります。

移動平均

Chrome UX レポートのデータは、集計された指標の 28 日間の移動平均です。つまり、ある時点で Chrome UX レポートに表示されるデータは、実際には過去 28 日間のデータを集計したデータであるということです。

これは、BigQuery の CrUX データセットで月次レポートを集計する仕組みに似ています。

毎日の通知

データは毎日 04:00（UTC）頃に更新されます。更新時間に関するサービスレベル契約はなく、ベスト エフォート ベースで毎日実行されます。

注意: 午前 4 時（UTC）頃に更新されてから同じ日内はデータが変わらないため、繰り返し呼び出しても結果は同じになります。

スキーマ

CrUX API には、POST HTTP リクエストを受け入れる単一のエンドポイントがあります。この API は record を返します。これには、リクエストされたオリジンまたはページに関するパフォーマンス データに対応する 1 つ以上の metrics が含まれます。

HTTP リクエスト

POST https://chromeuxreport.googleapis.com/v1/records:queryRecord

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

リクエスト本文

リクエストの本文には、次の構造のデータを含める必要があります。

{
  "effectiveConnectionType": string,
  "formFactor": enum (FormFactor),
  "metrics": [
    string
  ],

  // Union field url_pattern can be only one of the following:
  "origin": string,
  "url": string
  // End of list of possible types for union field url_pattern.
}

フィールド
effectiveConnectionType	string 有効な接続タイプは、レコードのデータが属する有効なネットワーク クラスを指定するクエリ ディメンションです。 このフィールドには、Network Information API 仕様で指定されている値 ["offline", "slow-2G", "2G", "3G", "4G"] が使用されます。 注: 有効な接続タイプが指定されていない場合は、すべての有効な接続タイプの集計データを含む特別なレコードが返されます。
formFactor	enum（FormFactor） フォーム ファクタは、レコードのデータが属するデバイスクラスを指定するクエリ ディメンションです。 このフィールドでは、値 DESKTOP、PHONE、または TABLET を使用します。 注: フォーム ファクタが指定されていない場合は、すべてのフォーム ファクタの集計データを含む特別なレコードが返されます。
metrics[]	string レスポンスに含める必要がある指標。何も指定しない場合は、見つかった指標が返されます。 使用できる値: ["cumulative_layout_shift", "first_contentful_paint", "first_input_delay", "interaction_to_next_paint", "largest_contentful_paint", "experimental_time_to_first_byte"]
共用体フィールド url_pattern。url_pattern はレコード検索のメイン識別子です。次のいずれかになります。
origin	string url_pattern の「origin」とは、ウェブサイトのオリジンである URL パターンを指します。 例: "https://example.com"、"https://cloud.google.com"
url	string url_pattern url は、任意の URL を含む URL パターンを指します。 例: "https://example.com/、https://cloud.google.com/why-google-cloud/"

たとえば、Chrome デベロッパー ドキュメント ホームページの PC での最大 Contentful Paint の値をリクエストするには、次のようにします。

{
  "url": "https://developer.chrome.com/docs/",
  "formFactor": "DESKTOP",
  "metrics": [
    "largest_contentful_paint"
  ]
}

レスポンスの本文

リクエストに成功すると、次の構造の record オブジェクトと urlNormalizationDetails を含むレスポンスが返されます。

{
  "record": {
    "key": {
      object (Key)
    },
    "metrics": [
      string: {
        object (Metric)
      }
    ]
  },
  "urlNormalizationDetails": {
    object (UrlNormalization)
  }
}

たとえば、前のリクエストのリクエスト本文に対するレスポンスは次のようになります。

{
  "record": {
    "key": {
      "formFactor": "DESKTOP",
      "url": "https://developer.chrome.com/docs/"
    },
    "metrics": {
      "largest_contentful_paint": {
        "histogram": [
          {
            "start": 0,
            "end": 2500,
            "density": 0.9815
          },
          {
            "start": 2500,
            "end": 4000,
            "density": 0.0108
          },
          {
            "start": 4000,
            "density": 0.0077
          }
        ],
        "percentiles": {
          "p75": 651
        }
      }
    },
    "collectionPeriod": {
      "firstDate": {
        "year": 2022,
        "month": 9,
        "day": 12
      },
      "lastDate": {
        "year": 2022,
        "month": 10,
        "day": 9
      }
    }
  }
}

キー

Key は、このレコードを一意として識別するすべてのディメンションを定義します。

{
  "effectiveConnectionType": string,
  "formFactor": enum (FormFactor),

  // Union field url_pattern can be only one of the following:
  "origin": string,
  "url": string
  // End of list of possible types for union field url_pattern.
}

フィールド
formFactor	enum (FormFactor) フォーム ファクタは、すべてのユーザーがこのレコードのサイトへのアクセスに使用したデバイス クラスです。 フォーム ファクタが指定されていない場合は、すべてのフォーム ファクタの集計データが返されます。
effectiveConnectionType	string 有効な接続タイプは、このレコードですべてのユーザーが経験する一般的な接続クラスです。このフィールドは、https://wicg.github.io/netinfo/#effective-connection-types で指定されている ["offline", "slow-2G", "2G", "3G", "4G"] の値を使用します。 有効な接続タイプが指定されていない場合は、有効なすべての接続タイプの集計データが返されます。
共用体フィールド url_pattern。URL パターンは、レコードが適用される URL です。url_pattern は次のいずれかになります。
origin	string origin には、このレコードの対象となるオリジンを指定します。 注: origin を指定すると、このオリジンの下でのすべてのページにわたる読み込みのデータは、オリジンレベルのユーザー エクスペリエンス データに集計されます。
url	string url には、このレコードの対象となる特定の URL を指定します。 注: url を指定すると、その特定の URL のデータのみが集計されます。

指標

metric は、1 つのウェブ パフォーマンス指標（First Contentful Paint など）に関する、集計されたユーザー エクスペリエンス データのセットです。実際の Chrome 使用状況の概要ヒストグラムが一連の bins、特定のパーセンタイル データ（p75 など）として含まれるか、ラベル付きの分数が含まれる場合があります。

{
  "histogram": [
    {
      object (Bin)
    }
  ],
  "percentiles": {
    object (Percentiles)
  }
}

or

{
  "fractions": {
    object (Fractions)
  }
}

フィールド
histogram[]	object (Bin) 指標のユーザー エクスペリエンスのヒストグラム。ヒストグラムには少なくとも 1 つのビンがあり、すべてのビンの密度の合計は 1 以下になります。
percentiles	object (Percentiles) 指標の一般的な有用なパーセンタイル。パーセンタイルの値の型は、ヒストグラム ビンに指定された値の型と同じです。
fractions	object (Fractions) このオブジェクトにはラベル付きの分数が含まれており、その合計は約 1 になります。 分数は小数第 4 位に四捨五入されます。

ビン

bin は、開始から終了までにわたるデータの個別の部分です。開始から正の無限大までの終了が指定されていない場合は、この部分になります。

ビンの開始値と終了値は、ビンが表す指標の値の型で指定します。たとえば、First Contentful Paint はミリ秒単位で測定され、整数として公開されるため、指標ビンでは start タイプと end タイプとして int32 が使用されます。ただし、累積レイアウト シフトは単位なしの 10 進数で測定され、文字列としてエンコードされた 10 進数として公開されるため、指標ビンでは値の型に文字列が使用されます。

{
  "start": value,
  "end": value,
  "density": number
}

フィールド
start	(integer | string) [開始] はデータビンの先頭です。
end	(integer | string) End はデータビンの終わりです。end に値が入っていない場合、ビンに終わりはなく、start から +inf まで有効です。
density	number 特定の指標に対するこのビンの値が発生したユーザーの割合。 密度は小数第 4 位に四捨五入されます。

パーセンタイル

Percentiles には、特定の統計パーセンタイルでの指標の合成値が含まれます。ユーザーの総数のうち、ある割合のユーザーが経験する指標の値を推定するために使用します。

{
  "P75": value
}

フィールド
p75	(integer | string) ページ読み込みの 75% で、指定された指標がこの値以下でした。

分数

Fractions には、合計が 1 以下のラベル付き分数が含まれます。各ラベルはページ読み込みをなんらかの方法で表します。したがって、この方法で表される指標は、数値ではなく個別の値を生成するものと考えることができ、割合は特定の個別値が測定された頻度を表します。

{
  "label_1": fraction,
  "label_2": fraction,
  ...
  "label_n": fraction
}

ヒストグラム ビンの密度値と同様に、各 fraction は数値 0.0 <= value <= 1.0 で、合計で約 1.0 になります。

UrlNormalization

ルックアップが成功する可能性を高めるために URL を正規化するために行われる正規化アクションを表すオブジェクト。これらは、指定された url_pattern の検索時に実行される単純な自動変更であり、失敗すると報告されます。以下のリダイレクトのような複雑なアクションは処理されません。

{
  "originalUrl": string,
  "normalizedUrl": string
}

フィールド
originalUrl	string 正規化処理が行われる前の元のリクエスト URL。
normalizedUrl	string 正規化処理後の URL。これは合理的に検索できる有効なユーザー エクスペリエンス URL です。

レート制限

CrUX API は、Google Cloud プロジェクトごとに 1 分あたり 150 クエリまでに制限されていますが、これは無料で提供されます。この上限と現在の使用量は、Google Cloud コンソールで確認できます。ほとんどのユースケースは、この十分な割り当てで十分です。割り当ての増加に対して支払うことはできません。