https:// と www. を付けずに指定してくださいmax_crawl_pages を 1 に設定し、start_url を指定しないかホームページを設定した場合、次のサイト全体チェックが無効になります：test_canonicalization、enable_www_redirect_check、test_hidden_server_signature、test_page_not_found、test_directory_browsing、test_https_redirectforce_sitewide_checks を true に設定します。max_crawl_pages を 1 に設定し、start_url にホームページ以外を指定した場合、すべてのサイト全体チェックが無効になります。force_sitewide_checks を true に設定します"
},
"start_url": {
"type": [
"string",
"null"
],
"description": "クロールする最初の URLmax_crawl_pages パラメータを 1 に設定しますtrue に設定します。false"
},
"priority_urls": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "キューをバイパスしてクロールする URLtarget ドメインに属している必要があります。allow_subdomains パラメータを true に設定しない限り、サブドメインは無視されます。例：2000"
},
"store_raw_html": {
"type": [
"boolean",
"null"
],
"description": "クロールしたページの HTML を保存true に設定しますfalse"
},
"enable_content_parsing": {
"type": [
"boolean",
"null"
],
"description": "クロールしたページのコンテンツを解析true に設定すると、OnPage Content Parsing エンドポイントを使用しますfalse"
},
"support_cookies": {
"type": [
"boolean",
"null"
],
"description": "クロールしたページで Cookie をサポートtrue に設定しますfalse"
},
"accept_language": {
"type": [
"string",
"null"
],
"description": "ウェブサイトにアクセスするための言語ヘッダー\"type\":\"broken が付きます"
},
"custom_robots_txt": {
"type": [
"string",
"null"
],
"description": "カスタム robots.txt 設定Disallow: /directory1/"
},
"robots_txt_merge_mode": {
"type": [
"string",
"null"
],
"description": "robots.txt 設定のマージまたは上書きmerge、overrideoverride に設定しますmergeoverride に設定する場合は、custom_robots_txt パラメータを指定してください"
},
"custom_user_agent": {
"type": [
"string",
"null"
],
"description": "カスタムユーザーエージェントMozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
Mozilla/5.0 (compatible; RSiteAuditor)"
},
"browser_preset": {
"type": [
"string",
"null"
],
"description": "ブラウザースクリーンパラメーターのプリセットbrowser_screen_width、browser_screen_height、browser_screen_scale_factor を指定する必要はありません可能な値：desktop、mobile、tabletdesktop プリセットでは次の値が適用されます：browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile プリセットでは次の値が適用されます：browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet プリセットでは次の値が適用されます：browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2enable_javascript または enable_browser_rendering を true に設定します"
},
"browser_screen_width": {
"type": [
"integer",
"null"
],
"description": "ブラウザースクリーンの幅browser_preset は無視されるため指定する必要はありません；enable_javascript または enable_browser_rendering を true に設定します最小値（ピクセル）：2409999",
"format": "int64"
},
"browser_screen_height": {
"type": [
"integer",
"null"
],
"description": "ブラウザースクリーンの高さbrowser_preset は無視されるため指定する必要はありません；enable_javascript または enable_browser_rendering を true に設定します最小値（ピクセル）：2409999"
},
"browser_screen_scale_factor": {
"type": [
"number",
"null"
],
"description": "ブラウザースクリーンのスケール係数browser_preset は無視されるため指定する必要はありません；enable_javascript または enable_browser_rendering を true に設定します最小値：0.53"
},
"respect_sitemap": {
"type": [
"boolean",
"null"
],
"description": "クロール時にサイトマップを優先true に設定します。falsetrue に設定すると、API レスポンスの click_depth 値は 0 になります。max_crawl_depth フィールドは無視されます。クロールするページ数は max_crawl_pages パラメータで指定できます"
},
"custom_sitemap": {
"type": [
"string",
"null"
],
"description": "カスタムサイトマップ URLrespect_sitemap が true である必要があります"
},
"crawl_sitemap_only": {
"type": [
"boolean",
"null"
],
"description": "サイトマップに記載されたページのみをクロールtrue に設定しますtrue に設定し、custom_sitemap を指定しない場合は、デフォルトのサイトマップがクロールされますfalserespect_sitemap が true である必要があります"
},
"load_resources": {
"type": [
"boolean",
"null"
],
"description": "リソースを読み込むtrue に設定しますfalsetrue に設定します。false"
},
"enable_javascript": {
"type": [
"boolean",
"null"
],
"description": "ページで JavaScript を読み込むtrue に設定しますfalsetrue に設定しますfalse。このフィールドを使用する場合、enable_javascript を true に設定する必要があります。"
},
"enable_browser_rendering": {
"type": [
"boolean",
"null"
],
"description": "Core Web Vitals を測定するためにブラウザレンダリングをエミュレートenable_browser_rendering は、ページ上のスタイル、画像、フォント、アニメーション、動画などのリソースを読み込みます。falsetrue に設定します。enable_javascript と load_resources パラメータを true に設定する必要がありますtrue に設定します。false"
},
"custom_js": {
"type": [
"string",
"null"
],
"description": "カスタム JavaScriptscr 属性として含まれているかを確認できます：let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute(\"src\");rn if (src != undefined) {rn if (src.indexOf(\"analytics.js\") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf(\"gtm.js\") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;戻り値は、このフィールドに指定した内容によって異なります。たとえば、次のスクリプトを指定した場合：true に設定しますfalse"
},
"allow_subdomains": {
"type": [
"boolean",
"null"
],
"description": "サブドメインのページを含めるtrue に設定しますfalse"
},
"allowed_subdomains": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "クロールするサブドメイン[\"blog.site.com\", \"my.site.com\", \"shop.site.com\"]allow_subdomains パラメーターを false に設定する必要があります；allowed_subdomains フィールドの内容は無視され、すべてのサブドメインの結果が返されます"
},
"disallowed_subdomains": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "クロールしないサブドメイン[\"status.site.com\", \"docs.site.com\"]allow_subdomains パラメータを true に設定する必要があります"
},
"check_spell": {
"type": [
"boolean",
"null"
],
"description": "スペルをチェックするtrue に設定すると、Hunspell ライブラリを使用してウェブサイトのスペルをチェックしますfalse"
},
"check_spell_language": {
"type": [
"string",
"null"
],
"description": "スペルチェックの言語\"SERP\", \"minifiers\", \"JavaScript\""
},
"calculate_keyword_density": {
"type": [
"boolean",
"null"
],
"description": "対象ドメインのキーワード密度を計算true に設定しますfalsechecks オブジェクトに含まれるパラメーターに、カスタムしきい値を指定できます；high_loading_time と large_page_size パラメーターはデフォルトでそれぞれ 3 秒と 1 メガバイトに設定されています；checks を指定して、target ウェブサイトでの実行を防ぎます：\"test_page_not_found\"\"test_canonicalization\"\"test_https_redirect\"\"test_directory_browsing\"例：\"disable_sitewide_checks\": [\"test_directory_browsing\", \"test_page_not_found\"]詳細はヘルプセンターをご覧ください"
},
"disable_page_checks": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "特定のページチェックの実行を防止checks を指定して、実行と onpage_score への影響を防ぎます。例：\"disable_page_checks\": [\"is_5xx_code\", \"is_4xx_code\"]"
},
"switch_pool": {
"type": [
"boolean",
"null"
],
"description": "プロキシプールを切り替えるtrue の場合、要求されたデータの取得に追加のプロキシプールが使用されます；rate-limit や site_unreachable エラーが発生することがある場合、このパラメーターを使用できます"
},
"return_despite_timeout": {
"type": [
"boolean",
"null"
],
"description": "タイムアウトエラーでもページのデータを返すtrue の場合、120 秒以内に読み込みに失敗しタイムアウトエラーを返したページのデータが提供されます。false"
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子tag の値は、レスポンスの data オブジェクトに含まれます"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "タスク完了通知の URL$id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストの送信前に必要な値を設定します。http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagpingback_url 内の特殊文字は URL エンコードされます# 文字は %23 にエンコードされます詳細については、ヘルプセンターを参照してください"
}
},
"example": [
{
"target": "dataforseo.com",
"max_crawl_pages": 10,
"load_resources": true,
"enable_javascript": true,
"custom_js": "meta = {}; meta.url = document.URL; meta;",
"tag": "some_string_123",
"pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
}
]
}
]
},
"example": [
{
"target": "dataforseo.com",
"max_crawl_pages": 10,
"load_resources": true,
"enable_javascript": true,
"custom_js": "meta = {}; meta.url = document.URL; meta;",
"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_OnPageTaskPostResponseInfo"
}
]
}
```
### 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_OnPageTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageTaskPostResponseInfo`
```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_OnPageTaskPostTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "結果の配列
この場合、値は null になります"
}
}
}
]
}
```