Get ‘Google AdWords Ads Traffic By Platforms’ Results by id
Google AdWords Keywords Data API is a legacy version that is replaced by Google Ads API. If you’re using DataForSEO Google AdWords API, you need to migrate to DataForSEO Google Ads API.
You can receive a set of stats for a group of keywords and get daily impressions, CPC and clicks estimation for the following platforms: desktop/mobile/tablet.
Note that Google AdWords API results might differ from the estimates you see in the Keyword Planner tool. Google provides account-specific results based on ad history, creatives already in the account, and other factors. Use high bid to level other factors.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access \
login="login" \
password="password" \
cred="$(printf ${login}:${password} | base64)" \
id="02031639-0696-0112-0000-21d6ab6aa8f9" \
curl --location --request GET "https://api.dataforseo.com/v3/keywords_data/google/ad_traffic_by_platforms/task_get/${id}" \
--header "Authorization: Basic ${cred}" \
--header "Content-Type: application/json" \
--data-raw ""
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
$client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
echo "\n";
print "HTTP code: {$e->getHttpCode()}\n";
print "Error code: {$e->getCode()}\n";
print "Message: {$e->getMessage()}\n";
print $e->getTraceAsString();
echo "\n";
exit();
}
try {
$result = array();
// #1 - using this method you can get a list of completed tasks
// the full list of possible parameters is available in documentation
// GET /v3/keywords_data/google/{{low_se_type_under}}/tasks_ready
$tasks_ready = $client->get('/v3/keywords_data/google/{{low_se_type_under}}/tasks_ready');
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) {
foreach ($tasks_ready['tasks'] as $task) {
if (isset($task['result'])) {
foreach ($task['result'] as $task_ready) {
// #2 - using this method you can get results of each completed task
// GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
if (isset($task_ready['endpoint'])) {
$result[] = $client->get($task_ready['endpoint']);
}
// #3 - another way to get the task results by id
// GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
/*
if (isset($task_ready['id'])) {
$result[] = $client->get('/v3/keywords_data/google/{{low_se_type_under}}/task_get/' . $task_ready['id']);
}
*/
}
}
}
}
print_r($result);
// do something with result
} catch (RestClientException $e) {
echo "\n";
print "HTTP code: {$e->getHttpCode()}\n";
print "Error code: {$e->getCode()}\n";
print "Message: {$e->getMessage()}\n";
print $e->getTraceAsString();
echo "\n";
}
$client = null;
?>
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
# 1 - using this method you can get a list of completed tasks
# in addition to '{{low_se_type_under}}' you can also set other parameters
# the full list of possible parameters is available in documentation
# GET /v3/keywords_data/google/{{low_se_type_under}}/tasks_ready
response = client.get("/v3/keywords_data/google/{{low_se_type_under}}/tasks_ready")
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response['status_code'] == 20000:
results = []
for task in response['tasks']:
if (task['result'] and (len(task['result']) > 0)):
for resultTaskInfo in task['result']:
# 2 - using this method you can get results of each completed task
# GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
if(resultTaskInfo['endpoint']):
results.append(client.get(resultTaskInfo['endpoint']))
'''
# 3 - another way to get the task results by id
# GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
if(resultTaskInfo['id']):
results.append(client.get("/v3/keywords_data/google/{{low_se_type_under}}/task_get/" + resultTaskInfo['id']))
'''
print(results)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task keywords_data_task_get()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
// #1 - using this method you can get a list of completed tasks
// in addition to '{{low_se_type_under}}' you can also set other parameters
// the full list of possible parameters is available in documentation
// GET /v3/keywords_data/google/{{low_se_type_under}}/tasks_ready
var response = await httpClient.GetAsync("/v3/keywords_data/google/{{low_se_type_under}}/tasks_ready");
var tasksInfo = JsonConvert.DeserializeObject<dynamic>(await response.Content.ReadAsStringAsync());
var tasksResponses = new List<object>();
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (tasksInfo.status_code == 20000)
{
if (tasksInfo.tasks != null)
{
foreach (var tasks in tasksInfo.tasks)
{
if (tasks.result != null)
{
foreach (var task in tasks.result)
{
if (task.endpoint != null)
{
// #2 - using this method you can get results of each completed task
// GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
var taskGetResponse = await httpClient.GetAsync((string)task.endpoint);
var taskResultObj = JsonConvert.DeserializeObject<dynamic>(await taskGetResponse.Content.ReadAsStringAsync());
if (taskResultObj.tasks != null)
{
var fst = taskResultObj.tasks.First;
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (fst.status_code >= 40000 || fst.result == null)
Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
else
tasksResponses.Add(fst.result);
}
// #3 - another way to get the task results by id
// GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
/*
var tasksGetResponse = await httpClient.GetAsync("/v3/keywords_data/google/{{low_se_type_under}}/task_get/" + (string)task.id);
var taskResultObj = JsonConvert.DeserializeObject<dynamic>(await tasksGetResponse.Content.ReadAsStringAsync());
if (taskResultObj.tasks != null)
{
var fst = taskResultObj.tasks.First;
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (fst.status_code >= 40000 || fst.result == null)
Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
else
tasksResponses.Add(fst.result);
}
*/
}
}
}
}
}
if (tasksResponses.Count > 0)
// do something with result
Console.WriteLine(String.Join(Environment.NewLine, tasksResponses));
else
Console.WriteLine("No completed tasks");
}
else
Console.WriteLine($"error. Code: {tasksInfo.status_code} Message: {tasksInfo.status_message}");
}
}
}
The above command returns JSON structured like this:
task identifier unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
Field name
Type
Description
version
string
the current version of the API
status_code
integer
general status code
you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message
string
general informational message
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
total tasks cost, USD
tasks_count
integer
the number of tasks in the tasks array
tasks_error
integer
the number of tasks in the tasks array returned with an error
tasks
array
array of tasks
id
string
task identifier unique task identifier in our system in the UUID format
status_code
integer
status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of response codes here
status_message
string
informational message of the task
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
cost of the task, USD
result_count
integer
number of elements in the result array
path
array
URL path
data
object
contains the same parameters that you specified in the POST request
result
array
array of results
desktop
object
results for desktop
location_code
integer
location code in a POST array
if there is no data, then the value is null
language_code
string
language code in a POST array
if there is no data, then the value is null
bid
float
the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher positions and price you receive in response
learn more in this help center article
keyword
string
keyword in a POST array
match
string
keywords match-type
can take the following values: exact, broad, phrase
ad_position_min
float
the minimum ad position
represents the minimum position of the advertisement
if there is no data, then the value is null
ad_position_max
float
the maximum ad position
represents the maximum position of the advertisement
if there is no data, then the value is null
ad_position_average
float
the average ad position
represents the average position of the advertisement
if there is no data, then the value is null
cpc_min
float
the minimum value of cost-per-click
represents the minimum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
cpc_max
float
the maximum value of cost-per-click
represents the maximum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
cpc_average
float
the average value of cost-per-click
represents the average cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
daily_impressions_min
float
the minimum value of daily impressions
represents the minimum number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_impressions_max
float
the maximum value of daily impressions
represents the maximum number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_impressions_average
float
the average value of daily impressions
represents the average number number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_clicks_min
float
the minimum value of daily clicks
represents the minimum number of daily clicks on the advertisement
if there is no data, then the value is null
daily_clicks_max
float
the maximum value of daily clicks
represents the maximum number of daily clicks on the advertisement
if there is no data, then the value is null
daily_clicks_average
float
the average value of daily clicks
represents the average number of daily clicks on the advertisement
if there is no data, then the value is null
daily_cost_min
float
the minimum daily charge value
represents the minimum daily charge for the advertisement (USD)
if there is no data, then the value is null
daily_cost_max
float
the maximum daily charge value
represents the maximum daily charge for the advertisement (USD)
if there is no data, then the value is null
daily_cost_average
float
the average daily charge value
represents the average daily charge for the advertisement (USD)
if there is no data, then the value is null
mobile
object
results for mobile
location_code
integer
location code in a POST array
if there is no data, then the value is null
language_code
string
language code in a POST array
if there is no data, then the value is null
bid
float
the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher positions and price you receive in response
learn more in this help center article
keyword
string
keyword keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
match
string
keywords match-type
can take the following values: exact, broad, phrase
ad_position_min
float
the minimum ad position
represents the minimum position of the advertisement
if there is no data, then the value is null
ad_position_max
float
the maximum ad position
represents the maximum position of the advertisement
if there is no data, then the value is null
ad_position_average
float
the average ad position
represents the average position of the advertisement
if there is no data, then the value is null
cpc_min
float
the minimum value of cost-per-click
represents the minimum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
cpc_max
float
the maximum value of cost-per-click
represents the maximum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
cpc_average
float
the average value of cost-per-click
represents the average cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
daily_impressions_min
float
the minimum value of daily impressions
represents the minimum number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_impressions_max
float
the maximum value of daily impressions
represents the maximum number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_impressions_average
float
the average value of daily impressions
represents the average number number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_clicks_min
float
the minimum value of daily clicks
represents the minimum number of daily clicks on the advertisement
if there is no data, then the value is null
daily_clicks_max
float
the maximum value of daily clicks
represents the maximum number of daily clicks on the advertisement
if there is no data, then the value is null
daily_clicks_average
float
the average value of daily clicks
represents the average number of daily clicks on the advertisement
if there is no data, then the value is null
daily_cost_min
float
the minimum daily charge value
represents the minimum daily charge for the advertisement (USD)
if there is no data, then the value is null
daily_cost_max
float
the maximum daily charge value
represents the maximum daily charge for the advertisement (USD)
if there is no data, then the value is null
daily_cost_average
float
the average daily charge value
represents the average daily charge for the advertisement (USD)
if there is no data, then the value is null
tablet
object
results for tablet
location_code
integer
location code in a POST array
if there is no data, then the value is null
language_code
string
language code in a POST array
if there is no data, then the value is null
bid
float
the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher positions and price you receive in response
learn more in this help center article
keyword
string
keyword keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
match
string
keywords match-type
can take the following values: exact, broad, phrase
ad_position_min
float
the minimum ad position
represents the minimum position of the advertisement
if there is no data, then the value is null
ad_position_max
float
the maximum ad position
represents the maximum position of the advertisement
if there is no data, then the value is null
ad_position_average
float
the average ad position
represents the average position of the advertisement
if there is no data, then the value is null
cpc_min
float
the minimum value of cost-per-click
represents the minimum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
cpc_max
float
the maximum value of cost-per-click
represents the maximum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
cpc_average
float
the average value of cost-per-click
represents the average cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
daily_impressions_min
float
the minimum value of daily impressions
represents the minimum number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_impressions_max
float
the maximum value of daily impressions
represents the maximum number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_impressions_average
float
the average value of daily impressions
represents the average number number of daily impressions of the advertisement
if there is no data, then the value is null
learn more about impressions in this help center article
daily_clicks_min
float
the minimum value of daily clicks
represents the minimum number of daily clicks on the advertisement
if there is no data, then the value is null
daily_clicks_max
float
the maximum value of daily clicks
represents the maximum number of daily clicks on the advertisement
if there is no data, then the value is null
daily_clicks_average
float
the average value of daily clicks
represents the average number of daily clicks on the advertisement
if there is no data, then the value is null
daily_cost_min
float
the minimum daily charge value
represents the minimum daily charge for the advertisement (USD)
if there is no data, then the value is null
daily_cost_max
float
the maximum daily charge value
represents the maximum daily charge for the advertisement (USD)
if there is no data, then the value is null
daily_cost_average
float
the average daily charge value
represents the average daily charge for the advertisement (USD)
if there is no data, then the value is null