Setting Live ‘Google AdWords Keywords For Keywords’ Tasks
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.
This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Google AdWords for your query.
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. The data provided by the API and in the UI might come from different sources.
If your system requires delivering instant results, the Live method is the best solution for you. Unlike the Standard method, this method doesn’t require making separate POST and GET requests to the corresponding endpoints.
If you don’t need to receive data in real-time, you can use the Standard method of data retrieval. This method requires making separate POST and GET requests, but it’s more affordable. Using this method you can retrieve the results after our system collects them.
You can also check the update status of keywords search volume returned by Google API using the Get AdWords Status endpoint.
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)" \
curl --location --request POST "https://api.dataforseo.com/v3/keywords_data/google/keywords_for_keywords/live" \
--header "Authorization: Basic ${cred}" \
--header "Content-Type: application/json" \
--data-raw "[
{
"location_code": 2840,
"keywords": [
"average page rpm adsense",
"adsense blank ads how long",
"leads and prospects"
]
}
]"
<?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();
}
$post_array = array();
// simple way to set a task
$post_array[] = array(
"location_name" => "United States",
"language_name" => "English",
"keywords" => array(
"average page rpm adsense",
"adsense blank ads how long",
"leads and prospects"
)
);
try {
// POST /v3/keywords_data/google/keywords_for_keywords/live
// the full list of possible parameters is available in documentation
$result = $client->post('/v3/keywords_data/google/keywords_for_keywords/live', $post_array);
print_r($result);
// do something with post 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")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
location_name="United States",
language_name="English",
keywords=[
"average page rpm adsense",
"adsense blank ads how long",
"leads and prospects"
]
)
# POST /v3/keywords_data/google/keywords_for_keywords/live
# the full list of possible parameters is available in documentation
response = client.post("/v3/keywords_data/google/keywords_for_keywords/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# 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_keywords_for_keywords_live()
{
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"))) }
};
var postData = new List<object>();
postData.Add(new
{
location_name = "United States",
language_name = "English",
keywords = new[]
{
"average page rpm adsense",
"adsense blank ads how long",
"leads and prospects"
}
});
// POST /v3/keywords_data/google/keywords_for_keywords/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/keywords_data/google/keywords_for_keywords/live", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name
Type
Description
keywords
array
keywords required field
you can specify a maximum of 200 keywords
the specified keywords will be converted to lowercase, data will be provided in a separate array;
location_name
string
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 https://api.dataforseo.com/v3/keywords_data/google/locations ignore this field to receive global results
example: London,England,United Kingdom
location_code
integer
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 https://api.dataforseo.com/v3/keywords_data/google/locations ignore this field to receive global results
example: 2840
location_coordinate
string
GPS coordinates of a location
optional field 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” format the data will be provided for the country the specified coordinates belong to ignore this field to receive global results
example: 52.6178549,-155.352142
language_name
string
full name of search engine language
optional field 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 https://api.dataforseo.com/v3/keywords_data/google/languages ignore this field to receive the results for all available languages
example: English
language_code
string
search engine language code
optional field 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 https://api.dataforseo.com/v3/keywords_data/google/languages ignore this field to receive the results for all available languages example: en
search_partners
boolean
Google search partners
optional field
if you specify the true value in the field, the results will be delivered for Google and search partners
default value: false
sort_by
string
results sorting parameters
optional field
Use these parameters to sort the results by search_volume or relevance in the descending order
default value: search_volume
keywords_negative
array
keywords negative array
optional field
These keywords will be ignored in the results array;
You can specify a maximum of 200 terms that you want to exclude from the results;
the specified keywords will be converted to lowercase format
closely_variants
boolean
closely variants
optional field
show only the results which are highly relevant to the provided keywords
if you specify the true value in the field, keywords_negative should not be the same as the provided keywords
default value: false
tag
string
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
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
keyword
string
keyword in a POST array
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
search_partners
boolean
indicates whether data from partner networks included in the response
competition
float
competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Google AdWords data and can be between 0 and 1 (inclusive).
if there is no data, then the value is null
cpc
float
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
search_volume
integer
monthly average search volume rate
represents the (approximate) number of searches for the keyword on google.com or google.com and partners, depending on the user’s targeting
if there is no data, then the value is null
monthly searches
represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.
if there is no data, then the value is null
