Skip to main content
POST
设置 Google Maps SERP 任务
设置 Google Maps SERP 任务。您的账户仅在设置任务时付费。每次 POST 调用最多可发送 100 个任务,之后可通过任务 id 或 postback/pingback 获取已完成的结果。

示例

授权

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/{{low_se_name}}/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/{{low_se_name}}/languages

example:

en

depth
integer | null

parsing depth

optional field

number of results in SERP

default value: 100

max value: 700


Your account will be billed per each SERP containing up to 100 results;

Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;

The cost can be calculated on the Pricing page.

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

note: for mobile device, only 20 results are returned for every SERP

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

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/{{low_se_name}}/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 the https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages

example:

English

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

max_crawl_pages
integer | null

page crawl limit

optional field

number of search results pages to crawl

max value: 100

Note: the max_crawl_pages and depth parameters complement each other;

learn more at our help center

url
string | null

direct URL of the search query

optional field

you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.

example:

https://google.com/maps/search/pizza/@37.09024,-95.712891,4z


Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: allinanchor:, allintext:, allintitle:, allinurl:, cache:, define:, definition:, filetype:, id:, inanchor:, info:, intext:, intitle:, inurl:, link:, site:.
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, 17z will be applied as a default value

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

the minimum value for "zoom": 3z

the maximum value for "zoom": 21z

example:

52.6178549,-155.352142,20z

se_domain
string | null

search engine domain

optional field

we choose the relevant search engine domain automatically according to the location and language you specify

however, you can set a custom search engine domain in this field

example:

google.co.uk

search_this_area
boolean | null

show results from the displayed area

optional field

can take the values:true, false

default value: true

if set to false, the search_this_area mode will be turned off

Note: if the search_this_area mode is turned off, Google Maps listings might contain results beyond the displayed area

search_places
boolean | null

search places mode

optional field

the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)

however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;

to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to false;default value: true

Note: if the search_places mode is turned off and no results were found in the search area, the results array will be empty

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