Skip to main content
POST
Reference example
设置 Google Autocomplete 任务。DataForSEO 根据关键词、光标位置和所选客户端返回 Google Autocomplete 建议。仅在设置任务时向您的账户收费。

示例

费用与请求规则

公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口,执行前请针对完整请求获取免费报价;执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。
  • 默认请求参考估价(USD): 0.02
  • 计费依据: response_usd
  • 公开参考倍率: 1.0
  • 结算证据来源: response_body

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
keyword
string

keyword

required field

you can specify up to 700 characters in the keyword field

all %## will be decoded (plus character ‘+’ will be decoded to a space character)

if you need to use the “%” character for your keyword, please specify it as “%25”;

if you need to use the “+” character for your keyword, please specify it as “%2B”;


learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

location_code
integer

search engine location code

required field if you don't specify location_name;

you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations

example:

2840

language_code
string

search engine language code

required field if you don't specify language_name

if you use this field, you don't need to specify language_name;

you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages

example:

en

cursor_pointer
integer | null

search bar cursor pointer

optional field

the horizontal numerical position of the cursor pointer within the keyword in the search bar;

by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;

minimal value: 0

default value: the number of the last character of the specified keyword

example:

|which query are s - "cursor_pointer": 0

which query is s| - "cursor_pointer": 16

which que|ry is s - "cursor_pointer": 9

priority
integer | null

task priority

optional field

can take the following values:

1 – normal execution priority (set by default);

2 – high execution priority


You will be additionally charged for the tasks with high execution priority;

The cost can be calculated on the Pricing page

pingback_url
string | null

notification URL of a completed task

optional field

when a task is completed we will notify you by GET request sent to the URL you have specified

you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.

example:

http://your-server.com/pingscript?id=$id

http://your-server.com/pingscript?id=$id&tag=$tag

Note: special characters in pingback_url will be urlencoded;

i.a., the # character will be encoded into %23


learn more on our Help Center

postback_url
string | null

URL for sending task results

optional field

once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request

example:

http://your-server.com/postbackscript?id=$id

http://your-server.com/postbackscript?id=$id&tag=$tag

Note: special characters in postback_url will be url-encoded;

i.e., the # character will be encoded into %23


learn more on our Help Center

postback_data
string

postback_url datatype

required field if you specify postback_url

corresponds to the datatype that will be sent to your server

possible values:

advanced

client
string | null

search client for autocomplete

optional field

autocomplete results may differ depending on the search client;

possible values:

chrome — used when google search is opened in google chrome;

chrome-omni — used in the address bar in chrome;

gws-wiz — used in google search home page;

gws-wiz-serp — used in google search engine results page;

safari — used when google search is opened in safari browser;

firefox — used when google search is opened in firefox browser;

psy-ab — may be used when google search is opened in google chrome browser;

toolbar — returns XML;

youtube — returns JSONP;

gws-wiz-local — used in google local;

img — used in google's image search;

products-cc — used in google shopping search

location_name
string

full name of search engine location

required field if you don't specify location_code

if you use this field, you don't need to specify location_code;

you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/autocomplete/locations

example:

London,England,United Kingdom

language_name
string

full name of search engine language

required field if you don't specify language_code

if you use this field, you don't need to specify language_code;

you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/serp/google/languages

example:

English

tag
string | null

user-defined task identifier

optional field

the character limit is 255

you can use this parameter to identify the task and match it with the result

you will find the specified tag value in the data object of the response

示例:

响应

object | null

Successful operation

version
string | null

API 的当前版本

status_code
integer | null

general status code you can find the full list of the response codes here

status_message
string | null

general informational message you can find the full list of general informational messages here

time
string | null

total execution time, seconds

cost
number<double> | null

任务总成本(美元)

tasks_count
integer<int64> | null

tasks 数组中的任务数量

tasks_error
integer<int64> | null

返回错误的 tasks 数组中的任务数量

tasks
(object | null)[] | null

array of tasks