Felo API PlatformFelo API Platform
DataForSEO のエンドポイント一覧
v0.2.0-beta
OpenAPI 3.1.0

OnPage タスクの設定

Felo API Support
MIT
サーバー:https://openapi.felo.ai
クライアントライブラリ
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO 操作

OnPage タスクの設定

​

target のクロールを開始し、tasks[0].id でタスク id を返します。この id が、このファミリーの他のすべてのツールが必要とするハンドルです。必ず保持してください。max_crawl_pages がクロールの上限を決め、start_url、max_crawl_depth、priority_urls、crawl_delay がその形を定め、store_raw_html が後で post_dataforseo_on_page_raw_html に返すものがあるかどうかを決めます。DataForSEO のエンベロープに包まれます。データは tasks[0].result、結果は tasks[0].status_code に格納され、拒否されたリクエストでも HTTP 200 が返ります。⚠️ これは一般的な送信／取得のペアではありません。クロールはセッションであり、その後に十数個のツールが id で照会します。crawl_progress が finished になるまで get_dataforseo_on_page_summary をポーリングしてください。example.com の 1 ページのクロールは 1 分もかかりませんでした。

料金の参考情報

  • 計測方法：報告されたレスポンスコスト。
  • 参考リクエスト見積もり：0.003 USD。
  • 参照用の顧客乗数：1.0。確定済みの顧客金額に再適用しないでください。

参照用のメタデータのみであり、アカウントへの見積もり、保証された価格、支出上限ではありません。リソースクレジットは Felo クレジットではありません。最終的な請求は Felo の請求記録に従います。

リクエストボディ
application/json
  • 型: array (object | null)[]
    • accept_language
      型: string | null

      ウェブサイトにアクセスするための言語ヘッダー
      任意フィールド
      すべてのロケール形式をサポートしています（xx、xx-XX、xxx-XX など）
      注意：このパラメーターを指定しない場合、一部のウェブサイトがアクセスを拒否することがあります。その場合、レスポンス配列のページには "type":"broken が付きます

    • allow_subdomains
      型: boolean | null

      サブドメインのページを含める
      任意フィールド
      対象ウェブサイトのすべてのサブドメインをクロールする場合は true に設定します
      デフォルト値：false

    • allowed_subdomains
      型: array string[] | null

      クロールするサブドメイン
      任意フィールド
      クロールするサブドメインを指定します
      例：["blog.site.com", "my.site.com", "shop.site.com"]
      注意：このパラメーターを使用するには、allow_subdomains パラメーターを false に設定する必要があります；
      それ以外の場合、allowed_subdomains フィールドの内容は無視され、すべてのサブドメインの結果が返されます

    • browser_preset
      型: string | null

      ブラウザースクリーンパラメーターのプリセット
      任意フィールド
      このフィールドを使用する場合、browser_screen_width、browser_screen_height、browser_screen_scale_factor を指定する必要はありません可能な値：
      desktop、mobile、tabletdesktop プリセットでは次の値が適用されます：browser_screen_width: 1920
      browser_screen_height: 1080
      browser_screen_scale_factor: 1mobile プリセットでは次の値が適用されます：browser_screen_width: 390
      browser_screen_height: 844
      browser_screen_scale_factor: 3tablet プリセットでは次の値が適用されます：browser_screen_width: 1024
      browser_screen_height: 1366
      browser_screen_scale_factor: 2
      注意：このパラメーターを使用するには、enable_javascript または enable_browser_rendering を true に設定します

    • browser_screen_height
      型: integer | null

      ブラウザースクリーンの高さ
      任意フィールド
      特定のデバイス向けの監査を実行するために、ブラウザースクリーンの高さをカスタム設定できます；
      このフィールドを使用する場合、browser_preset は無視されるため指定する必要はありません；
      注意：このパラメーターを使用するには、enable_javascript または enable_browser_rendering を true に設定します最小値（ピクセル）：240
      最大値（ピクセル）：9999

    • browser_screen_scale_factor
      型: number | null

      ブラウザースクリーンのスケール係数
      任意フィールド
      特定のデバイス向けの監査を実行するために、ブラウザースクリーンの解像度比をカスタム設定できます；
      このフィールドを使用する場合、browser_preset は無視されるため指定する必要はありません；
      注意：このパラメーターを使用するには、enable_javascript または enable_browser_rendering を true に設定します最小値：0.5
      最大値：3

    • browser_screen_width
      型: integer | null 形式: int64

      ブラウザースクリーンの幅
      任意フィールド
      特定のデバイス向けの監査を実行するために、ブラウザースクリーンの幅をカスタム設定できます；
      このフィールドを使用する場合、browser_preset は無視されるため指定する必要はありません；
      注意：このパラメーターを使用するには、enable_javascript または enable_browser_rendering を true に設定します最小値（ピクセル）：240
      最大値（ピクセル）：9999

    • calculate_keyword_density
      型: boolean | null

      対象ドメインのキーワード密度を計算
      任意フィールド
      ウェブサイトのページのキーワード密度を計算する場合は true に設定します
      デフォルト値：false
      注意：このパラメーターを使用すると追加料金が発生します。このパラメーターを使用するタスクのコストの詳細については、ヘルプ記事をご覧ください
      クロールが完了すると、Keyword Density エンドポイントでキーワード密度の値を取得できます

    • check_spell
      型: boolean | null

      スペルをチェックする
      任意フィールド
      true に設定すると、Hunspell ライブラリを使用してウェブサイトのスペルをチェックします
      デフォルト値：false

    • check_spell_exceptions
      型: array string[] | null

      スペルチェックから除外する単語
      任意フィールド
      スペルチェックから除外する単語を指定します
      単語の最大長：100 文字
      単語の最大数：1000
      例： "SERP", "minifiers", "JavaScript"

    • check_spell_language
      型: string | null

      スペルチェックの言語
      任意フィールド
      サポートされている言語：'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'mk', 'mn', 'ne', 'nb', 'nn', 'pl', 'pt', 'ro', 'gd', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'tk', 'uk', 'vi'
      注意：言語を指定しない場合、ページの内容に基づいて自動的に設定されます

    • checks_threshold
      型: object | null

      チェックのカスタムしきい値
      任意フィールド
      OnPage API レスポンスの checks オブジェクトに含まれるパラメーターに、カスタムしきい値を指定できます；
      注意：変更できるのは整数のしきい値のみです；
      たとえば、high_loading_time と large_page_size パラメーターはデフォルトでそれぞれ 3 秒と 1 メガバイトに設定されています；
      これらのしきい値を 1 秒と 1000 KB に変更する場合は、次のスニペットを使用します：
      "checks_threshold": {<br>"high_loading_time": 1,<br>"large_page_size": 1000<br>}
      カスタマイズ可能なパラメーターとデフォルト値：
      "title_too_short", default value: 30, type: "int"<br>"title_too_long", default value: 65, type: "int"<br>"small_page_size", default value: 1024, type: "int"<br>"large_page_size", default value: 1048576 (1024 * 1024), type: "int"<br>"low_character_count", default value: 1024, type: "int"<br>"high_character_count", default value: 256000 (250 * 1024), type: "int"<br>"low_content_rate", default value: 0.1, type: "float"<br>"high_content_rate", default value: 0.9, type: "float"<br>"high_loading_time", default value: 3000, type: "int"<br>"high_waiting_time", default value: 1500, type: "int"<br>"low_readability_rate", default value: 15.0, type: "float"<br>"irrelevant_description", default value: 0.2, type: "float"<br>"irrelevant_title", default value: 0.3, type: "float"<br>"irrelevant_meta_keywords", default value: 0.6, type: "float"

      • propertyName
        型: integer | null 形式: int64

        Signed 64-bit integers (long type).

    • crawl_delay
      型: integer | null

      ヒット間の遅延（ミリ秒）
      任意フィールド
      クローラーがサーバーへアクセスする際のヒット間のカスタム遅延
      デフォルト値：2000

    • crawl_sitemap_only
      型: boolean | null

      サイトマップに記載されたページのみをクロール
      任意フィールド
      サイトマップに記載されたページのみをクロールする場合は true に設定します
      このパラメータを true に設定し、custom_sitemap を指定しない場合は、デフォルトのサイトマップがクロールされます
      デフォルト値：false
      注意：このパラメータを使用するには、respect_sitemap が true である必要があります

    • custom_js
      型: string | null

      カスタム JavaScript
      任意フィールド
      注意：ここに入力するスクリプトの実行時間は最大 700 ms にしてください。たとえば、次の JS スニペットを使用すると、ウェブサイトに Google Tag Manager が scr 属性として含まれているかを確認できます：
      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;戻り値は、このフィールドに指定した内容によって異なります。たとえば、次のスクリプトを指定した場合：
      meta = {}; meta.url = document.URL; meta.test = 'test'; meta;
      レスポンスとして次のデータが返されます：
      "custom_js_response": {<br>"url": "https://dataforseo.com/",<br>"test": "test"<br>}
      注意：入力するスクリプトの長さは 2000 文字以内である必要があります

    • custom_robots_txt
      型: string | null

      カスタム robots.txt 設定
      任意フィールド
      例：Disallow: /directory1/

    • custom_sitemap
      型: string | null

      カスタムサイトマップ URL
      任意フィールド
      代替サイトマップが置かれているページの URL
      注意：このパラメータを使用するには、respect_sitemap が true である必要があります

    • custom_user_agent
      型: string | null

      カスタムユーザーエージェント
      任意フィールド
      ウェブサイトをクロールするためのカスタムユーザーエージェント
      例： 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)

    • disable_cookie_popup
      型: boolean | null

      Cookie ポップアップを無効化
      任意フィールド
      ユーザーに Cookie の同意を求めるポップアップを無効にする場合は true に設定します。
      デフォルト値：
      false

    • disable_page_checks
      型: array string[] | null

      特定のページチェックの実行を防止
      任意フィールド
      特定の checks を指定して、実行と onpage_score への影響を防ぎます。例：
      "disable_page_checks": ["is_5xx_code", "is_4xx_code"]

    • disable_sitewide_checks
      型: array string[] | null

      特定のサイト全体チェックの実行を防止
      任意フィールド
      次の checks を指定して、target ウェブサイトでの実行を防ぎます：
      "test_page_not_found"
      "test_canonicalization"
      "test_https_redirect"
      "test_directory_browsing"例：
      "disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]詳細はヘルプセンターをご覧ください

    • disallowed_subdomains
      型: array string[] | null

      クロールしないサブドメイン
      任意フィールド
      クロールしたくないサブドメインを指定します
      例：["status.site.com", "docs.site.com"]
      注意：このパラメータを使用するには、allow_subdomains パラメータを true に設定する必要があります

    • enable_browser_rendering
      型: boolean | null

      Core Web Vitals を測定するためにブラウザレンダリングをエミュレート
      任意フィールド
      このパラメータを使用すると、ウェブページの読み込み時にブラウザをエミュレートできます。
      enable_browser_rendering は、ページ上のスタイル、画像、フォント、アニメーション、動画などのリソースを読み込みます。
      デフォルト値：false
      レスポンスで Core Web Vitals（FID、CLS、LCP）の指標を取得するには true に設定します。
      このフィールドを使用する場合、enable_javascript と load_resources パラメータを true に設定する必要があります
      注意：このパラメータを使用すると追加料金が発生します。このパラメータを使用したタスクのコストについてはヘルプ記事をご覧ください。コストは料金ページで計算できます

    • enable_content_parsing
      型: boolean | null

      クロールしたページのコンテンツを解析
      任意フィールド
      true に設定すると、OnPage Content Parsing エンドポイントを使用します
      デフォルト値：false

    • enable_javascript
      型: boolean | null

      ページで JavaScript を読み込む
      任意フィールド
      ページで利用可能なスクリプトを読み込む場合は true に設定します
      デフォルト値：false
      注意：このパラメータを使用すると追加料金が発生します。このパラメータを使用したタスクのコストについてはヘルプ記事をご覧ください。コストは料金ページで計算できます

    • enable_www_redirect_check
      型: boolean | null

      ドメインが www リダイレクトを実装しているか確認
      任意フィールド
      リクエストされたドメインが www から非 www、または非 www から www へのリダイレクトを実装しているかを確認する場合は true に設定します。
      デフォルト値：false

    • enable_xhr
      型: boolean | null

      ページで XMLHttpRequest を有効化
      任意フィールド
      クローラーが XMLHttpRequest オブジェクトを使用してウェブサーバーからデータを要求する場合は true に設定します
      デフォルト値：false。このフィールドを使用する場合、enable_javascript を true に設定する必要があります。

    • force_sitewide_checks
      型: boolean | null

      単一ページのクロール時にサイト全体チェックを有効化
      任意フィールド
      単一ページをクロールするときにサイト全体チェックのデータを取得する場合は true に設定します。
      デフォルト値：false

    • load_resources
      型: boolean | null

      リソースを読み込む
      任意フィールド
      画像、スタイルシート、スクリプト、壊れたリソースを読み込む場合は true に設定します
      デフォルト値：false
      注意：このパラメータを使用すると追加料金が発生します。このパラメータを使用したタスクのコストについてはヘルプ記事をご覧ください。コストは料金ページで計算できます

    • max_crawl_depth
      型: integer | null

      クロールの深さ
      任意フィールド
      クロールするページのリンクの深さ。
      たとえば、クロールの開始ページがレベル 0、そのページからのリンクがあるページがレベル 1 になります。

    • max_crawl_pages
      型: integer

      クロールするページ数の上限
      必須フィールド
      指定したドメインでクロールするページ数
      注意：
      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_redirect
      強制的に有効にするには、force_sitewide_checks を true に設定します。max_crawl_pages を 1 に設定し、start_url にホームページ以外を指定した場合、すべてのサイト全体チェックが無効になります。
      強制的に有効にするには、force_sitewide_checks を true に設定します

    • pingback_url
      型: string | null

      タスク完了通知の URL
      任意フィールド
      タスクが完了すると、指定した URL に GET リクエストを送信して通知します
      ‘$id’ 文字列を $id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストの送信前に必要な値を設定します。
      例:
      http://your-server.com/pingscript?id=$id
      http://your-server.com/pingscript?id=$id&amp;tag=$tag
      注意: pingback_url 内の特殊文字は URL エンコードされます
      たとえば、# 文字は %23 にエンコードされます

      詳細については、ヘルプセンターを参照してください

    • priority_urls
      型: array string[] | null

      キューをバイパスしてクロールする URL
      任意フィールド
      この配列で指定した URL は、クロールキューをバイパスして最初にクロールされます。
      注意：絶対 URL を指定してください。
      最大 20 個の URL を指定できます。
      配列内のすべての URL は target ドメインに属している必要があります。
      allow_subdomains パラメータを true に設定しない限り、サブドメインは無視されます。例：
      "priority_urls": [<br>"https://dataforseo.com/apis/serp-api",<br>"https://dataforseo.com/contact"<br>]

    • respect_sitemap
      型: boolean | null

      クロール時にサイトマップを優先
      任意フィールド
      クロール時にプライマリサイトマップに記載されたページ順に従う場合は true に設定します。
      デフォルト値：false
      注意：true に設定すると、API レスポンスの click_depth 値は 0 になります。
      リクエストの max_crawl_depth フィールドは無視されます。クロールするページ数は max_crawl_pages パラメータで指定できます

    • return_despite_timeout
      型: boolean | null

      タイムアウトエラーでもページのデータを返す
      任意フィールド
      true の場合、120 秒以内に読み込みに失敗しタイムアウトエラーを返したページのデータが提供されます。
      デフォルト値：false

    • robots_txt_merge_mode
      型: string | null

      robots.txt 設定のマージまたは上書き
      任意フィールド
      使用可能な値：merge、override
      ウェブサイトのクロール制限やその他の robots.txt 設定を無視する場合は override に設定します
      デフォルト値：merge
      注意：override に設定する場合は、custom_robots_txt パラメータを指定してください

    • start_url
      型: string | null

      クロールする最初の URL
      任意フィールド
      注意：絶対 URL を指定してください
      単一ページをクロールする場合は、このフィールドにその URL を指定し、さらに max_crawl_pages パラメータを 1 に設定します
      ページ固有のデータを取得するには、ライブ Instant Pages エンドポイントも使用できます

    • store_raw_html
      型: boolean | null

      クロールしたページの HTML を保存
      任意フィールド
      OnPage Raw HTML エンドポイントを使用してページの HTML を取得する場合は true に設定します
      デフォルト値：false

    • support_cookies
      型: boolean | null

      クロールしたページで Cookie をサポート
      任意フィールド
      ページをクロールするときに Cookie をサポートするには true に設定します
      デフォルト値：false

    • switch_pool
      型: boolean | null

      プロキシプールを切り替える
      任意フィールド
      true の場合、要求されたデータの取得に追加のプロキシプールが使用されます；
      多数のタスクを同時に設定したために rate-limit や site_unreachable エラーが発生することがある場合、このパラメーターを使用できます

    • tag
      型: string | null

      ユーザー定義のタスク識別子
      任意フィールド
      文字数上限は 255 です
      このパラメーターを使ってタスクを識別し、結果と照合できます
      指定した tag の値は、レスポンスの data オブジェクトに含まれます

    • target
      型: string

      対象ドメイン
      必須フィールド
      ドメイン名は https:// と www. を付けずに指定してください
      ページ URL を指定した場合、その URL に含まれるドメインの結果が返されます

    • validate_micromarkup
      型: boolean | null

      マイクロデータ検証を有効化
      任意フィールド
      OnPage API Microdata エンドポイントを使用する場合は true に設定します
      デフォルト値：false

レスポンス
  • 200
    型: object | null · Response36Afe1097B20_OnPageTaskPostResponseInfo
    • cost
      型: number | null 形式: double

      タスクの総コスト（USD）

    • status_code
      型: integer | null

      一般的なステータスコード レスポンスコードの完全な一覧はこちらです

    • status_message
      型: string | null

      一般的な情報メッセージ 一般的な情報メッセージの完全な一覧はこちらです

    • tasks
      型: array (object | null)[] | null

      タスクの配列

      • 型: object | null · Response36Afe1097B20_OnPageTaskPostTaskInfo
        • cost
          型: number | null 形式: double

          タスクの総コスト（USD）

        • data
          型: object | null

          POST リクエストで指定したものと同じパラメーターを含みます

          • propertyName
            型: object | null
        • id
          型: string | null

          タスク識別子 当社システム内で UUID 形式の一意のタスク識別子

        • path
          型: array (string | null)[] | null

          URL パス

        • result
          型: object | null

          結果の配列
          この場合、値は null になります

        • result_count
          型: integer | null 形式: int64

          result 配列内の要素数

        • status_code
          型: integer | null

          タスクのステータスコード DataForSEO によって生成され、次の範囲の値になります: 10000-60000 レスポンスコードの完全な一覧はこちらです

        • status_message
          型: string | null

          タスクの情報メッセージ 一般的な情報メッセージの完全な一覧はこちらです

        • time
          型: string | null

          実行時間（秒）

    • tasks_count
      型: integer | null 形式: int64

      tasks 配列内のタスク数

    • tasks_error
      型: integer | null 形式: int64

      エラーで返された tasks 配列内のタスク数

    • time
      型: string | null

      合計実行時間（秒）

    • version
      型: string | null

      API の現在のバージョン

    application/json
  • 400

    リクエストを処理できませんでした。リクエストパラメータを確認してください。

  • 401

    有効な Felo API キーが必要です。

  • 402

    請求要件が満たされていないため、リクエストを続行できません。

  • 403

    このアカウントにはこの操作を行う権限がありません。

  • 429

    リクエストまたは支出の上限に達しました。

  • 502

    サービスがリクエストを完了できませんでした。

  • 503

    API または請求サービスが一時的に利用できません。

  • 504

    リクエストの処理中にサービスがタイムアウトしました。

  • default

    エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります

    application/json
Request Example for post/v1/beta/dataforseo/on_page/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "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"
  }
]'

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": null
    }
  ]
}

操作成功

Setting OnPage Tasks

ヘルプが必要ですか？

  • API・請求・アカウントのご質問はサポートへ。
  • Discord で Felo の開発者と交流できます。
  • 更新履歴 をご覧ください。
  • ボリューム価格や購買についてのご相談は営業窓口へ。
  • LLM での構築をお考えですか？llms.txt をご覧ください。