# 设置 Google 自动补全任务

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/google/autocomplete/task_post`

**Tags:** DataForSEO

将 Google 上输入查询时提供的自动补全建议排入队列，返回 `tasks[0].id` 中的任务 `id`。采用 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>"
          },
          "location_code": {
            "type": "integer",
            "description": "<p><em>搜索引擎地点代码</em><p><strong>未指定 <code>location_name</code> 时为必填字段</strong>；<p>可单独向 <code>https://api.dataforseo.com/v3/serp/google/locations</code> 发起请求，获取搜索引擎的可用地点及其 <code>location_code</code> 列表<p>示例：<p><code class=\"long-string\">2840</code></p>"
          },
          "language_code": {
            "type": "string",
            "description": "<p><em>搜索引擎语言代码</em><p><strong>未指定 <code>language_name</code> 时为必填字段</strong><p><strong>如果使用此字段，则无需指定 <code>language_name</code></strong>；<p>可单独向 <code>https://api.dataforseo.com/v3/serp/google/languages</code> 发起请求，获取搜索引擎的可用语言及其 <code>language_code</code>&nbsp;列表<em><p></em>示例：<em><p></em><code class=\"long-string\">en</code></p>"
          },
          "cursor_pointer": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<p><em>搜索栏光标位置</em><p>可选字段<p>光标在搜索栏关键词中的水平数值位置；<p>通过修改光标位置，同一初始关键词会得到不同的自动补全建议；<p>最小值：<code>0</code><p>默认值：指定 <code>keyword</code> 最后一个字符的位置<p>示例：<p><code>|which query are s</code> - <code>\"cursor_pointer\": 0</code><p><code>which query is s|</code> - <code>\"cursor_pointer\": 16</code><p><code>which que|ry is s</code> - <code>\"cursor_pointer\": 9</code></p>"
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<p><em>任务优先级</em><p>可选字段<p>可取以下值：<p>1 – 正常执行优先级（默认设置）；<p>2 – 高执行优先级</p><br>高执行优先级的任务将额外收费；<p>费用可在 <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-autocomplete-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">价格页</a>计算"
          },
          "pingback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>任务完成通知 URL</em><p>可选字段<p>任务完成后，我们会向你指定的 URL 发送 GET 请求进行通知<p>可将 ‘$id’ 字符串用作 <code>$id</code> 变量，将 ‘$tag’ 用作经 URL 编码的 <code>$tag</code> 变量。发送请求前我们会设置必要的值。<p>示例：<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>注意：</strong><code>pingback_url</code> 中的特殊字符会进行 URL 编码；<p>例如，<code>#</code> 字符会被编码为 <code>%23</code></p><br><p>详情请参阅我们的<a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">帮助中心</a></p>"
          },
          "postback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>用于发送任务结果的 URL</em><p>可选字段<p>任务完成后，我们会将其结果以 <code>gzip</code> 格式压缩，并向你指定的 <code>postback_url</code> 发送 POST 请求<p>可将 ‘$id’ 字符串用作 <code>$id</code> 变量，将 ‘$tag’ 用作经 URL 编码的 <code>$tag</code> 变量。发送请求前我们会设置必要的值<p>示例：<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>注意：</strong><code>postback_url</code> 中的特殊字符会进行 URL 编码；<p>即，<code>#</code> 字符会被编码为 <code>%23</code></p><br><p>详情请参阅我们的 <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">帮助中心</a></p>"
          },
          "postback_data": {
            "type": "string",
            "description": "<p><em>postback_url 数据类型</em><p><strong>指定 <code>postback_url</code> 时为必填字段</strong><p>对应将发送到你服务器的数据类型<p>可能的值：<p><code>advanced</code></p>"
          },
          "client": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>自动补全的搜索客户端</em><p>可选字段<p>自动补全结果可能因搜索客户端而异；<p>可能的值：<p><code>chrome</code> — 在 Google Chrome 中打开 Google 搜索时使用；<p><code>chrome-omni</code> — 在 Chrome 的地址栏中使用；<p><code>gws-wiz</code> — 在 Google 搜索首页使用；<p><code>gws-wiz-serp</code> — 在 Google 搜索结果页使用；<p><code>safari</code> — 在 Safari 浏览器中打开 Google 搜索时使用；<p><code>firefox</code> — 在 Firefox 浏览器中打开 Google 搜索时使用；<p><code>psy-ab</code> — 在 Google Chrome 浏览器中打开 Google 搜索时可能会使用；<p><code>toolbar</code> — 返回 XML；<p><code>youtube</code> — 返回 JSONP；<p><code>gws-wiz-local</code> — 在 Google 本地搜索中使用；<p><code>img</code> — 在 Google 图片搜索中使用；<p><code>products-cc</code> — 在 Google 购物搜索中使用</p>"
          },
          "location_name": {
            "type": "string",
            "description": "<p><em>搜索引擎地点全名</em><p><strong>未指定 <code>location_code</code> 时为必填字段</strong><p><strong>如果使用此字段，则无需指定 <code>location_code</code></strong>；<p>可单独向 <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code> 发起请求，获取搜索引擎的可用地点及其 <code>location_name</code> 列表<p>示例：<p><code class=\"long-string\">London,England,United Kingdom</code></p>"
          },
          "language_name": {
            "type": "string",
            "description": "<p><em>搜索引擎语言全名</em><p><strong>未指定 <code>language_code</code> 时为必填字段</strong><p><strong>如果使用此字段，则无需指定 <code>language_code</code></strong>；<p>可单独向 <code>https://api.dataforseo.com/v3/serp/google/languages</code> 发起请求，获取搜索引擎的可用语言及其 <code>language_name</code> 列表<p>示例：<p><code class=\"long-string\">English</code></p>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<p><em>用户自定义任务标识符</em><p>可选字段<p><em>字符数上限为 255</em><p>可使用此参数标识任务，并将其与结果对应<p>指定的 <code>tag</code> 值可在响应的 <code>data</code> 对象中找到</p>"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "albert einstein",
            "cursor_pointer": 6
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "albert einstein",
      "cursor_pointer": 6
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

### 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": "任务总费用，美元",
      "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_SerpGoogleAutocompleteTaskPostResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAutocompleteTaskPostResponseInfo`

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

### Response36Afe1097B20_SerpGoogleAutocompleteTaskPostTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAutocompleteTaskPostTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "object",
            "null"
          ],
          "description": "<em>结果数组</em><br>在本例中，该值将为 <code>null</code>"
        }
      }
    }
  ]
}
```
