Skip to main content
POST
设置 Google AI Mode SERP 任务
Google AI Mode SERP API 提供来自 Google Search AI Mode 功能的搜索结果。发送 JSON 任务数组;每次 POST 调用最多可提交 100 个任务。稍后可通过 id、postback_url 或 pingback_url 获取已完成的任务。

示例

授权

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 or location_coordinate

if you use this field, you don't need to specify location_name or location_coordinate

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

Note: check Google Search Help for the list of countries where AI Mode is currently available

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/ai_mode/languages

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.

device
string | null

device type

optional field

return results for a specific device type

can take the values:desktop, mobile

default value: desktop

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 urlencoded;

i.a., 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 function you used for setting a task

possible values:

advanced, html

location_name
string

full name of search engine location

required field if you don't specify location_code or location_coordinate

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

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

Note: check Google Search Help for the list of countries where AI Mode is currently available

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 the https://api.dataforseo.com/v3/serp/google/ai_mode/languages;

os
string | null

device operating system

optional field

if you specify desktop in the device field, choose from the following values: windows, macos

default value: windows

if you specify mobile in the device field, choose from the following values: android, ios

default value: android

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

calculate_rectangles
boolean | null

calculate pixel rankings for SERP elements in advanced results

optional field

pixel ranking refers to the distance between the result snippet and top left corner of the screen;

Visit Help Center to learn more>>

by default, the parameter is set to false

Note: if set to true, the charge per task will be multiplied by 2

browser_screen_width
integer<int64> | null

browser screen width

optional field

you can set a custom browser screen width to calculate pixel rankings for a particular device;

can be specified within the following range: 240-9999;

by default, the parameter is set to:

1920 for desktop;

360 for mobile on android;

375 for mobile on iOS;

Note: to use this parameter, set calculate_rectangles to true

browser_screen_height
integer | null

browser screen height

optional field

you can set a custom browser screen height to calculate pixel rankings for a particular device;

can be specified within the following range: 240-9999;

by default, the parameter is set to:

1080 for desktop;

640 for mobile on android;

812 for mobile on iOS;

Note: to use this parameter, set calculate_rectangles to true

browser_screen_resolution_ratio
integer | null

browser screen resolution ratio

optional field

you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;

can be specified within the following range: 0.5-3;

by default, the parameter is set to:

1 for desktop;

3 for mobile on android;

3 for mobile on iOS;

Note: to use this parameter, set calculate_rectangles to true

location_coordinate
string

GPS coordinates of a location

required field if you don't specify location_name or location_code

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

location_coordinate parameter should be specified in the "latitude,longitude,zoom" format

if "zoom" is not specified, 9z will be applied as a default value

the maximum number of decimal digits for "latitude" and "longitude": 7

the minimum value for "zoom": 4z

the maximum value for "zoom": 18z

example:

52.6178549,-155.352142,18z

示例:

响应

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