# 实时 Google 数据集搜索高级版

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/google/dataset_search/live/advanced`

**Tags:** DataForSEO

同步返回 Google 数据集搜索中与查询匹配的数据集。返回 `keyword`、`type`、`se_domain`、`location_code`、`language_code`、`check_url`、`datetime`、`spell`、`refinement_chips`、`item_types`、`items_count` 和 `items`。`advanced` 为默认选项；若只关心排名列表，请使用 `regular`；只有在需要检查解析器丢弃了什么时才用 `html`。采用 DataForSEO 的信封结构：数据位于 `tasks[0].result`，结果状态位于 `tasks[0].status_code`——被拒绝的请求仍会返回 HTTP 200。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.02 美元。
- 参考客户倍率：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": "<p><em>keyword</em><p><strong>必填字段</strong><p>在 <code>keyword</code> 字段中最多可指定 <strong>700 个字符</strong><p>所有 %## 都将被解码（另外，字符 ‘+’ 会被解码为空格）<p>如果需要在 <code>keyword</code> 中使用 “%” 字符，请将其指定为 “%25”；<p>如果需要在 <code>keyword</code> 中使用 “+” 字符，请将其指定为 “%2B”；</p><br><p>有关 DataForSEO API 中 <code>keyword</code> 和 <code>keywords</code> 字段的规则与限制，请参阅这篇 <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">帮助中心文章</a></p>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>搜索引擎语言代码</em><p>未指定 <code>language_name</code> 时为可选字段<p>如果使用此字段，则无需指定 <code>language_name</code><p>可能的值：<p><code class=\"long-string\">en</code></p>"
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<p><em>解析深度</em><p>可选字段<p>SERP 中的结果数量<p>默认值：<code>20</code><p>最大值：<code>200</code></p><br><strong>每个最多包含 20 条结果的 SERP 都会计入你的账户费用；</strong><p>如果搜索引擎返回超过 20 条结果，将深度设为 20 以上可能会产生额外费用；<p>如果指定的深度高于响应中的结果数量，差额将自动退还到你的账户余额。"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>设备类型</em><p>可选字段<p>返回特定设备类型的结果<p>可能的值：<code>desktop</code></p>"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>搜索引擎语言全名</em><p>可选字段<p>如果使用此字段，则无需指定 <code>language_code</code><p>可能的值：<p><code class=\"long-string\">English</code></p>"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>设备操作系统</em><p>可选字段<p>从以下值中选择：<code>windows</code>、<code>macos</code><p>默认值：<code>windows</code></p>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>用户自定义任务标识符</em><p>可选字段<p><em>字符数上限为 255</em><p>可使用此参数标识任务，并将其与结果对应<p>指定的 <code>tag</code> 值可在响应的 <code>data</code> 对象中找到</p>"
          },
          "last_updated": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>数据集上次更新时间</em><p>可选字段<p>可能的值：<code>1m</code>、<code>1y</code>、<code>3y</code></p>"
          },
          "file_formats": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<p><em>数据集的文件格式</em><p>可选字段<p>可能的值：<code>other</code>、<code>archive</code>、<code>text</code>、<code>image</code>、<code>document</code>、<code>tabular</code></p>"
          },
          "usage_rights": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>数据集的使用权</em><p>可选字段<p>可能的值：<code>commercial</code>、<code>noncommercial</code></p>"
          },
          "is_free": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<p><em>表示显示的数据集是否免费</em><p>可选字段<p>可能的值：<code>true</code>、<code>false</code></p>"
          },
          "topics": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<p><em>数据集主题</em><p>可选字段<p>可能的值：<code>humanities</code>、<code>social_sciences</code>、<code>life_sciences</code>、<code>agriculture</code>、<code>natural_sciences</code>、<code>geo</code>、<code>computer</code>、<code>architecture_and_urban_planning</code>、<code>engineering</code></p>"
          }
        },
        "example": [
          {
            "keyword": "water quality",
            "last_updated": "1m",
            "file_formats": [
              "archive",
              "image"
            ],
            "usage_rights": "noncommercial",
            "is_free": true,
            "topics": [
              "natural_sciences",
              "geo"
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keyword": "water quality",
      "last_updated": "1m",
      "file_formats": [
        "archive",
        "image"
      ],
      "usage_rights": "noncommercial",
      "is_free": true,
      "topics": [
        "natural_sciences",
        "geo"
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

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

### 400 — 无法处理该请求。请检查请求参数。

### 401 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AmazonLabelElement

`#/components/schemas/Response36Afe1097B20_AmazonLabelElement`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素的标题"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "带细化参数的搜索 URL"
    },
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "SERP 中的域名"
    }
  }
}
```

### Response36Afe1097B20_AuthorsElement

`#/components/schemas/Response36Afe1097B20_AuthorsElement`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "数据集作者的名称"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "作者的链接 URL"
    },
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "作者的链接域名"
    }
  }
}
```

### 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": "任务总费用，美元",
      "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": "任务的状态码\n由 DataForSEO 生成，范围如下：10000-60000\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务的信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "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_Dataset

`#/components/schemas/Response36Afe1097B20_Dataset`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "rank_group": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>SERP 中的组内排名</em><br>在具有相同 <code>type</code> 值的元素组内的位置<br>具有不同 <code>type</code> 值的元素位置不包含在 <code>rank_group</code> 中"
    },
    "rank_absolute": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>SERP 中的绝对排名</em><br>SERP 中所有元素中的绝对位置"
    },
    "position": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>元素在 SERP 中的对齐方式</em><br>可取以下值：<br><code>left</code>、<code>right</code>"
    },
    "xpath": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>元素的 <a href=\"https://en.wikipedia.org/wiki/XPath\" rel=\"noopener noreferrer\" target=\"_blank\">XPath</a></em>"
    },
    "dataset_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>数据集的 ID</em>"
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>元素的标题</em>"
    },
    "image_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>图片的 URL</em><br>指向原始资源或 DataForSEO 存储中该图片的 URL（原始来源不可用时）"
    },
    "scholarly_citations_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>引用该数据集的文章数量</em>",
      "format": "int64"
    },
    "scholarly_articles_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>学术文章的 URL</em><br>指向 Google Scholar 上学术文章列表的链接 <br>示例：<code>https://scholar.google.com/scholar?q=%2210.6084%20m9%20figshare%207427933%20v1%22</code>"
    },
    "unique_identifier": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>对象的数字标识符</em><br>该数据集的唯一数字标识符 <br>示例：<code>https://doi.org/10.5061/dryad.hmgqnk9m3</code>"
    },
    "related_article": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>相关文章的链接</em><br>指向与该数据集相关的已发表文章的链接"
    },
    "links": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_LinkElement"
          }
        ]
      },
      "description": "<em>站点链接</em><br>显示在某些 Google 数据集搜索结果下方的链接<br>若没有，则等于 <code>null</code>"
    },
    "dataset_providers": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AmazonLabelElement"
          }
        ]
      },
      "description": "<em>提供该数据集的机构列表</em>"
    },
    "formats": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_FormatsElement"
          }
        ]
      },
      "description": "<em>数据集的文件格式列表</em>"
    },
    "authors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AuthorsElement"
          }
        ]
      },
      "description": "<em>数据集的作者列表</em>"
    },
    "licenses": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AmazonLabelElement"
          }
        ]
      },
      "description": "<em>授予该数据集的许可列表</em>"
    },
    "updated_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>结果上次更新的日期和时间</em><br>采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>示例：<br><code class=\"long-string\">2022-11-27 02:00:00 +00:00</code>"
    },
    "area_covered": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>数据集涵盖的区域列表</em><br>示例：<code>Africa</code>、<code>Global</code>"
    },
    "period_covered": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_PeriodCovered"
        }
      ],
      "description": "<em>数据集涵盖的时期</em>"
    },
    "dataset_description": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_DatasetDescription"
        }
      ],
      "description": "<em>数据集的描述</em>"
    }
  }
}
```

### Response36Afe1097B20_DatasetDescription

`#/components/schemas/Response36Afe1097B20_DatasetDescription`

```json
{
  "type": "object",
  "properties": {
    "text": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>描述的文本</em>"
    },
    "links": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_LinkElement"
          }
        ]
      },
      "description": "<em>'dataset_description' 中展示的链接</em>"
    }
  }
}
```

### Response36Afe1097B20_FormatsElement

`#/components/schemas/Response36Afe1097B20_FormatsElement`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "format": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>数据集的文件格式类型</em><br>示例：<code>zip</code>、<code>html</code>、<code>csv</code>"
    },
    "size": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>文件大小，单位为字节</em>",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_LinkElement

`#/components/schemas/Response36Afe1097B20_LinkElement`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "指定链接元素的标题"
    },
    "snippet": {
      "type": [
        "string",
        "null"
      ],
      "description": "链接标题旁边的文字"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "结果元素的描述"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "URL"
    },
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "链接指向的域名"
    },
    "xpath": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素的 XPath"
    }
  }
}
```

### Response36Afe1097B20_PeriodCovered

`#/components/schemas/Response36Afe1097B20_PeriodCovered`

```json
{
  "type": "object",
  "properties": {
    "start_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>时间段开始的日期和时间</em><br>采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>示例：<br><code class=\"long-string\">2020-03-02 02:00:00 +00:00</code>"
    },
    "end_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>时间段结束的日期和时间</em><br>采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>示例：<br><code class=\"long-string\">2022-12-09 02:00:00 +00:00</code>"
    },
    "displayed_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>SERP 中显示的时间段</em><br>示例：<br><code class=\"long-string\">Mar 2, 2020 - Dec 9, 2022</code>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleDatasetSearchLiveAdvancedResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleDatasetSearchLiveAdvancedResponseInfo`

```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_SerpGoogleDatasetSearchLiveAdvancedTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpGoogleDatasetSearchLiveAdvancedResultInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleDatasetSearchLiveAdvancedResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中收到的关键词<br></em><strong>返回的关键词已解码 %##（加号字符 '+' 会被解码为空格字符）</strong>"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的搜索引擎域名</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的语言代码</em>"
    },
    "check_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎结果的直接 URL</em><br>可用于确保我们提供了准确的结果"
    },
    "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>"
    },
    "spell": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_SpellInfo"
        }
      ],
      "description": "<em>搜索引擎的自动更正</em><br>如果搜索引擎为经过更正的关键词提供了结果，我们将指明搜索引擎更正后的关键词以及自动更正的类型"
    },
    "item_types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>SERP 中的搜索结果类型</em><br>包含在 SERP 中找到的搜索结果类型（<code>items</code>）。<br>可能的条目类型：<code>dataset</code>"
    },
    "se_results_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em> SERP 中的结果总数</em>",
      "format": "int64"
    },
    "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_Dataset"
          }
        ]
      },
      "description": "<em>元素的条目</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleDatasetSearchLiveAdvancedTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleDatasetSearchLiveAdvancedTaskInfo`

```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_SerpGoogleDatasetSearchLiveAdvancedResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SpellInfo

`#/components/schemas/Response36Afe1097B20_SpellInfo`

```json
{
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "搜索引擎自动更正后得到的关键词\n 将为更正后的关键词提供结果"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "自动更正的类型\n 可能的值：\n did_you_mean、showing_results_for、no_results_found_for、including_results_for\n 注意：Yahoo 和 Yandex 仅支持以下自动更正类型：\n including_results_for"
    }
  }
}
```
