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

OnPage API ページスクリーンショット

サーバー:https://openapi.felo.ai
クライアントライブラリ

DataForSEO

​

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

OnPage API ページスクリーンショット

​

任意の url をレンダリングしてスクリーンショットを返します。full_page_screenshot でスクロール全体の高さを撮るかどうかを決め、browser_screen_width と browser_screen_height でビューポートを設定します。単独で動作し、クロールは不要です。DataForSEO のエンベロープに包まれます。データは tasks[0].result、結果は tasks[0].status_code に格納され、拒否されたリクエストでも HTTP 200 が返ります。⚠️ エージェントが画像を扱えない段階でも、画像はそれだけで大きなツール結果になります。見た目が要点である場合にのみスクリーンショットを要求し、テキストが要点なら post_dataforseo_on_page_content_parsing_live を使用してください。

料金の参考情報

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

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

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

      ウェブサイトにアクセスするための言語ヘッダー
      任意フィールド
      すべてのロケール形式をサポートしています(xx、xx-XX、xxx-XX など)
      注意:このパラメーターを指定しない場合、一部のウェブサイトがアクセスを拒否することがあります。その場合、レスポンス配列に "error_message":"Screenshot is empty" が返されます

    • browser_preset
      型: string | null

      ブラウザースクリーンパラメーターのプリセット
      任意フィールド
      このフィールドを使用する場合、browser_screen_width、browser_screen_height、browser_screen_scale_factor を指定する必要はありません

      可能な値:
      desktop、mobile、tablet

      desktop プリセットでは次の値が適用されます:

      browser_screen_width: 1920
      browser_screen_height: 1080
      browser_screen_scale_factor: 1

      mobile プリセットでは次の値が適用されます:

      browser_screen_width: 390
      browser_screen_height: 844
      browser_screen_scale_factor: 3

      tablet プリセットでは次の値が適用されます:

      browser_screen_width: 1024
      browser_screen_height: 1366
      browser_screen_scale_factor: 2

      注意:このエンドポイントでは、enable_browser_rendering、enable_javascript、load_resources、enable_xhr の各パラメーターは常に有効です。

    • browser_screen_height
      型: integer | null

      ブラウザースクリーンの高さ
      任意フィールド
      特定のデバイス向けの監査を実行するために、ブラウザースクリーンの高さをカスタム設定できます;
      このフィールドを使用する場合、browser_preset は無視されるため指定する必要はありません;

      最小値(ピクセル):240
      最大値(ピクセル):9999

    • browser_screen_scale_factor
      型: number | null

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

      最小値:0.5
      最大値:3

    • browser_screen_width
      型: integer | null 形式: int64

      ブラウザースクリーンの幅
      任意フィールド
      特定のデバイス向けの監査を実行するために、ブラウザースクリーンの幅をカスタム設定できます;
      このフィールドを使用する場合、browser_preset は無視されるため指定する必要はありません;

      最小値(ピクセル):240
      最大値(ピクセル):9999

    • 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

    • full_page_screenshot
      型: boolean | null

      ページ全体のスクリーンショットを撮る
      任意フィールド
      スクロール前に表示されるページの一部のみをキャプチャする場合は false に設定します
      デフォルト値:true

    • ip_pool_for_scan
      型: string | null

      プロキシプール
      任意フィールド
      要求されたデータの取得に使用するプロキシプールのロケーションを選択できます;
      いずれかのロケーションでページコンテンツにアクセスできず、site_unreachable エラーが発生することがある場合、このパラメーターを使用できます
      可能な値:us、de

    • switch_pool
      型: boolean | null

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

    • url
      型: string

      ページ URL
      必須フィールド
      キャプチャするページの絶対 URL
      注意:ここで指定した URL が 404 ステータスコードを返す場合、または指定した値が有効な URL でない場合、レスポンス配列に "error_message":"Screenshot is empty" が返されます

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

      タスクの総コスト(USD)

    • status_code
      型: integer | null

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

    • status_message
      型: string | null

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

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

      タスクの配列

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

          タスクの総コスト(USD)

        • data
          型: object | null

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

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

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

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

          URL パス

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

          結果の配列

          • crawl_progress
            型: string | null

            クロールセッションのステータス
            可能な値:in_progress、finished

          • error_message
            型: string | null

            エラーメッセージ
            指定した url が 404 ステータスコードを返す場合、または有効な URL でない場合は、"error_message":"Screenshot is empty" が返されます
            エラーが発生しなかった場合、値は null になります

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

            項目の配列

            • image
              型: string | null

              リクエストしたページのスクリーンショット
              DataForSEO ストレージ上のページスクリーンショットの URL
              注意:DataForSEO ストレージに保存されたページスクリーンショットは、リクエスト後 1 日間のみアクセスできます

          • items_count
            型: integer | null 形式: int64

            結果配列内の項目数

        • 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/page_screenshot
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/page_screenshot \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com/apis"
  }
]'
{
  "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": [
        {
          "crawl_progress": null,
          "error_message": null,
          "items_count": null,
          "items": [
            {
              "image": null
            }
          ]
        }
      ]
    }
  ]
}
OnPage API Page Screenshot

ヘルプが必要ですか?

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