CrUX API

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

試してみる

一般的なユースケース

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

CrUX API キー

CrUX API を使用するには、Chrome UX Report API の使用用にプロビジョニングされた Google Cloud API キーが必要です。

API キーの取得と使用

キーの取得

または、認証情報ページでキーを作成することもできます。

API キーを作成したら、アプリケーションですべてのリクエスト URL の末尾にクエリ パラメータ key=yourAPIKey を追加できます。

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

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

ディメンション

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

フォーム ファクタ

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

指標

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

浮動小数点値は小数点以下 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 ms の範囲にあり、11.92% で 3,000 ms を超える値でした。

パーセンタイル

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

{
  "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 のパーセンタイル fcp
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 桁の浮動小数点数 パーセント ナビゲーション タイプから分数へのマッピング ナビゲーションの種類
round_trip_time int ミリ秒 パーセンタイル（p75） rtt

BigQuery 指標名のマッピング

CrUX API 指標名 BigQuery 指標名
cumulative_layout_shift layout_instability.cumulative_layout_shift
first_contentful_paint first_contentful_paint
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 なし
round_trip_time なし

収集期間

2022 年 10 月現在、CrUX API には、集計期間の開始日と終了日を表す firstDate フィールドと endDate フィールドを含む collectionPeriod オブジェクトが含まれています。次に例を示します。

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

これにより、データの詳細や、その日のデータがまだ更新されていないか、昨日と同じデータが返されているかを確認できます。

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

また、データが 28 日間分ではない場合でも（たとえば、ページがリリースされてから 28 日未満の場合）、collectionPeriod には常に 28 日間と表示されます。collectionPeriod は、CrUX データが集計された期間であり、データが表す期間とは限りません。

クエリの例

クエリは、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"]}'

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

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

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

  • cumulative_layout_shift
  • first_contentful_paint
  • 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 データセットで月次レポートを集計する方法と同様です。

毎日の通知

データは毎日 UTC の 04:00 頃に更新されます。更新時間に関するサービスレベル契約はありません。毎日ベスト エフォート方式で実行されます。

スキーマ

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

HTTP リクエスト

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

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

リクエストの本文

リクエストの本文には、次の構造のデータを含めます。

{
  "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.
}
フィールド
formFactor

enum（FormFactor）

フォーム ファクタは、レコードのデータが属するデバイスクラスを指定するクエリ ディメンションです。

このフィールドには、DESKTOP、PHONE、または TABLET の値を使用します。

注: フォーム ファクタを指定しない場合は、すべてのフォーム ファクタの集計データを含む特別なレコードが返されます。
metrics[]

string

レスポンスに含める指標。指定しない場合は、見つかった指標がすべて返されます。

使用できる値: ["cumulative_layout_shift", "first_contentful_paint", "interaction_to_next_paint", "largest_contentful_paint", "experimental_time_to_first_byte"]
共用体フィールド url_pattern。url_pattern は、レコード検索の主な識別子です。次のいずれかになります。
origin

string

url_pattern の「オリジン」は、ウェブサイトのオリジンである 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 デベロッパー ドキュメントのホームページのデスクトップの Largest 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 は、このレコードを一意に識別するすべてのディメンションを定義します。

{
  "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)

フォーム ファクタは、このレコードのサイトにアクセスするためにすべてのユーザーが使用したデバイスクラスです。

フォーム ファクタを指定しない場合は、すべてのフォーム ファクタの集計データが返されます。
共用体フィールド url_pattern。URL パターンは、レコードが適用される URL です。url_pattern は次のいずれかになります。
origin

string

origin には、このレコードの送信元を指定します。

注: origin を指定する場合は、このオリジンのすべてのページでの読み込みデータがオリジン レベルのユーザー エクスペリエンス データに集約されます。
url

string

url には、このレコードが対象とする特定の URL を指定します。

注: url を指定した場合は、その特定の URL のデータのみが集計されます。

指標

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

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

または

{
  "fractions": {
    object (Fractions)
  }
}
フィールド
histogram[]

object (Bin)

指標のユーザー エクスペリエンスのヒストグラム。ヒストグラムには少なくとも 1 つの区分が含まれ、すべての区分の密度を合計すると約 1 になります。
percentiles

object (Percentiles)

指標の一般的な有用なパーセンタイル。パーセンタイル値の値の型は、ヒストグラムのビンに指定された値の型と同じになります。
fractions

object (Fractions)

このオブジェクトには、ラベル付きの分数が含まれており、合計は約 1 になります。

小数は小数点以下 4 桁に四捨五入されます。

ビン

bin は、開始日から終了日までのデータの離散部分です。終了日が指定されていない場合は、開始日から正の無限大までのデータです。

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

{
  "start": value,
  "end": value,
  "density": number
}
フィールド
start

(integer | string)

Start はデータビンの開始点です。
end

(integer | string)

End はデータビンの終了です。end が入力されていない場合、そのビンは終了がなく、開始から +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 件のクエリに制限されています。この API は無料で提供されています。この上限と現在の使用量は、Google Cloud コンソールで確認できます。この十分な割り当ては、ほとんどのユースケースで十分なはずです。割り当ての増加に対して料金を支払うことはできません。