Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"location_code": 2840,
"platform": "google_search",
"advertiser_ids": [
"AR13752565271262920705",
"AR02439908557932462081"
]
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"advertiser_ids": [
"AR13752565271262920705",
"AR02439908557932462081"
],
"location_code": 2840,
"platform": "google_search"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post"
payload = [
{
"advertiser_ids": ["AR13752565271262920705", "AR02439908557932462081"],
"location_code": 2840,
"platform": "google_search"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
advertiser_ids: ['AR13752565271262920705', 'AR02439908557932462081'],
location_code: 2840,
platform: 'google_search'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'advertiser_ids' => [
'AR13752565271262920705',
'AR02439908557932462081'
],
'location_code' => 2840,
'platform' => 'google_search'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post"
payload := strings.NewReader("[\n {\n \"advertiser_ids\": [\n \"AR13752565271262920705\",\n \"AR02439908557932462081\"\n ],\n \"location_code\": 2840,\n \"platform\": \"google_search\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"advertiser_ids\": [\n \"AR13752565271262920705\",\n \"AR02439908557932462081\"\n ],\n \"location_code\": 2840,\n \"platform\": \"google_search\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"advertiser_ids\": [\n \"AR13752565271262920705\",\n \"AR02439908557932462081\"\n ],\n \"location_code\": 2840,\n \"platform\": \"google_search\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": {}
}
]
}Ads Search
Setting Google Ads Search SERP Tasks
Queues the ads running against a keyword on Google, returning a task id in tasks[0].
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
serp
/
google
/
ads_search
/
task_post
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"location_code": 2840,
"platform": "google_search",
"advertiser_ids": [
"AR13752565271262920705",
"AR02439908557932462081"
]
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"advertiser_ids": [
"AR13752565271262920705",
"AR02439908557932462081"
],
"location_code": 2840,
"platform": "google_search"
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post"
payload = [
{
"advertiser_ids": ["AR13752565271262920705", "AR02439908557932462081"],
"location_code": 2840,
"platform": "google_search"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
advertiser_ids: ['AR13752565271262920705', 'AR02439908557932462081'],
location_code: 2840,
platform: 'google_search'
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'advertiser_ids' => [
'AR13752565271262920705',
'AR02439908557932462081'
],
'location_code' => 2840,
'platform' => 'google_search'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post"
payload := strings.NewReader("[\n {\n \"advertiser_ids\": [\n \"AR13752565271262920705\",\n \"AR02439908557932462081\"\n ],\n \"location_code\": 2840,\n \"platform\": \"google_search\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"advertiser_ids\": [\n \"AR13752565271262920705\",\n \"AR02439908557932462081\"\n ],\n \"location_code\": 2840,\n \"platform\": \"google_search\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"advertiser_ids\": [\n \"AR13752565271262920705\",\n \"AR02439908557932462081\"\n ],\n \"location_code\": 2840,\n \"platform\": \"google_search\"\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": {}
}
]
}Queues the ads running against a keyword on Google, returning a task
Your account will be billed per each SERP containing up to 40 results;
id in tasks[0].id. The charge lands here; fetching is free, including re-fetching. Wrapped in DataForSEO’s envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The live twin answers immediately and is simpler for a single query; queue when the batch would outlast a tool call.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"advertiser_ids": "...", "target": "...", "location_name": "..."}]'
Request contract
- Method and path: POST /apis/v1/dataforseo/serp/google/ads_search/task_post
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_post - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_serp_gads_search_submit",
"method": "POST",
"path": "/apis/v1/dataforseo/serp/google/ads_search/task_post",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"advertiser_ids": [
"AR13752565271262920705",
"AR02439908557932462081"
],
"location_code": 2840,
"platform": "google_search"
}
],
"items": {
"oneOf": [
{
"properties": {
"advertiser_ids": {
"description": "<p><em>advertiser identifiers</em><p><strong>required field if <code>target</code> is not specified</strong></p><br><p>you can specify the maximum of 25 values in this array;<p><code>advertiser_ids</code> values for this parameter can be found in the <a href=\"http://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_get/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">Google Ads Advertisers</a> endpoint;</p>",
"items": {
"type": "string"
},
"type": "array"
},
"date_from": {
"description": "<p><em>starting date of the time range</em><p>optional field<p>required field if <code>date_to</code> is specified; </p><br><p>date format: <code>\"yyyy-mm-dd\"</code><p>minimum value: 2018-05-31<p>maximum value: today's date<p>example:<p><code>\"2020-01-01\"</code></p>",
"type": "string"
},
"date_to": {
"description": "<p><em>ending date of the time range</em><p>optional field<p>required field if <code>date_from</code> is specified; </p><br><p>date format: <code>\"yyyy-mm-dd\"</code><p>minimum value: 2018-05-31<p>maximum value: today's date<p>example:<p><code>\"2020-01-01\"</code></p>",
"type": "string"
},
"depth": {
"description": "<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>40</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong><p>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-ads-search-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"integer",
"null"
]
},
"format": {
"description": "<p><em>ad format</em><p>optional field<p>possible values: <code>all</code>, <code>text</code>, <code>image</code>, <code>video</code></p>",
"type": [
"string",
"null"
]
},
"location_code": {
"description": "<p><em>search engine location code</em><p>optional field<p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_search/locations</code><p>example:<p><code class=\"long-string\">2840</code></p><br><p><strong>Note:</strong> if you don't specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>",
"type": [
"integer",
"null"
]
},
"location_coordinate": {
"description": "<p><em>GPS coordinates of a location</em><p>optional field<p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p>example:<p><code class=\"long-string\">52.6178549,-155.352142</code></p><br><p><strong>Note:</strong> if you don't specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>",
"type": [
"string",
"null"
]
},
"location_name": {
"description": "<p><em>full name of search engine location</em><p>optional field<p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_search/locations</code><p>example:<p><code class=\"long-string\">London,England,United Kingdom</code></p><br><p><strong>Note:</strong> if you don't specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>",
"type": [
"string",
"null"
]
},
"pingback_url": {
"description": "<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a></p>",
"type": [
"string",
"null"
]
},
"platform": {
"description": "<p><em>advertising platform</em><p>optional field<p>possible values: <code>all</code>, <code>google_play</code>, <code>google_maps</code>, <code>google_search</code>, <code>google_shopping</code>, <code>youtube</code><p>default value: <code>all</code></p>",
"type": [
"string",
"null"
]
},
"postback_data": {
"description": "<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code></p>",
"type": "string"
},
"postback_url": {
"description": "<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a></p>",
"type": [
"string",
"null"
]
},
"priority": {
"description": "<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/serp/google-ads-search-serp-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
"type": [
"integer",
"null"
]
},
"tag": {
"description": "<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>",
"type": [
"string",
"null"
]
},
"target": {
"description": "<p><em>domain name</em><p><strong>required field if <code>advertiser_ids</code> is not specified</strong><p>domain name associated with an advertiser account</p>",
"type": "string"
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.02,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.02
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
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;
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"
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"
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.
ad format
optional field
possible values: all, text, image, video
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
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
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
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
advertising platform
optional field
possible values: all, google_play, google_maps, google_search, google_shopping, youtube
default value: all
postback_url datatype
required field if you specify postback_url
corresponds to the function you used for setting a task
possible values:
advanced
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
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
domain name
required field if advertiser_ids is not specified
domain name associated with an advertiser account
Example:
[ { "advertiser_ids": [ "AR13752565271262920705", "AR02439908557932462081" ], "location_code": 2840, "platform": "google_search" } ]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes