Skip to main content
POST
设置 Google Ads Search SERP 任务
设置 Google Ads 搜索 SERP 任务。返回广告主在 Google Ads 上投放的广告。可获取自 2018-05-31 起的历史数据。仅在设置任务时对您的账户收费。

示例

授权

Authorization
string
header
必填

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

请求体

application/json
advertiser_ids
string[]

advertiser identifiers

required field if target is not specified


you can specify the maximum of 25 values in this array;

advertiser_ids values for this parameter can be found in the Google Ads Advertisers endpoint;

target
string

domain name

required field if advertiser_ids is not specified

domain name associated with an advertiser account

location_code
integer | null

search engine location code

optional field

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/ads_search/locations

example:

2840


Note: if you don't specify location_name, location_code, or location_coordinate, the ads will be searched across all the available locations

depth
integer | null

parsing depth

optional field

number of results in SERP

default value: 40

max value: 700


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

Setting depth above 40 may result in additional charges if the search engine returns more than 40 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.

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 | null

full name of search engine location

optional field

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/ads_search/locations

example:

London,England,United Kingdom


Note: if you don't specify location_name, location_code, or location_coordinate, the ads will be searched across all the available locations

location_coordinate
string | null

GPS coordinates of a location

optional field

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

example:

52.6178549,-155.352142


Note: if you don't specify location_name, location_code, or location_coordinate, the ads will be searched across all the available locations

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

platform
string | null

advertising platform

optional field

possible values: all, google_play, google_maps, google_search, google_shopping, youtube

default value: all

format
string | null

ad format

optional field

possible values: all, text, image, video

date_from
string

starting date of the time range

optional field

required field if date_to is specified;


date format: "yyyy-mm-dd"

minimum value: 2018-05-31

maximum value: today's date

example:

"2020-01-01"

date_to
string

ending date of the time range

optional field

required field if date_from is specified;


date format: "yyyy-mm-dd"

minimum value: 2018-05-31

maximum value: today's date

example:

"2020-01-01"

示例:

响应

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