Generate Keyword Ideas
Stay organized with collections
Save and categorize content based on your preferences.
Java
// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package
com.google.ads.googleads.examples.planning
;
import
com.beust.jcommander.Parameter
;
import
com.google.ads.googleads.examples.utils.ArgumentNames
;
import
com.google.ads.googleads.examples.utils.CodeSampleParams
;
import
com.google.ads.googleads.lib.GoogleAdsClient
;
import
com.google.ads.googleads.v21.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork
;
import
com.google.ads.googleads.v21.errors.GoogleAdsError
;
import
com.google.ads.googleads.v21.errors.GoogleAdsException
;
import
com.google.ads.googleads.v21.services.GenerateKeywordIdeaResult
;
import
com.google.ads.googleads.v21.services.GenerateKeywordIdeasRequest
;
import
com.google.ads.googleads.v21.services.KeywordPlanIdeaServiceClient
;
import
com.google.ads.googleads.v21.services.KeywordPlanIdeaServiceClient.GenerateKeywordIdeasPagedResponse
;
import
com.google.ads.googleads.v21.utils.ResourceNames
;
import
java.io.FileNotFoundException
;
import
java.io.IOException
;
import
java.util.ArrayList
;
import
java.util.Arrays
;
import
java.util.List
;
import
javax.annotation.Nullable
;
/** Generates keyword ideas from a list of seed keywords. */
public
class
GenerateKeywordIdeas
{
private
static
class
GenerateKeywordIdeasParams
extends
CodeSampleParams
{
@Parameter
(
names
=
ArgumentNames
.
CUSTOMER_ID
,
required
=
true
)
private
Long
customerId
;
@Parameter
(
names
=
ArgumentNames
.
LOCATION_IDS
,
required
=
true
,
description
=
"Location criteria IDs. For example, specify 21167 for New York. For more information"
+
" on determining this value, see: "
+
" https://developers.google.com/google-ads/api/reference/data/geotargets."
)
private
List<Long>
locationIds
;
@Parameter
(
names
=
ArgumentNames
.
LANGUAGE_ID
,
required
=
true
,
description
=
"A language criterion ID. For example, specify 1000 for English. For more information"
+
" on determining this value, see: "
+
" https://developers.google.com/adwords/api/docs/appendix/codes-formats#languages"
)
private
Long
languageId
;
@Parameter
(
names
=
ArgumentNames
.
KEYWORD_TEXTS
)
private
List<String>
keywords
=
new
ArrayList
<> ();
@Parameter
(
names
=
ArgumentNames
.
PAGE_URL
,
description
=
"URL of a page related to your business"
)
private
String
pageUrl
;
}
public
static
void
main
(
String
[]
args
)
throws
IOException
{
GenerateKeywordIdeasParams
params
=
new
GenerateKeywordIdeasParams
();
if
(
!
params
.
parseArguments
(
args
))
{
// Either pass the required parameters for this example on the command line, or insert them
// into the code here. See the parameter class definition above for descriptions.
params
.
customerId
=
Long
.
parseLong
(
"INSERT_CUSTOMER_ID_HERE"
);
params
.
locationIds
=
Arrays
.
asList
(
Long
.
parseLong
(
"INSERT_LOCATION_ID_1_HERE"
),
Long
.
parseLong
(
"INSERT_LOCATION_ID_2_HERE"
));
params
.
languageId
=
Long
.
parseLong
(
"INSERT_LANGUAGE_ID_HERE"
);
params
.
keywords
=
Arrays
.
asList
(
"INSERT_KEYWORD_1_HERE"
,
"INSERT_KEYWORD_2_HERE"
);
// Optional: Use a URL related to your business to generate ideas.
params
.
pageUrl
=
null
;
}
GoogleAdsClient
googleAdsClient
=
null
;
try
{
googleAdsClient
=
GoogleAdsClient
.
newBuilder
().
fromPropertiesFile
().
build
();
}
catch
(
FileNotFoundException
fnfe
)
{
System
.
err
.
printf
(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n"
,
fnfe
);
System
.
exit
(
1
);
}
catch
(
IOException
ioe
)
{
System
.
err
.
printf
(
"Failed to create GoogleAdsClient. Exception: %s%n"
,
ioe
);
System
.
exit
(
1
);
}
try
{
new
GenerateKeywordIdeas
()
.
runExample
(
googleAdsClient
,
params
.
customerId
,
params
.
languageId
,
params
.
locationIds
,
params
.
keywords
,
params
.
pageUrl
);
}
catch
(
GoogleAdsException
gae
)
{
// GoogleAdsException is the base class for most exceptions thrown by an API request.
// Instances of this exception have a message and a GoogleAdsFailure that contains a
// collection of GoogleAdsErrors that indicate the underlying causes of the
// GoogleAdsException.
System
.
err
.
printf
(
"Request ID %s failed due to GoogleAdsException. Underlying errors:%n"
,
gae
.
getRequestId
());
int
i
=
0
;
for
(
GoogleAdsError
googleAdsError
:
gae
.
getGoogleAdsFailure
().
getErrorsList
())
{
System
.
err
.
printf
(
" Error %d: %s%n"
,
i
++
,
googleAdsError
);
}
System
.
exit
(
1
);
}
}
/**
* Runs the example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @param languageId the language ID.
* @param locationIds the location IDs.
* @param keywords the list of keywords to use as a seed for ideas.
* @param pageUrl optional URL related to your business to use as a seed for ideas.
* @throws GoogleAdsException if an API request failed with one or more service errors.
* @throws IllegalArgumentException if {@code keywords} is empty and {@code pageUrl} is null.
* @throws Exception if the example failed due to other errors.
*/
private
void
runExample
(
GoogleAdsClient
googleAdsClient
,
long
customerId
,
long
languageId
,
List<Long>
locationIds
,
List<String>
keywords
,
@Nullable
String
pageUrl
)
{
try
(
KeywordPlanIdeaServiceClient
keywordPlanServiceClient
=
googleAdsClient
.
getLatestVersion
().
createKeywordPlanIdeaServiceClient
())
{
GenerateKeywordIdeasRequest
.
Builder
requestBuilder
=
GenerateKeywordIdeasRequest
.
newBuilder
()
.
setCustomerId
(
Long
.
toString
(
customerId
))
// Sets the language resource using the provided language ID.
.
setLanguage
(
ResourceNames
.
languageConstant
(
languageId
))
// Sets the network. To restrict to only Google Search, change the parameter below to
// KeywordPlanNetwork.GOOGLE_SEARCH.
.
setKeywordPlanNetwork
(
KeywordPlanNetwork
.
GOOGLE_SEARCH_AND_PARTNERS
);
// Adds the resource name of each location ID to the request.
for
(
Long
locationId
:
locationIds
)
{
requestBuilder
.
addGeoTargetConstants
(
ResourceNames
.
geoTargetConstant
(
locationId
));
}
// Makes sure that keywords and/or page URL were specified. The request must have exactly one
// of urlSeed, keywordSeed, or keywordAndUrlSeed set.
if
(
keywords
.
isEmpty
()
&&
pageUrl
==
null
)
{
throw
new
IllegalArgumentException
(
"At least one of keywords or page URL is required, but neither was specified."
);
}
if
(
keywords
.
isEmpty
())
{
// Only page URL was specified, so use a UrlSeed.
requestBuilder
.
getUrlSeedBuilder
().
setUrl
(
pageUrl
);
}
else
if
(
pageUrl
==
null
)
{
// Only keywords were specified, so use a KeywordSeed.
requestBuilder
.
getKeywordSeedBuilder
().
addAllKeywords
(
keywords
);
}
else
{
// Both page URL and keywords were specified, so use a KeywordAndUrlSeed.
requestBuilder
.
getKeywordAndUrlSeedBuilder
().
setUrl
(
pageUrl
).
addAllKeywords
(
keywords
);
}
// Sends the keyword ideas request.
GenerateKeywordIdeasPagedResponse
response
=
keywordPlanServiceClient
.
generateKeywordIdeas
(
requestBuilder
.
build
());
// Prints each result in the response.
for
(
GenerateKeywordIdeaResult
result
:
response
.
iterateAll
())
{
System
.
out
.
printf
(
"Keyword idea text '%s' has %d average monthly searches and '%s' competition.%n"
,
result
.
getText
(),
result
.
getKeywordIdeaMetrics
().
getAvgMonthlySearches
(),
result
.
getKeywordIdeaMetrics
().
getCompetition
());
}
}
}
}
C#
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using
CommandLine
;
using
Google.Ads.Gax.Examples
;
using
Google.Ads.GoogleAds.Lib
;
using
Google.Ads.GoogleAds.V21.Common
;
using
Google.Ads.GoogleAds.V21.Errors
;
using
Google.Ads.GoogleAds.V21.Resources
;
using
Google.Ads.GoogleAds.V21.Services
;
using
System
;
using
System.Collections.Generic
;
using
System.Linq
;
using
static
Google
.
Ads
.
GoogleAds
.
V21
.
Enums
.
KeywordPlanNetworkEnum
.
Types
;
namespace
Google.Ads.GoogleAds.Examples.V21
{
/// <summary>
/// This code example generates keyword ideas from a list of seed keywords or a seed page URL.
/// </summary>
public
class
GenerateKeywordIdeas
:
ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GenerateKeywordIdeas"/> example.
/// </summary>
public
class
Options
:
OptionsBase
{
/// <summary>
/// The customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The customer ID for which the call is made.")]
public
long
CustomerId
{
get
;
set
;
}
/// <summary>
/// Location criteria IDs. For example, specify 21167 for New York. For more
/// information on determining this value, see
/// https://developers.google.com/google-ads/api/reference/data/geotargets.
/// </summary>
[Option("locationIds", Required = true, HelpText =
"Location criteria IDs. For example, specify 21167 for New York. For more " +
"information on determining this value, see " +
"https://developers.google.com/google-ads/api/reference/data/geotargets.")]
public
IEnumerable<long>
LocationIds
{
get
;
set
;
}
/// <summary>
/// A language criterion ID. For example, specify 1000 for English. For more information
/// on determining this value, see
/// https://developers.google.com/google-ads/api/reference/data/codes-formats#languages.
/// </summary>
[Option("languageId", Required = true, HelpText =
"A language criterion ID. For example, specify 1000 for English. For more " +
"information on determining this value, see " +
"https://developers.google.com/google-ads/api/reference/data/codes-formats#languages.")]
public
long
LanguageId
{
get
;
set
;
}
/// <summary>
/// The list of seed keywords.
/// </summary>
[Option("keywordTexts", Required = false, HelpText =
"The list of seed keywords.", Default = new string[]
{
})]
public
IEnumerable<string>
KeywordTexts
{
get
;
set
;
}
/// <summary>
/// Specify a URL string related to your business to generate ideas.
/// </summary>
[Option("pageUrl", Required = false, HelpText =
"Specify a URL string related to your business to generate ideas.")]
public
string
PageUrl
{
get
;
set
;
}
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public
static
void
Main
(
string
[]
args
)
{
Options
options
=
ExampleUtilities
.
ParseCommandLine<Options>
(
args
);
GenerateKeywordIdeas
codeExample
=
new
GenerateKeywordIdeas
();
Console
.
WriteLine
(
codeExample
.
Description
);
codeExample
.
Run
(
new
GoogleAdsClient
(),
options
.
CustomerId
,
options
.
LocationIds
.
ToArray
(),
options
.
LanguageId
,
options
.
KeywordTexts
.
ToArray
(),
options
.
PageUrl
);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public
override
string
Description
=
>
"This code example generates keyword ideas from a list of seed keywords or a seed "
+
"page URL"
;
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="locationIds">Location criteria IDs. For example, specify 21167 for
/// New York. For more information on determining this value, see
/// https://developers.google.com/google-ads/api/reference/data/geotargets.
/// </param>
/// <param name="languageId">A language criterion ID. For example, specify 1000 for
/// English. For more information on determining this value, see
/// https://developers.google.com/google-ads/api/reference/data/codes-formats#languages.
/// </param>
/// <param name="keywordTexts">The list of seed keywords.</param>
/// <param name="pageUrl">A URL string related to your business to generate ideas.</param>
public
void
Run
(
GoogleAdsClient
client
,
long
customerId
,
long
[]
locationIds
,
long
languageId
,
string
[]
keywordTexts
,
string
pageUrl
)
{
KeywordPlanIdeaServiceClient
keywordPlanIdeaService
=
client
.
GetService
(
Services
.
V21
.
KeywordPlanIdeaService
);
// Make sure that keywords and/or page URL were specified. The request must have
// exactly one of urlSeed, keywordSeed, or keywordAndUrlSeed set.
if
(
keywordTexts
.
Length
==
0
&&
string
.
IsNullOrEmpty
(
pageUrl
))
{
throw
new
ArgumentException
(
"At least one of keywords or page URL is required, "
+
"but neither was specified."
);
}
// Specify the optional arguments of the request as a keywordSeed, UrlSeed,
// or KeywordAndUrlSeed.
GenerateKeywordIdeasRequest
request
=
new
GenerateKeywordIdeasRequest
()
{
CustomerId
=
customerId
.
ToString
(),
};
if
(
keywordTexts
.
Length
==
0
)
{
// Only page URL was specified, so use a UrlSeed.
request
.
UrlSeed
=
new
UrlSeed
()
{
Url
=
pageUrl
};
}
else
if
(
string
.
IsNullOrEmpty
(
pageUrl
))
{
// Only keywords were specified, so use a KeywordSeed.
request
.
KeywordSeed
=
new
KeywordSeed
();
request
.
KeywordSeed
.
Keywords
.
AddRange
(
keywordTexts
);
}
else
{
// Both page URL and keywords were specified, so use a KeywordAndUrlSeed.
request
.
KeywordAndUrlSeed
=
new
KeywordAndUrlSeed
();
request
.
KeywordAndUrlSeed
.
Url
=
pageUrl
;
request
.
KeywordAndUrlSeed
.
Keywords
.
AddRange
(
keywordTexts
);
}
// Create a list of geo target constants based on the resource name of specified
// location IDs.
foreach
(
long
locationId
in
locationIds
)
{
request
.
GeoTargetConstants
.
Add
(
ResourceNames
.
GeoTargetConstant
(
locationId
));
}
request
.
Language
=
ResourceNames
.
LanguageConstant
(
languageId
);
// Set the network. To restrict to only Google Search, change the parameter below to
// KeywordPlanNetwork.GoogleSearch.
request
.
KeywordPlanNetwork
=
KeywordPlanNetwork
.
GoogleSearchAndPartners
;
try
{
// Generate keyword ideas based on the specified parameters.
var
response
=
keywordPlanIdeaService
.
GenerateKeywordIdeas
(
request
);
// Iterate over the results and print its detail.
foreach
(
GenerateKeywordIdeaResult
result
in
response
)
{
KeywordPlanHistoricalMetrics
metrics
=
result
.
KeywordIdeaMetrics
;
Console
.
WriteLine
(
$"Keyword idea text '{result.Text}' has "
+
$"{metrics.AvgMonthlySearches} average monthly searches and competition "
+
$"is {metrics.Competition}."
);
}
}
catch
(
GoogleAdsException
e
)
{
Console
.
WriteLine
(
"Failure:"
);
Console
.
WriteLine
(
$"Message: {e.Message}"
);
Console
.
WriteLine
(
$"Failure: {e.Failure}"
);
Console
.
WriteLine
(
$"Request ID: {e.RequestId}"
);
throw
;
}
}
}
}
PHP
< ?php
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Ads\GoogleAds\Examples\Planning;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V21\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V21\ResourceNames;
use Google\Ads\GoogleAds\V21\Enums\KeywordPlanNetworkEnum\KeywordPlanNetwork;
use Google\Ads\GoogleAds\V21\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V21\Services\GenerateKeywordIdeaResult;
use Google\Ads\GoogleAds\V21\Services\GenerateKeywordIdeasRequest;
use Google\Ads\GoogleAds\V21\Services\KeywordAndUrlSeed;
use Google\Ads\GoogleAds\V21\Services\KeywordSeed;
use Google\Ads\GoogleAds\V21\Services\UrlSeed;
use Google\ApiCore\ApiException;
/** This example generates keyword ideas from a list of seed keywords or a seed page URL. */
class GenerateKeywordIdeas
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
// Location criteria IDs. For example, specify 21167 for New York. For more information
// on determining this value, see
// https://developers.google.com/adwords/api/docs/appendix/geotargeting.
private const LOCATION_ID_1 = 'INSERT_LOCATION_ID_1_HERE';
private const LOCATION_ID_2 = 'INSERT_LOCATION_ID_2_HERE';
// A language criterion ID. For example, specify 1000 for English. For more information
// on determining this value, see
// https://developers.google.com/adwords/api/docs/appendix/codes-formats#languages.
private const LANGUAGE_ID = 'INSERT_LANGUAGE_ID_HERE';
private const KEYWORD_TEXT_1 = 'INSERT_KEYWORD_TEXT_1_HERE';
private const KEYWORD_TEXT_2 = 'INSERT_KEYWORD_TEXT_2_HERE';
// Optional: Specify a URL string related to your business to generate ideas.
private const PAGE_URL = null;
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::LOCATION_IDS => GetOpt::MULTIPLE_ARGUMENT,
ArgumentNames::LANGUAGE_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::KEYWORD_TEXTS => GetOpt::MULTIPLE_ARGUMENT,
ArgumentNames::PAGE_URL => GetOpt::OPTIONAL_ARGUMENT,
]);
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::LOCATION_IDS] ?:
[self::LOCATION_ID_1, self::LOCATION_ID_2],
$options[ArgumentNames::LANGUAGE_ID] ?: self::LANGUAGE_ID,
$options[ArgumentNames::KEYWORD_TEXTS] ?:
[self::KEYWORD_TEXT_1, self::KEYWORD_TEXT_2],
$options[ArgumentNames::PAGE_URL] ?: self::PAGE_URL
);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param int[] $locationIds the location IDs
* @param int $languageId the language ID
* @param string[] $keywords the list of keywords to use as a seed for ideas
* @param string|null $pageUrl optional URL related to your business to use as a seed for ideas
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
array $locationIds,
int $languageId,
array $keywords,
?string $pageUrl
) {
$keywordPlanIdeaServiceClient = $googleAdsClient->getKeywordPlanIdeaServiceClient();
// Make sure that keywords and/or page URL were specified. The request must have exactly one
// of urlSeed, keywordSeed, or keywordAndUrlSeed set.
if (empty($keywords) && is_null($pageUrl)) {
throw new \InvalidArgumentException(
'At least one of keywords or page URL is required, but neither was specified.'
);
}
// Specify the optional arguments of the request as a keywordSeed, urlSeed,
// or keywordAndUrlSeed.
$requestOptionalArgs = [];
if (empty($keywords)) {
// Only page URL was specified, so use a UrlSeed.
$requestOptionalArgs['url_seed'] = new UrlSeed(['url' => $pageUrl]);
} elseif (is_null($pageUrl)) {
// Only keywords were specified, so use a KeywordSeed.
$requestOptionalArgs['keyword_seed'] = new KeywordSeed(['keywords' => $keywords]);
} else {
// Both page URL and keywords were specified, so use a KeywordAndUrlSeed.
$requestOptionalArgs['keyword_and_url_seed'] =
new KeywordAndUrlSeed(['url' => $pageUrl, 'keywords' => $keywords]);
}
// Create a list of geo target constants based on the resource name of specified location
// IDs.
$geoTargetConstants = array_map(function ($locationId) {
return ResourceNames::forGeoTargetConstant($locationId);
}, $locationIds);
// Generate keyword ideas based on the specified parameters.
$response = $keywordPlanIdeaServiceClient->generateKeywordIdeas(
new GenerateKeywordIdeasRequest([
// Set the language resource using the provided language ID.
'language' => ResourceNames::forLanguageConstant($languageId),
'customer_id' => $customerId,
// Add the resource name of each location ID to the request.
'geo_target_constants' => $geoTargetConstants,
// Set the network. To restrict to only Google Search, change the parameter below to
// KeywordPlanNetwork::GOOGLE_SEARCH.
'keyword_plan_network' => KeywordPlanNetwork::GOOGLE_SEARCH_AND_PARTNERS
] + $requestOptionalArgs)
);
// Iterate over the results and print its detail.
foreach ($response->iterateAllElements() as $result) {
/** @var GenerateKeywordIdeaResult $result */
// Note that the competition printed below is enum value.
// For example, a value of 2 will be returned when the competition is 'LOW'.
// A mapping of enum names to values can be found at KeywordPlanCompetitionLevel.php.
printf(
"Keyword idea text '%s' has %d average monthly searches and competition as %d.%s",
$result->getText(),
is_null($result->getKeywordIdeaMetrics()) ?
0 : $result->getKeywordIdeaMetrics()->getAvgMonthlySearches(),
is_null($result->getKeywordIdeaMetrics()) ?
0 : $result->getKeywordIdeaMetrics()->getCompetition(),
PHP_EOL
);
}
}
}
GenerateKeywordIdeas::main();
Python
#!/usr/bin/env python
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This example generates keyword ideas from a list of seed keywords."""
import
argparse
import
sys
from
google.ads.googleads.client
import
GoogleAdsClient
from
google.ads.googleads.errors
import
GoogleAdsException
from
google.ads.googleads.v21.enums.types.keyword_plan_competition_level
import
(
KeywordPlanCompetitionLevelEnum
,
)
from
google.ads.googleads.v21.enums.types.keyword_plan_network
import
(
KeywordPlanNetworkEnum
,
)
from
google.ads.googleads.v21.services.services.geo_target_constant_service.client
import
(
GeoTargetConstantServiceClient
,
)
from
google.ads.googleads.v21.services.services.google_ads_service.client
import
(
GoogleAdsServiceClient
,
)
from
google.ads.googleads.v21.services.services.keyword_plan_idea_service.client
import
(
KeywordPlanIdeaServiceClient
,
)
from
google.ads.googleads.v21.services.types.keyword_plan_idea_service
import
(
GenerateKeywordIdeasRequest
,
GenerateKeywordIdeaResult
,
)
# Location IDs are listed here:
# https://developers.google.com/google-ads/api/reference/data/geotargets
# and they can also be retrieved using the GeoTargetConstantService as shown
# here: https://developers.google.com/google-ads/api/docs/targeting/location-targeting
_DEFAULT_LOCATION_IDS
=
[
"1023191"
]
# location ID for New York, NY
# A language criterion ID. For example, specify 1000 for English. For more
# information on determining this value, see the below link:
# https://developers.google.com/google-ads/api/reference/data/codes-formats#expandable-7
_DEFAULT_LANGUAGE_ID
=
"1000"
# language ID for English
def
main
(
client
:
GoogleAdsClient
,
customer_id
:
str
,
location_ids
:
list
[
str
],
language_id
:
str
,
keyword_texts
:
list
[
str
],
page_url
:
str
,
):
keyword_plan_idea_service
:
KeywordPlanIdeaServiceClient
=
(
client
.
get_service
(
"KeywordPlanIdeaService"
)
)
keyword_competition_level_enum
:
KeywordPlanCompetitionLevelEnum
=
(
client
.
enums
.
KeywordPlanCompetitionLevelEnum
)
keyword_plan_network
:
KeywordPlanNetworkEnum
=
(
client
.
enums
.
KeywordPlanNetworkEnum
.
GOOGLE_SEARCH_AND_PARTNERS
)
location_rns
:
list
[
str
]
=
map_locations_ids_to_resource_names
(
client
,
location_ids
)
google_ads_service
:
GoogleAdsServiceClient
=
client
.
get_service
(
"GoogleAdsService"
)
language_rn
:
str
=
google_ads_service
.
language_constant_path
(
language_id
)
# Either keywords or a page_url are required to generate keyword ideas
# so this raises an error if neither are provided.
if
not
(
keyword_texts
or
page_url
):
raise
ValueError
(
"At least one of keywords or page URL is required, "
"but neither was specified."
)
# Only one of the fields "url_seed", "keyword_seed", or
# "keyword_and_url_seed" can be set on the request, depending on whether
# keywords, a page_url or both were passed to this function.
request
:
GenerateKeywordIdeasRequest
=
client
.
get_type
(
"GenerateKeywordIdeasRequest"
)
request
.
customer_id
=
customer_id
request
.
language
=
language_rn
request
.
geo_target_constants
=
location_rns
request
.
include_adult_keywords
=
False
request
.
keyword_plan_network
=
keyword_plan_network
# To generate keyword ideas with only a page_url and no keywords we need
# to initialize a UrlSeed object with the page_url as the "url" field.
if
not
keyword_texts
and
page_url
:
request
.
url_seed
.
url
=
page_url
# To generate keyword ideas with only a list of keywords and no page_url
# we need to initialize a KeywordSeed object and set the "keywords" field
# to be a list of StringValue objects.
if
keyword_texts
and
not
page_url
:
request
.
keyword_seed
.
keywords
.
extend
(
keyword_texts
)
# To generate keyword ideas using both a list of keywords and a page_url we
# need to initialize a KeywordAndUrlSeed object, setting both the "url" and
# "keywords" fields.
if
keyword_texts
and
page_url
:
request
.
keyword_and_url_seed
.
url
=
page_url
request
.
keyword_and_url_seed
.
keywords
.
extend
(
keyword_texts
)
keyword_ideas
=
keyword_plan_idea_service
.
generate_keyword_ideas
(
request
=
request
)
idea
:
GenerateKeywordIdeaResult
for
idea
in
keyword_ideas
:
competition_value
=
idea
.
keyword_idea_metrics
.
competition
.
name
print
(
f
'Keyword idea text "
{
idea
.
text
}
" has '
f
'"
{
idea
.
keyword_idea_metrics
.
avg_monthly_searches
}
" '
f
'average monthly searches and "
{
competition_value
}
" '
"competition.
\n
"
)
def
map_locations_ids_to_resource_names
(
client
:
GoogleAdsClient
,
location_ids
:
list
[
str
]
)
-
> list
[
str
]:
"""Converts a list of location IDs to resource names.
Args:
client: an initialized GoogleAdsClient instance.
location_ids: a list of location ID strings.
Returns:
a list of resource name strings using the given location IDs.
"""
geo_target_constant_service
:
GeoTargetConstantServiceClient
=
(
client
.
get_service
(
"GeoTargetConstantService"
)
)
build_resource_name
=
geo_target_constant_service
.
geo_target_constant_path
return
[
build_resource_name
(
location_id
)
for
location_id
in
location_ids
]
if
__name__
==
"__main__"
:
parser
=
argparse
.
ArgumentParser
(
description
=
"Generates keyword ideas from a list of seed keywords."
)
# The following argument(s) should be provided to run the example.
parser
.
add_argument
(
"-c"
,
"--customer_id"
,
type
=
str
,
required
=
True
,
help
=
"The Google Ads customer ID."
,
)
parser
.
add_argument
(
"-k"
,
"--keyword_texts"
,
nargs
=
"+"
,
type
=
str
,
required
=
False
,
default
=
[],
help
=
"Space-delimited list of starter keywords"
,
)
# To determine the appropriate location IDs, see:
# https://developers.google.com/google-ads/api/reference/data/geotargets
parser
.
add_argument
(
"-l"
,
"--location_ids"
,
nargs
=
"+"
,
type
=
str
,
required
=
False
,
default
=
_DEFAULT_LOCATION_IDS
,
help
=
"Space-delimited list of location criteria IDs"
,
)
# To determine the appropriate language ID, see:
# https://developers.google.com/google-ads/api/data/codes-formats#languages
parser
.
add_argument
(
"-i"
,
"--language_id"
,
type
=
str
,
required
=
False
,
default
=
_DEFAULT_LANGUAGE_ID
,
help
=
"The language criterion ID."
,
)
# Optional: Specify a URL string related to your business to generate ideas.
parser
.
add_argument
(
"-p"
,
"--page_url"
,
type
=
str
,
required
=
False
,
help
=
"A URL string related to your business"
,
)
args
=
parser
.
parse_args
()
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client
=
GoogleAdsClient
.
load_from_storage
(
version
=
"v21"
)
try
:
main
(
googleads_client
,
args
.
customer_id
,
args
.
location_ids
,
args
.
language_id
,
args
.
keyword_texts
,
args
.
page_url
,
)
except
GoogleAdsException
as
ex
:
print
(
f
'Request with ID "
{
ex
.
request_id
}
" failed with status '
f
'"
{
ex
.
error
.
code
()
.
name
}
" and includes the following errors:'
)
for
error
in
ex
.
failure
.
errors
:
print
(
f
'
\t
Error with message "
{
error
.
message
}
".'
)
if
error
.
location
:
for
field_path_element
in
error
.
location
.
field_path_elements
:
print
(
f
"
\t\t
On field:
{
field_path_element
.
field_name
}
"
)
sys
.
exit
(
1
)
Ruby
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example gets all campaigns. To add campaigns, run add_campaigns.rb.
require
'optparse'
require
'google/ads/google_ads'
require_relative
'../shared/error_handler.rb'
def
generate_keyword_ideas
(
customer_id
,
location_ids
,
language_id
,
keywords
,
page_url
)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client
=
Google
::
Ads
::
GoogleAds
::
GoogleAdsClient
.
new
# Make sure that keywords and/or page URL were specified. The request must
# have exactly one of urlSeed, keywordSeed, or keywordAndUrlSeed set.
if
keywords
.
reject
{
|
k
|
k
.
nil?
}
.
empty?
&&
page_url
.
nil?
raise
"At least one of keywords or page URL is required."
end
kp_idea_service
=
client
.
service
.
keyword_plan_idea
options_hash
=
if
keywords
.
empty?
seed
=
client
.
resource
.
url_seed
do
|
seed
|
seed
.
url
=
page_url
end
{
url_seed
:
seed
}
elsif
page_url
.
nil?
seed
=
client
.
resource
.
keyword_seed
do
|
seed
|
keywords
.
each
do
|
keyword
|
seed
.
keywords
<<
keyword
end
end
{
keyword_seed
:
seed
}
else
seed
=
client
.
resource
.
keyword_and_url_seed
do
|
seed
|
seed
.
url
=
page_url
keywords
.
each
do
|
keyword
|
seed
.
keywords
<<
keyword
end
end
{
keyword_and_url_seed
:
seed
}
end
geo_target_constants
=
location_ids
.
map
do
|
location_id
|
client
.
path
.
geo_target_constant
(
location_id
)
end
include_adult_keywords
=
true
response
=
kp_idea_service
.
generate_keyword_ideas
(
customer_id
:
customer_id
,
language
:
client
.
path
.
language_constant
(
language_id
),
geo_target_constants
:
geo_target_constants
,
include_adult_keywords
:
include_adult_keywords
,
# To restrict to only Google Search, change the parameter below to
# :GOOGLE_SEARCH
keyword_plan_network
:
:GOOGLE_SEARCH_AND_PARTNERS
,
**
options_hash
)
response
.
each
do
|
result
|
monthly_searches
=
if
result
.
keyword_idea_metrics
.
nil?
0
else
result
.
keyword_idea_metrics
.
avg_monthly_searches
end
competition
=
if
result
.
keyword_idea_metrics
.
nil?
:UNSPECIFIED
else
result
.
keyword_idea_metrics
.
competition
end
puts
"Keyword idea text
#{
result
.
text
}
has
#{
monthly_searches
}
average "
+
"monthly searches and competition as
#{
competition
}
."
end
end
if
__FILE__
==
$0
options
=
{}
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
options
[
:customer_id
]
=
'INSERT_CUSTOMER_ID_HERE'
# For a list of valid location IDs, see:
# https://developers.google.com/google-ads/api/reference/data/geotargets
options
[
:location_ids
]
=
[
'INSERT_LOCATION_ID_1_HERE'
,
'INSERT_LOCATION_ID_2_HERE'
]
# For a list of valid language IDs, see:
# https://developers.google.com/google-ads/api/reference/data/codes-formats#languages
options
[
:language_id
]
=
'INSERT_LANGUAGE_ID_HERE'
# Optional but recommended
options
[
:keyword_texts
]
=
[
'INSERT_KEYWORD_TEXT_1_HERE'
,
'INSERT_KEYWORD_TEXT_2_HERE'
]
# Optional: Specify a URL string related to your business to generate ideas.
options
[
:page_url
]
=
nil
OptionParser
.
new
do
|
opts
|
opts
.
banner
=
sprintf
(
'Usage: %s [options]'
,
File
.
basename
(
__FILE__
))
opts
.
separator
''
opts
.
separator
'Options:'
opts
.
on
(
'-C'
,
'--customer-id CUSTOMER-ID'
,
String
,
'Customer ID'
)
do
|
v
|
options
[
:customer_id
]
=
v
end
opts
.
on
(
'-L'
,
'--location-ids LOCATION-IDS'
,
String
,
'Location IDs (comma separated)'
)
do
|
v
|
options
[
:location_ids
]
=
v
.
split
(
','
)
end
opts
.
on
(
'-a'
,
'--language-id LANGUAGE-ID'
,
String
,
'Language ID'
)
do
|
v
|
options
[
:language_id
]
=
v
end
opts
.
on
(
'-K'
,
'--keyword-texts KEYWORD-TEXTS'
,
String
,
'Keyword Texts (comma separated)'
)
do
|
v
|
options
[
:keyword_texts
]
=
v
.
split
(
','
)
end
opts
.
on
(
'-p'
,
'--page-url PAGE-URL'
,
String
,
'Page URL'
)
do
|
v
|
options
[
:page_url
]
=
v
end
opts
.
separator
''
opts
.
separator
'Help:'
opts
.
on_tail
(
'-h'
,
'--help'
,
'Show this message'
)
do
puts
opts
exit
end
end
.
parse!
begin
generate_keyword_ideas
(
options
.
fetch
(
:customer_id
)
.
tr
(
"-"
,
""
),
options
.
fetch
(
:location_ids
),
options
.
fetch
(
:language_id
),
options
.
fetch
(
:keyword_texts
),
options
[
:page_url
]
)
rescue
Google
::
Ads
::
GoogleAds
::
Errors
::
GoogleAdsError
=
>
e
GoogleAdsErrorHandler
.
handle_google_ads_error
(
e
)
raise
# Re-raise the error to maintain original script behavior.
end
end
Perl
#!/usr/bin/perl -w
#
# Copyright 2019, Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example generates keyword ideas from a list of seed keywords or a seed
# page URL.
use
strict
;
use
warnings
;
use
utf8
;
use
FindBin
qw($Bin)
;
use
lib
"$Bin/../../lib"
;
use
Google::Ads::GoogleAds::Client
;
use
Google::Ads::GoogleAds::Utils::GoogleAdsHelper
;
use
Google::Ads::GoogleAds::V21::Enums::KeywordPlanNetworkEnum
qw(GOOGLE_SEARCH GOOGLE_SEARCH_AND_PARTNERS)
;
use
Google::Ads::GoogleAds::V21::Services::KeywordPlanIdeaService::UrlSeed
;
use
Google::Ads::GoogleAds::V21::Services::KeywordPlanIdeaService::KeywordSeed
;
use
Google::Ads::GoogleAds::V21::Services::KeywordPlanIdeaService::KeywordAndUrlSeed
;
use
Google::Ads::GoogleAds::V21::Utils::ResourceNames
;
use
Getopt::Long
qw(:config auto_help)
;
use
Pod::Usage
;
use
Cwd
qw(abs_path)
;
# The following parameter(s) should be provided to run the example. You can
# either specify these by changing the INSERT_XXX_ID_HERE values below, or on
# the command line.
#
# Parameters passed on the command line will override any parameters set in
# code.
#
# Running the example with -h will print the command line usage.
my
$customer_id
=
"INSERT_CUSTOMER_ID_HERE"
;
# Location criteria IDs. For example, specify 21167 for New York. For more
# information on determining this value, see
# https://developers.google.com/google-ads/api/reference/data/geotargets.
my
$location_id_1
=
"INSERT_LOCATION_ID_1_HERE"
;
my
$location_id_2
=
"INSERT_LOCATION_ID_2_HERE"
;
my
$location_ids
=
[]
;
# A language criterion ID. For example, specify 1000 for English. For more
# information on determining this value, see
# https://developers.google.com/google-ads/api/reference/data/codes-formats#languages.
my
$language_id
=
"INSERT_LANGUAGE_ID_HERE"
;
my
$keyword_text_1
=
"INSERT_KEYWORD_TEXT_1_HERE"
;
my
$keyword_text_2
=
"INSERT_KEYWORD_TEXT_2_HERE"
;
my
$keyword_texts
=
[]
;
# Optional: Specify a URL string related to your business to generate ideas.
my
$page_url
=
undef
;
sub
generate_keyword_ideas
{
my
(
$api_client
,
$customer_id
,
$location_ids
,
$language_id
,
$keyword_texts
,
$page_url
)
=
@_
;
# Make sure that keywords and/or page URL were specified. The request must have
# exactly one of urlSeed, keywordSeed, or keywordAndUrlSeed set.
if
(
not
scalar
@$keyword_texts
and
not
$page_url
)
{
die
"At least one of keywords or page URL is required, "
.
"but neither was specified."
;
}
# Specify the optional arguments of the request as a keywordSeed, urlSeed,
# or keywordAndUrlSeed.
my
$request_option_args
=
{};
if
(
!
scalar
@$keyword_texts
)
{
# Only page URL was specified, so use a UrlSeed.
$request_option_args
-
> {
urlSeed
}
=
Google::Ads::GoogleAds::V21::Services::KeywordPlanIdeaService::
UrlSeed
-
>
new
({
url
=
>
$page_url
});
}
elsif
(
not
$page_url
)
{
# Only keywords were specified, so use a KeywordSeed.
$request_option_args
-
> {
keywordSeed
}
=
Google::Ads::GoogleAds::V21::Services::KeywordPlanIdeaService::
KeywordSeed
-
> new
({
keywords
=
>
$keyword_texts
});
}
else
{
# Both page URL and keywords were specified, so use a KeywordAndUrlSeed.
$request_option_args
-
> {
keywordAndUrlSeed
}
=
Google::Ads::GoogleAds::V21::Services::KeywordPlanIdeaService::
KeywordAndUrlSeed
-
> new
({
url
=
>
$page_url
,
keywords
=
>
$keyword_texts
});
}
# Create a list of geo target constants based on the resource name of specified
# location IDs.
my
$geo_target_constants
=
[
map
(
Google::Ads::GoogleAds::V21::Utils::ResourceNames::
geo_target_constant
(
$_
),
@$location_ids
)];
# Generate keyword ideas based on the specified parameters.
my
$keyword_ideas_response
=
$api_client
-
> KeywordPlanIdeaService
()
-
> generate_keyword_ideas
({
customerId
=
>
$customer_id
,
# Set the language resource using the provided language ID.
language
=
>
Google::Ads::GoogleAds::V21::Utils::ResourceNames::
language_constant
(
$language_id
),
# Add the resource name of each location ID to the request.
geoTargetConstants
=
>
$geo_target_constants
,
# Set the network. To restrict to only Google Search, change the parameter below
# to GOOGLE_SEARCH.
keywordPlanNetwork
=
>
GOOGLE_SEARCH_AND_PARTNERS
,
%$request_option_args
});
# Iterate over the results and print its detail.
foreach
my
$result
(
@
{
$keyword_ideas_response
-
> {
results
}})
{
printf
"Keyword idea text '%s' has %d average monthly searches "
.
"and '%s' competition.\n"
,
$result
-
> {
text
},
$result
-
> {
keywordIdeaMetrics
}{
avgMonthlySearches
}
?
$result
-
> {
keywordIdeaMetrics
}{
avgMonthlySearches
}
:
0
,
$result
-
> {
keywordIdeaMetrics
}{
competition
}
?
$result
-
> {
keywordIdeaMetrics
}{
competition
}
:
"undef"
;
}
return
1
;
}
# Don't run the example if the file is being included.
if
(
abs_path
(
$0
)
ne
abs_path
(
__FILE__
))
{
return
1
;
}
# Get Google Ads Client, credentials will be read from ~/googleads.properties.
my
$api_client
=
Google::Ads::GoogleAds::
Client
-
> new
();
# By default examples are set to die on any server returned fault.
$api_client
-
> set_die_on_faults
(
1
);
# Parameters passed on the command line will override any parameters set in code.
GetOptions
(
"customer_id=s"
=
>
\
$customer_id
,
"location_ids=i"
=
>
\
@$location_ids
,
"language_id=i"
=
>
\
$language_id
,
"keyword_texts=s"
=
>
\
@$keyword_texts
,
"page_url=s"
=
>
\
$page_url
,
);
$location_ids
=
[
$location_id_1
,
$location_id_2
]
unless
@$location_ids
;
$keyword_texts
=
[
$keyword_text_1
,
$keyword_text_2
]
unless
@$keyword_texts
;
# Print the help message if the parameters are not initialized in the code nor
# in the command line.
pod2usage
(
2
)
if
not
check_params
(
$customer_id
,
$location_ids
,
$language_id
,
$keyword_texts
);
# Call the example.
generate_keyword_ideas
(
$api_client
,
$customer_id
=~
s/-//g
r
,
$location_ids
,
$language_id
,
$keyword_texts
,
$page_url
);
=pod
=head1 NAME
generate_keyword_ideas
=head1 DESCRIPTION
This example generates keyword ideas from a list of seed keywords or a seed page URL.
=head1 SYNOPSIS
generate_keyword_ideas.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-location_ids The location criterion IDs, e.g. specify 21167 for New York.
-language_id The language criterion ID, e.g. specify 1000 for English.
-keyword_texts The keyword texts, as a seed for ideas.
-page_url [optional] URL of a page related to your business.
=cut
curl
#
Copyright
2025
Google
LLC #
Licensed
under
the
Apache
License,
Version
2
.0
(
the
"License"
)
;
#
you
may
not
use
this
file
except
in
compliance
with
the
License. #
You
may
obtain
a
copy
of
the
License
at #
https://www.apache.org/licenses/LICENSE-2.0 #
Unless
required
by
applicable
law
or
agreed
to
in
writing,
software #
distributed
under
the
License
is
distributed
on
an
"AS IS"
BASIS, #
WITHOUT
WARRANTIES
OR
CONDITIONS
OF
ANY
KIND,
either
express
or
implied. #
See
the
License
for
the
specific
language
governing
permissions
and #
limitations
under
the
License. #
This
code
example
generates
keyword
ideas. #
#
Variables: #
API_VERSION, #
CUSTOMER_ID, #
DEVELOPER_TOKEN, #
MANAGER_CUSTOMER_ID, #
OAUTH2_ACCESS_TOKEN: #
See
https://developers.google.com/google-ads/api/rest/auth#request_headers #
for
details. #
#
LANGUAGE:
The
resource
name
of
the
language
to
target.
This
is
in
the
format #
of
"languageConstants/{criterion_id}"
.
See #
https://developers.google.com/google-ads/api/data/codes-formats#languages #
for
the
available
criterion_id
values. #
GEO_TARGET_CONSTANT:
The
resource
name
of
the
geo
target
constant
to #
generate
keyword
ideas
for
.
This
is
in
the
format
of #
"geoTargetConstants/{criterion_id}"
.
See #
https://developers.google.com/google-ads/api/data/geotargets
for
the #
available
criterion_id
values. #
KEYWORD:
The
keyword
to
generate
keyword
ideas
for
. #
URL:
The
URL
of
the
website
to
generate
keyword
ideas
for
. curl -f --request POST \
"https://googleads.googleapis.com/v${API_VERSION}/customers/${CUSTOMER_ID}:generateKeywordIdeas" \
--header "Content-Type: application/json" \
--header "developer-token: ${DEVELOPER_TOKEN}" \
--header "login-customer-id: ${MANAGER_CUSTOMER_ID}" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \
--data @- <<EOF
{
"language": "${LANGUAGE}",
"geoTargetConstants": [
"${GEO_TARGET_CONSTANT}"
],
"includeAdultKeywords": false,
"keywordPlanNetwork": "GOOGLE_SEARCH",
"keywordAndUrlSeed": {
"keywords": [
"${KEYWORD}"
],
"url": "${URL}"
}
}
EOF
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThe code examples provided demonstrate how to use the Google Ads API across Java, C#, PHP, Python, Ruby, and Perl to generate keyword ideas based on provided seed keywords and/or a page URL.\u003c/p\u003e\n"],["\u003cp\u003eThe implementations across all languages utilize the \u003ccode\u003eKeywordPlanIdeaService\u003c/code\u003e to make requests to the Google Ads API, requiring at minimum a customer ID, location IDs, a language ID, and either seed keywords, a page URL, or both.\u003c/p\u003e\n"],["\u003cp\u003eAll the code examples implement error handling for Google Ads API related exceptions, ensuring the script does not abruptly crash when an issue occurs in the API connection or call.\u003c/p\u003e\n"],["\u003cp\u003eEach language implementation allows for the specification of the network to search, with the default setting to search through \u003ccode\u003eGOOGLE_SEARCH_AND_PARTNERS\u003c/code\u003e, but allowing the option to only use \u003ccode\u003eGOOGLE_SEARCH\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe output in all language implementations present a list of keyword ideas with the keyword's text, its average monthly searches, and its level of competition.\u003c/p\u003e\n"]]],[],null,[]]
