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

Lighthouse タスクの設定

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

DataForSEO

​

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

DataForSEO 操作

Lighthouse タスクの設定

​

Lighthouse 監査を待たずにキューに登録し、タスク id を返します。監査がツール呼び出しの待ち時間を超える場合に使用します。結果は get_dataforseo_on_page_lighthouse_task_get_json で取得し、何が準備できているかは get_dataforseo_on_page_lighthouse_ready で確認します。DataForSEO のエンベロープに包まれます。データは tasks[0].result、結果は tasks[0].status_code に格納され、拒否されたリクエストでも HTTP 200 が返ります。⚠️ 最終的に同じ 245 KB のレポートが返るため、コンテキストのコストは先送りされるだけで回避されません。後回しにせず、ここで categories か audits を使って絞り込んでください。

料金の参考情報

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

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

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

      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" の下のすべての監査が返されます

      利用可能なすべての監査のリストはこちらで確認できます

    • browser_cpu_throttling_multiplier
      型: number | null

      ブラウザーの CPU スロットリング倍率
      browser_network_throttling_method が devtools に設定されている場合は必須；
      Lighthouse 監査中にデバイスのパフォーマンス条件をシミュレートするため、CPU スロットリング倍率を設定します；
      1–4 の範囲で指定できます；
      注意：このパラメーターは、browser_network_throttling_method が devtools に設定されている場合にのみ適用されます；

    • browser_network_throttling
      型: string | null

      ブラウザーのネットワークスロットリング
      browser_network_throttling_method が devtools に設定されている場合は必須；
      Lighthouse 監査中に接続速度の条件をシミュレートするため、ネットワークスロットリングプロファイルを設定します；
      可能な値：no_throttling、fast_4g、slow_4g、regular_3g、pc；
      注意：このパラメーターは、browser_network_throttling_method が devtools に設定されている場合にのみ適用されます；

    • browser_network_throttling_method
      型: string | null

      ブラウザーのネットワークスロットリング方法
      任意フィールド
      Lighthouse 監査中にスロットリングを適用する方法を定義します；
      可能な値：
      simulate - 明示的なスロットリングを適用せずに推定パフォーマンス指標を計算します；
      devtools - browser_network_throttling と browser_cpu_throttling_multiplier で指定されたスロットリング設定を適用します；
      provided - クロール環境のネットワーク条件を使用します；

    • browser_screen_height
      型: integer | null

      ブラウザースクリーンの高さ
      任意フィールド
      特定のデバイスをエミュレートするために、Lighthouse 監査に使用するブラウザーのスクリーンの高さを設定します；
      240–9999 の範囲で指定できます；

    • browser_screen_scale_factor
      型: number | null

      ブラウザースクリーンのスケール係数
      任意フィールド
      Lighthouse 監査に使用するブラウザーのデバイスピクセル比を設定します；
      0.5–3 の範囲で指定できます；

    • browser_screen_width
      型: integer | null 形式: int64

      ブラウザースクリーンの幅
      任意フィールド
      特定のデバイスをエミュレートするために、Lighthouse 監査に使用するブラウザーのスクリーンの幅を設定します；
      240–9999 の範囲で指定できます；

    • categories
      型: array string[] | null

      Lighthouse 監査のカテゴリ
      任意フィールド
      各カテゴリは監査と監査グループの集合で、そのセクションに重み付けとスコアリングを適用します（公式の定義を参照）このフィールドを無視すると、audits を指定しない限り、すべてのカテゴリのデータが返されます
      このフィールドを使用すると、ここで指定した特定のカテゴリのデータを取得できます

      可能な値：
      seo、performance、best_practices、accessibility

    • custom_user_agent
      型: string | null

      カスタムユーザーエージェント
      任意フィールド
      Lighthouse 監査を実行するときにブラウザーが使用するカスタムユーザーエージェントを指定します；
      最大 254 文字まで指定できます；

    • for_mobile
      型: boolean | null

      モバイルエミュレーションを適用
      任意フィールド
      true に設定すると、Lighthouse はモバイルデバイスと画面のエミュレーションを使用して、モバイル環境でページをテストします
      false に設定すると、デスクトップ向けの結果が返されます
      デフォルト値：false

    • language_code
      型: string | null

      Lighthouse の言語コード
      任意フィールド
      https://api.dataforseo.com/v3/on_page/lighthouse/languages に個別にリクエストすると、検索エンジンの利用可能な言語とその language_code のリストを取得できます
      デフォルト値：
      en

    • language_name
      型: string | null

      Lighthouse の言語名
      任意フィールド
      https://api.dataforseo.com/v3/on_page/lighthouse/languages に個別にリクエストすると、検索エンジンの利用可能な言語とその language_name のリストを取得できます
      デフォルト値：
      English

    • 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&tag=$tag
      注意：pingback_url 内の特殊文字は URL エンコードされます；
      たとえば、# 文字は %23 にエンコードされます。詳細はヘルプセンターをご覧ください

    • tag
      型: string | null

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

    • url
      型: string

      ターゲット URL
      必須フィールド
      ターゲットページは絶対 URL（http:// または https:// を含む）で指定する必要があります
      例：
      https://dataforseo.com/

    • version
      型: string | null

      Lighthouse のバージョン
      任意フィールド
      バージョン番号を指定すると、特定の Lighthouse バージョンの結果を取得できます
      利用可能なバージョンのリストは、Lighthouse Versions エンドポイントから取得できます

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

      タスクの総コスト（USD）

    • status_code
      型: integer | null

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

    • status_message
      型: string | null

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

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

      タスクの配列

      • 型: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo
        • 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
          • propertyName
            型: object | 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/lighthouse/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com",
    "for_mobile": true,
    "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 Lighthouse Tasks

ヘルプが必要ですか？

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