NAVNavbar
Logo
cURL php NodeJS Python cSharp

Get ‘Ads Traffic By Keywords’ Results by id


The Ad Traffic By Keywords endpoint is based on the latest version of the Google Ads API that is due to replace Google AdWords API by April 2022. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API by April 27th, 2022.‌‌

Using the Ad Traffic By Keywords endpoint, you can receive a set of stats for estimating impressions, CPC, and clicks. This data is really useful for estimating real demand for a specific keyword, as it is much more accurate than the regular search volume information, which shows the broad match estimation for a group of similar keywords.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?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-dashboard
	$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_ads/{{low_se_type_under}}/tasks_ready
	$tasks_ready = $client->get('/v3/keywords_data/google_ads/{{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_ads/{{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_ads/{{low_se_type_under}}/task_get/$id
					/*
					if (isset($task_ready['id'])) {
						$result[] = $client->get('/v3/keywords_data/google_ads/{{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;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20210917",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "5.5458 sec.",
    "cost": 0.075,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "10261133-1535-0094-0000-29713dd40417",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "5.4410 sec.",
            "cost": 0.075,
            "result_count": 1,
            "path": [
                "v3",
                "keywords_data",
                "google_ads",
                "ad_traffic_by_keywords",
                "task_get",
                "01302012-1535-0092-0000-e445a89bc724"
            ],
            "data": {
                "api": "keywords_data",
                "function": "ad_traffic_by_keywords",
                "se": "google_ads",
                "location_code": 2840,
                "language_code": "en",
                "bid": 999,
                "match": "exact",
                "keywords": [
                    "seo marketing"
                ]
            },
            "result": [
                {
                    "keyword": "seo marketing",
                    "location_code": 2840,
                    "language_code": "en",
                    "date_interval": "next_month",
                    "search_partners": false,
                    "bid": 999,
                    "match": "exact",
                    "impressions": 15067.28,
                    "ctr": 0.0402,
                    "average_cpc": 433.44,
                    "cost": 262417.23,
                    "clicks": 605.43
                }
            ]
        }
    ]
}

Description of the fields for sending a request:

Field name Type Description
id string 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 result array:

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
            date_interval string forecasting date interval in a POST array
            search_partners boolean include Google search partners
the value you specified when setting the task
if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
if false, the results are returned for Google search sites only
            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 metrics and cost you receive in response
learn more in this help center article
            match string keywords match-type
can take the following values: exact, broad, phrase
            impressions float projected number of ad impressions
number of impressions an ad is projected to get within the specified time period
if there is no data, then the value is null
learn more about impressions in this help center article
            ctr float projected clickthrough rate (CTR) of the advertisement
number of clicks an ad is projected to receive divided by the number of ad impressions; the CTR is projected for the specified time period
if there is no data, then the value is null
            average_cpc float the average cost-per-click value
represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;
if there is no data, then the value is null
            cost float charge for an ad
amount that will be charged for running an ad within the specified time period
if there is no data, then the value is null
            clicks float number of clicks on an ad
number of clicks an ad is projected to get within the specified time period
if there is no data, then the value is null

‌‌