https://dataforseo.com/"
},
"for_mobile": {
"type": [
"boolean",
"null"
],
"description": "モバイルエミュレーションを適用true に設定すると、Lighthouse はモバイルデバイスと画面のエミュレーションを使用して、モバイル環境でページをテストしますfalse に設定すると、デスクトップ向けの結果が返されますfalse"
},
"categories": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Lighthouse 監査のカテゴリaudits を指定しない限り、すべてのカテゴリのデータが返されます可能な値：seo、performance、best_practices、accessibility"
},
"audits": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Lighthouse の監査
任意フィールド
監査は、Lighthouse が特定の機能/最適化/指標ごとに実行して数値スコアを算出する個別のテストです（公式の定義を参照）このフィールドを無視すると、すべての監査のデータが返されます
このフィールドを使用すると、ここで指定した特定の監査のデータを取得できます
注意：一部の監査は特定のカテゴリに属さず、独立したページ品質の測定値です
一般に、次のようないくつかの使用例があります：
1. categories を無視する場合、このフィールドを使用して指定した監査のデータのみを取得できます
たとえば、\"categories\" を無視し、\"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"] を指定すると、これらの監査のデータのみが返されます
2. カテゴリを指定する場合、このフィールドを使用して、指定したカテゴリに属さない監査を追加で受け取ることができます
たとえば、\"categories\": [\"seo\"] と \"audits\": [\"metrics/cumulative-layout-shift\",\"metrics/largest-contentful-paint\",\"metrics/total-blocking-time\"] を指定すると、\"performance\" の下のこれらの監査のみと、\"seo\" の下のすべての監査が返されます
利用可能なすべての監査のリストはこちらで確認できます"
},
"version": {
"type": [
"string",
"null"
],
"description": "Lighthouse のバージョン
任意フィールド
バージョン番号を指定すると、特定の Lighthouse バージョンの結果を取得できます
利用可能なバージョンのリストは、Lighthouse Versions エンドポイントから取得できます"
},
"language_name": {
"type": [
"string",
"null"
],
"description": "Lighthouse の言語名
任意フィールドhttps://api.dataforseo.com/v3/on_page/lighthouse/languages に個別にリクエストすると、検索エンジンの利用可能な言語とその language_name のリストを取得できます
デフォルト値：English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "Lighthouse の言語コード
任意フィールドhttps://api.dataforseo.com/v3/on_page/lighthouse/languages に個別にリクエストすると、検索エンジンの利用可能な言語とその language_code のリストを取得できます
デフォルト値：en"
},
"custom_user_agent": {
"type": [
"string",
"null"
],
"description": "カスタムユーザーエージェント
任意フィールド
Lighthouse 監査を実行するときにブラウザーが使用するカスタムユーザーエージェントを指定します；
最大 254 文字まで指定できます；"
},
"browser_screen_width": {
"type": [
"integer",
"null"
],
"description": "ブラウザースクリーンの幅
任意フィールド
特定のデバイスをエミュレートするために、Lighthouse 監査に使用するブラウザーのスクリーンの幅を設定します；240–9999 の範囲で指定できます；",
"format": "int64"
},
"browser_screen_height": {
"type": [
"integer",
"null"
],
"description": "ブラウザースクリーンの高さ
任意フィールド
特定のデバイスをエミュレートするために、Lighthouse 監査に使用するブラウザーのスクリーンの高さを設定します；240–9999 の範囲で指定できます；"
},
"browser_screen_scale_factor": {
"type": [
"number",
"null"
],
"description": "ブラウザースクリーンのスケール係数
任意フィールド
Lighthouse 監査に使用するブラウザーのデバイスピクセル比を設定します；0.5–3 の範囲で指定できます；"
},
"browser_network_throttling_method": {
"type": [
"string",
"null"
],
"description": "ブラウザーのネットワークスロットリング方法
任意フィールド
Lighthouse 監査中にスロットリングを適用する方法を定義します；
可能な値：simulate - 明示的なスロットリングを適用せずに推定パフォーマンス指標を計算します；devtools - browser_network_throttling と browser_cpu_throttling_multiplier で指定されたスロットリング設定を適用します；provided - クロール環境のネットワーク条件を使用します；"
},
"browser_cpu_throttling_multiplier": {
"type": [
"number",
"null"
],
"description": "ブラウザーの CPU スロットリング倍率browser_network_throttling_method が devtools に設定されている場合は必須；
Lighthouse 監査中にデバイスのパフォーマンス条件をシミュレートするため、CPU スロットリング倍率を設定します；1–4 の範囲で指定できます；
注意：このパラメーターは、browser_network_throttling_method が devtools に設定されている場合にのみ適用されます；"
},
"browser_network_throttling": {
"type": [
"string",
"null"
],
"description": "ブラウザーのネットワークスロットリングbrowser_network_throttling_method が devtools に設定されている場合は必須；
Lighthouse 監査中に接続速度の条件をシミュレートするため、ネットワークスロットリングプロファイルを設定します；
可能な値：no_throttling、fast_4g、slow_4g、regular_3g、pc；
注意：このパラメーターは、browser_network_throttling_method が devtools に設定されている場合にのみ適用されます；"
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子
任意フィールド
文字数上限は 255 です
このパラメーターを使ってタスクを識別し、結果と照合できます
指定した tag の値は、レスポンスの data オブジェクトに含まれます"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "完了したタスクの通知 URL
任意フィールド
タスクが完了すると、指定した URL に GET リクエストを送信して通知します
‘$id’ 文字列を $id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストを送信する前に必要な値を設定します。
例：http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
注意：pingback_url 内の特殊文字は URL エンコードされます；
たとえば、# 文字は %23 にエンコードされます。詳細はヘルプセンターをご覧ください"
}
},
"example": [
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
}
]
},
"example": [
{
"url": "https://dataforseo.com",
"for_mobile": true,
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo"
}
]
}
```
### 400 — リクエストを処理できませんでした。リクエストパラメータを確認してください。
### 401 — 有効な Felo API キーが必要です。
### 402 — 請求要件が満たされていないため、リクエストを続行できません。
### 403 — このアカウントにはこの操作を行う権限がありません。
### 429 — リクエストまたは支出の上限に達しました。
### 502 — サービスがリクエストを完了できませんでした。
### 503 — API または請求サービスが一時的に利用できません。
### 504 — リクエストの処理中にサービスがタイムアウトしました。
### default — エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "API の現在のバージョン"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "一般的なステータスコード\nレスポンスコードの完全な一覧はこちらです"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "一般的な情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
},
"time": {
"type": [
"string",
"null"
],
"description": "合計実行時間（秒）"
},
"cost": {
"type": [
"number",
"null"
],
"description": "タスクの総コスト（USD）",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "tasks 配列内のタスク数",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "エラーで返された tasks 配列内のタスク数",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "タスク識別子\n当社システム内で UUID 形式の一意のタスク識別子"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "タスクのステータスコード\nDataForSEO によって生成され、次の範囲の値になります: 10000-60000\nレスポンスコードの完全な一覧はこちらです"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "タスクの情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
},
"time": {
"type": [
"string",
"null"
],
"description": "実行時間（秒）"
},
"cost": {
"type": [
"number",
"null"
],
"description": "タスクの総コスト（USD）",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "result 配列内の要素数",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL パス"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "POST リクエストで指定したものと同じパラメーターを含みます"
}
}
}
```
### Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
}
}
}
}
}
]
}
```