# ライブ Google AI Mode SERP HTML

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/google/ai_mode/live/html`

**Tags:** DataForSEO

クエリに対する Google の AI Mode の回答と、その引用元を同期的に返します。解析済みの結果ではなく、生のページソースを返します。DataForSEO のエンベロープに包まれます。データは `tasks[0].result`、結果は `tasks[0].status_code` に格納され、拒否されたリクエストでも HTTP 200 が返ります。

### 料金の参考情報

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

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

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "keyword": {
            "type": "string",
            "description": "<em>キーワード</em><br><strong>必須フィールド</strong><br><code>keyword</code> フィールドには最大 <strong>700 文字</strong>を指定できます<br>すべての %## はデコードされます（「+」文字はスペース文字にデコードされます）<br><code>keyword</code> に「%」文字を使用する場合は「%25」と指定してください。<br><code>keyword</code> に「+」文字を使用する場合は「%2B」と指定してください。"
          },
          "location_name": {
            "type": "string",
            "description": "<em>検索エンジンのロケーションの正式名</em><br><strong><code>location_code</code> または <code>location_coordinate</code> を指定しない場合は必須フィールド</strong><br><strong>このフィールドを使用する場合、<code>location_code</code> または <code>location_coordinate</code> を指定する必要はありません</strong><br><code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code> に個別にリクエストすると、検索エンジンで利用可能なロケーションとその <code>location_name</code> の一覧を取得できます<br>例：<br><code class=\"long-string\">London,England,United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>検索エンジンのロケーションコード</em><br><strong><code>location_name</code> または <code>location_coordinate</code> を指定しない場合は必須フィールド</strong><br><strong>このフィールドを使用する場合、<code>location_name</code> または <code>location_coordinate</code> を指定する必要はありません</strong><br><code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code> に個別にリクエストすると、検索エンジンで利用可能なロケーションとその <code>location_code</code> の一覧を取得できます<br>例：<br><code class=\"long-string\">2840</code>"
          },
          "location_coordinate": {
            "type": "string",
            "description": "<em>ロケーションの GPS 座標</em><br><strong><code>location_name</code> または <code>location_code</code> を指定しない場合は必須フィールド</strong><br><strong>このフィールドを使用する場合、<code>location_name</code> または <code>location_code</code> を指定する必要はありません</strong><br><code>location_coordinate</code> パラメータは <em>\"latitude,longitude,radius\"</em> 形式で指定します<br><em>\"latitude\"</em> と <em>\"longitude\"</em> の小数点以下の最大桁数：7<br><em>\"radius\"</em> の最小値：199.9（mm）<br><em>\"radius\"</em> の最大値：199999（mm）<br>例：<br><code class=\"long-string\">53.476225,-2.243572,200</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>検索エンジンの言語の正式名</em><br><code>language_code</code> を指定しない場合は必須フィールドです。<br>このフィールドを使用する場合、<code>language_code</code> を指定する必要はありません。<br><code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code> に個別にリクエストすると、検索エンジンで利用可能な言語とその <code>language_name</code> の一覧を取得できます。"
          },
          "language_code": {
            "type": "string",
            "description": "<em>検索エンジンの言語コード</em><br><code>language_name</code> を指定しない場合は必須フィールドです。<br>このフィールドを使用する場合、<code>language_name</code> を指定する必要はありません。<br><code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code> に個別にリクエストすると、検索エンジンで利用可能な言語とその <code>language_code</code> の一覧を取得できます"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>デバイスの種類</em><br>任意フィールド<br>特定のデバイスの種類の結果を返します<br>次のいずれかの値を指定できます：<code>desktop</code>、<code>mobile</code><br>デフォルト値：<code>desktop</code>"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>デバイスのオペレーティングシステム</em><br>任意フィールド<br><code>device</code> フィールドに <code>desktop</code> を指定した場合は、次の値から選択します：<code>windows</code>、<code>macos</code><br>デフォルト値：<code>windows</code><br><code>device</code> フィールドに <code>mobile</code> を指定した場合は、次の値から選択します：<code>android</code>、<code>ios</code><br>デフォルト値：<code>android</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>ユーザー定義のタスク識別子</em><br>任意フィールド<br><em>文字数上限は 255 です</em><br>このパラメーターを使ってタスクを識別し、結果と照合できます<br>指定した <code>tag</code> の値は、レスポンスの <code>data</code> オブジェクトに含まれます"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "albert einstein"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "albert einstein"
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResponseInfo"
    }
  ]
}
```

### 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_HtmlItemInfo

`#/components/schemas/Response36Afe1097B20_HtmlItemInfo`

```json
{
  "type": "object",
  "properties": {
    "page": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<i>返された HTML ページのシリアル番号</i>"
    },
    "date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>HTML ページがスキャンされた日時</em><br>UTC 形式：“yyyy-mm-dd hh-mm-ss +00:00”<br>例：<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "html": {
      "type": [
        "string",
        "null"
      ],
      "description": "<i>HTML</i> <i>ページ</i>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResponseInfo`

```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_SerpGoogleAiModeLiveHtmlTaskInfo"
              }
            ]
          },
          "description": "<em>タスクの配列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResultInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列で受信したキーワード<br></em><strong>キーワードはデコードされた %## で返されます（プラス文字 '+' はスペース文字にデコードされます）</strong>"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "要素の種類"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列内の検索エンジンドメイン</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 配列内のロケーションコード</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 配列内の言語コード</em>"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>結果を受信した日時</em><br>UTC 形式：“yyyy-mm-dd hh-mm-ss +00:00”<br>例：<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><strong><code>items</code></strong> 配列で返された結果数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_HtmlItemInfo"
          }
        ]
      },
      "description": "<em>SERP で見つかった検索結果の要素</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleAiModeLiveHtmlTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResultInfo"
              }
            ]
          },
          "description": "<em>結果の配列</em>"
        }
      }
    }
  ]
}
```
