Google Ads Query Language supports paging by specifying page_size in your request. This will
break up the result set of the query into multiple responses that each contains
up to page_size objects. If page_size is not specified, it is automatically
set to the maximum page size of 10,000 rows.
For example, with the following query:
SELECT
ad_group.id,
ad_group_criterion.type,
ad_group_criterion.criterion_id,
ad_group_criterion.keyword.text,
ad_group_criterion.keyword.match_type
FROM ad_group_criterion
WHERE ad_group_criterion.type = KEYWORD
If your account contains 50,000 keywords and page_size is set to 1,000, the
result set will contain 1,000 GoogleAdsRow
objects in the first response,
along with a next_page_token. To retrieve the next one thousand rows, simply
send the request again with the same page size, but update the request's
page_token to the response's next_page_token. The value of page_size in
the subsequent requests can be different each time.
Our client libraries handle paging automatically. You only have to iterate through the rows of the response. When all the rows in the current page have been returned, the client library will fetch a new page of rows automatically on your behalf until the entire data set has been retrieved. If using REST instead of gRPC, you must explicitly make a request for each new page.
Google Ads API internally caches the entire data set, so subsequent requests are faster
than the first request. Depending on your use case, you can set page_size to
any value between 1 and 10,000. In general, for faster overall performance, you
should use a larger page_size due to fewer round trips in your responses.
Your query must remain exactly the same in subsequent requests to take advantage of the cached data; the requests won't contribute towards your quota, particularly for basic access. If the query differs and it is sent along with the page token, it will result in an error.
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.basicoperations;
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.v13.common.KeywordInfo;
import com.google.ads.googleads.v13.errors.GoogleAdsError;
import com.google.ads.googleads.v13.errors.GoogleAdsException;
import com.google.ads.googleads.v13.resources.AdGroup;
import com.google.ads.googleads.v13.resources.AdGroupCriterion;
import com.google.ads.googleads.v13.services.GoogleAdsRow;
import com.google.ads.googleads.v13.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v13.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v13.services.SearchGoogleAdsRequest;
import java.io.FileNotFoundException;
import java.io.IOException;
import javax.annotation.Nullable;
/**
* Retrieves keywords for a customer or for a specific ad group, and also demonstrates how to use
* the {@code omit_unselected_resource_names} option in the Google Ads Query Language (GAQL) to
* reduce payload size.
*/
public class GetKeywords {
private static final int PAGE_SIZE = 1_000;
private static class GetKeywordsParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.AD_GROUP_ID)
private Long adGroupId;
@Parameter(names = ArgumentNames.OMIT_UNSELECTED_RESOURCE_NAMES, arity = 1)
private Boolean omitUnselectedResourceNames = false;
}
public static void main(String[] args) throws IOException {
GetKeywordsParams params = new GetKeywordsParams();
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");
// Optional: Specify an ad group ID to restrict search to only a given ad group.
params.adGroupId = null;
// Optional: Add omit_unselected_resource_names=true to the PARAMETERS clause in the GAQL
// query of the search request.
params.omitUnselectedResourceNames = false;
}
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 GetKeywords()
.runExample(
googleAdsClient,
params.customerId,
params.adGroupId,
params.omitUnselectedResourceNames);
} 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 adGroupId the ad group ID for which keywords will be retrieved. If {@code null}, returns
* from all ad groups.
* @throws GoogleAdsException if an API request failed with one or more service errors.
* @throws Exception if the example failed due to other errors.
*/
private void runExample(
GoogleAdsClient googleAdsClient,
long customerId,
@Nullable Long adGroupId,
boolean omitUnselectedResourceNames) {
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
String searchQuery =
"SELECT ad_group.id, "
+ "ad_group_criterion.type, "
+ "ad_group_criterion.criterion_id, "
+ "ad_group_criterion.keyword.text, "
+ "ad_group_criterion.keyword.match_type "
+ "FROM ad_group_criterion "
+ "WHERE ad_group_criterion.type = KEYWORD ";
if (adGroupId != null) {
searchQuery += String.format("AND ad_group.id = %d", adGroupId);
}
// Adds omit_unselected_resource_names=true to the PARAMETERS clause of the GAQL query, which
// excludes the resource names of all resources that aren't explicitly requested in the SELECT
// clause. Enabling this option reduces payload size, but if you plan to use a returned
// object in subsequent mutate operations, make sure you explicitly request its
// "resource_name" field in your SELECT clause.
//
// Read more about PARAMETERS:
// https://developers.google.com/google-ads/api/docs/query/structure#parameters
if (omitUnselectedResourceNames) {
searchQuery += " PARAMETERS omit_unselected_resource_names=true";
}
// Creates a request that will retrieve all keywords using pages of the specified page size.
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setPageSize(PAGE_SIZE)
.setQuery(searchQuery)
.build();
// Issues the search request.
SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request);
// Iterates over all rows in all pages and prints the requested field values for the keyword
// in each row.
for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
AdGroup adGroup = googleAdsRow.getAdGroup();
AdGroupCriterion adGroupCriterion = googleAdsRow.getAdGroupCriterion();
KeywordInfo keywordInfo = adGroupCriterion.getKeyword();
String adGroupResourceNameStr =
(!omitUnselectedResourceNames)
? String.format(" and resource name '%s'", adGroup.getResourceName())
: "";
System.out.printf(
"Keyword with text '%s', match type '%s', criteria type '%s', and ID %d "
+ "was found in ad group with ID %d%s.%n",
keywordInfo.getText(),
keywordInfo.getMatchType(),
adGroupCriterion.getType(),
adGroupCriterion.getCriterionId(),
adGroup.getId(),
adGroupResourceNameStr);
}
}
}
}
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.V13.Errors;
using Google.Ads.GoogleAds.V13.Resources;
using Google.Ads.GoogleAds.V13.Services;
using System;
using System.Collections.Generic;
namespace Google.Ads.GoogleAds.Examples.V13
{
/// <summary>
/// This code example illustrates getting keywords and demonstrates how to use the
/// omit_unselected_resource_names option in GAQL to reduce payload size.
/// </summary>
public class GetKeywords : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="GetKeywords"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public long CustomerId { get; set; }
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("omitUnselectedResourceNames", Required = false, HelpText =
"Specifies whether to omit unselected resource names from response.",
Default = false)]
public bool? OmitUnselectedResourceNames { 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);
GetKeywords codeExample = new GetKeywords();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(),
options.CustomerId, options.OmitUnselectedResourceNames);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description => "This code example illustrates getting keywords " +
"and demonstrates how to use the omit_unselected_resource_names option in GAQL to " +
"reduce payload size.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="omitUnselectedResourceNames">Specifies whether to omit unselected resource
/// names from response.</param>
public void Run(GoogleAdsClient client, long customerId, bool? omitUnselectedResourceNames)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V13.GoogleAdsService);
try
{
string query =
$@"SELECT
ad_group.id,
ad_group.status,
ad_group_criterion.criterion_id,
ad_group_criterion.keyword.text,
ad_group_criterion.keyword.match_type
FROM ad_group_criterion
WHERE ad_group_criterion.type = 'KEYWORD'
AND ad_group.status = 'ENABLED'
AND ad_group_criterion.status IN ('ENABLED', 'PAUSED')";
// Adds omit_unselected_resource_names=true to the PARAMETERS clause of the
// Google Ads Query Language (GAQL) query, which excludes the resource names of
// all resources that aren't explicitly requested in the SELECT clause.
// Enabling this option reduces payload size, but if you plan to use a returned
// object in subsequent mutate operations, make sure you explicitly request its
// "resource_name" field in the SELECT clause.
//
// Read more about PARAMETERS:
// https://developers.google.com/google-ads/api/docs/query/structure#parameters
if (omitUnselectedResourceNames.HasValue && omitUnselectedResourceNames.Value)
{
query += " PARAMETERS omit_unselected_resource_names=true";
}
googleAdsService.SearchStream(customerId.ToString(), query,
delegate (SearchGoogleAdsStreamResponse resp)
{
foreach (GoogleAdsRow criterionRow in resp.Results)
{
AdGroup adGroup = criterionRow.AdGroup;
AdGroupCriterion criterion = criterionRow.AdGroupCriterion;
string andResourceName = null;
if (omitUnselectedResourceNames.HasValue &&
omitUnselectedResourceNames.Value)
{
andResourceName = "";
}
else
{
andResourceName = $" and resource name '{adGroup.ResourceName}'";
}
Console.WriteLine("Keyword with text '{0}', id = '{1}' and " +
"match type = '{2}' was retrieved for ad group '{3}'{4}.",
criterion.Keyword.Text, criterion.CriterionId,
criterion.Keyword.MatchType, adGroup.Id, andResourceName);
}
}
);
}
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\BasicOperations;
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\V13\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V13\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V13\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V13\Enums\CriterionTypeEnum\CriterionType;
use Google\Ads\GoogleAds\V13\Enums\KeywordMatchTypeEnum\KeywordMatchType;
use Google\Ads\GoogleAds\V13\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V13\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;
/**
* This example gets keywords from ad group criteria and demonstrates how to use the
* omit_unselected_resource_names option in Google Ads Query Language (GAQL) queries to reduce
* payload size.
*/
class GetKeywords
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
// Optional: Specify an ad group ID below to restrict search to only a given ad group.
private const AD_GROUP_ID = null;
// Optional: Change the below value to true to omit unselected resource names from the returned
// response of GoogleAdsService.
private const OMIT_UNSELECTED_RESOURCE_NAMES = false;
private const PAGE_SIZE = 1000;
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::AD_GROUP_ID => GetOpt::OPTIONAL_ARGUMENT,
ArgumentNames::OMIT_UNSELECTED_RESOURCE_NAMES => 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::AD_GROUP_ID] ?: self::AD_GROUP_ID,
filter_var(
$options[ArgumentNames::OMIT_UNSELECTED_RESOURCE_NAMES]
?: self::OMIT_UNSELECTED_RESOURCE_NAMES,
FILTER_VALIDATE_BOOLEAN
)
);
} 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|null $adGroupId the ad group ID for which keywords will be retrieved. If `null`,
* returns from all ad groups
* @param bool $omitUnselectedResourceNames whether to omit the resource names of all resources
* not explicitly requested in the SELECT clause of the GAQL query
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
?int $adGroupId,
bool $omitUnselectedResourceNames
) {
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves keywords.
$query =
'SELECT ad_group.id, '
. 'ad_group_criterion.type, '
. 'ad_group_criterion.criterion_id, '
. 'ad_group_criterion.keyword.text, '
. 'ad_group_criterion.keyword.match_type '
. 'FROM ad_group_criterion '
. 'WHERE ad_group_criterion.type = KEYWORD';
if ($adGroupId !== null) {
$query .= " AND ad_group.id = $adGroupId";
}
// Adds omit_unselected_resource_names=true to the PARAMETERS clause of the
// Google Ads Query Language (GAQL) query, which excludes the resource names of
// all resources that aren't explicitly requested in the SELECT clause.
// Enabling this option reduces payload size, but if you plan to use a returned
// object in subsequent mutate operations, make sure you explicitly request its
// "resource_name" field in the SELECT clause.
//
// Read more about PARAMETERS:
// https://developers.google.com/google-ads/api/docs/query/structure#parameters
if ($omitUnselectedResourceNames) {
$query .= ' PARAMETERS omit_unselected_resource_names=true';
}
// Issues a search request by specifying page size.
$response =
$googleAdsServiceClient->search($customerId, $query, ['pageSize' => self::PAGE_SIZE]);
// Iterates over all rows in all pages and prints the requested field values for
// the keyword in each row.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$resourceNameString = $omitUnselectedResourceNames ? '' : sprintf(
" and resource name '%s'",
$googleAdsRow->getAdGroup()->getResourceName()
);
printf(
"Keyword with text '%s', match type '%s', criterion type '%s', and ID %d "
. "was found in ad group with ID %d%s.%s",
$googleAdsRow->getAdGroupCriterion()->getKeyword()->getText(),
KeywordMatchType::name(
$googleAdsRow->getAdGroupCriterion()->getKeyword()->getMatchType()
),
CriterionType::name($googleAdsRow->getAdGroupCriterion()->getType()),
$googleAdsRow->getAdGroupCriterion()->getCriterionId(),
$googleAdsRow->getAdGroup()->getId(),
$resourceNameString,
PHP_EOL
);
}
}
}
GetKeywords::main();
Python
#!/usr/bin/env python
# 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 retrieves keywords for a customer for a specific ad group.
It also demonstrates how to use the omit_unselected_resource_names option in
GAQL to reduce payload size.
"""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
_DEFAULT_PAGE_SIZE = 1000
def main(
client, customer_id, page_size, ad_group_id, omit_unselected_resource_names
):
ga_service = client.get_service("GoogleAdsService")
query = """
SELECT
ad_group.id,
ad_group_criterion.type,
ad_group_criterion.criterion_id,
ad_group_criterion.keyword.text,
ad_group_criterion.keyword.match_type
FROM ad_group_criterion
WHERE ad_group_criterion.type = KEYWORD"""
if ad_group_id:
query += f" AND ad_group.id = {ad_group_id}"
# Adds omit_unselected_resource_names=true to the PARAMETERS clause of the
# Google Ads Query Language (GAQL) query, which excludes the resource names
# of all resources that aren't explicitly requested in the SELECT clause.
# Enabling this option reduces payload size, but if you plan to use a
# returned object in subsequent mutate operations, make sure you explicitly
# request its "resource_name" field in the SELECT clause.
#
# Read more about PARAMETERS:
# https://developers.google.com/google-ads/api/docs/query/structure#parameters
if omit_unselected_resource_names:
query += " PARAMETERS omit_unselected_resource_names=true"
search_request = client.get_type("SearchGoogleAdsRequest")
search_request.customer_id = customer_id
search_request.query = query
search_request.page_size = page_size
results = ga_service.search(request=search_request)
for row in results:
ad_group = row.ad_group
ad_group_criterion = row.ad_group_criterion
keyword = row.ad_group_criterion.keyword
if omit_unselected_resource_names:
resource_name_log_statement = ""
else:
resource_name_log_statement = (
f" and resource name '{ad_group.resource_name}'"
)
print(
f'Keyword with text "{keyword.text}", match type '
f"{keyword.match_type}, criteria type "
f"{ad_group_criterion.type_}, and ID "
f"{ad_group_criterion.criterion_id} was found in ad group "
f"with ID {ad_group.id}{resource_name_log_statement}."
)
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v13")
parser = argparse.ArgumentParser(
description=(
"Retrieves keywords for the specified customer, or "
"optionally for a specific ad group."
)
)
# 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(
"-a", "--ad_group_id", type=str, help="The ad group ID."
)
parser.add_argument(
"-o",
"--omit-unselected-resource-names",
type=bool,
default=False,
help="Whether or not the response should omit resource names.",
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
_DEFAULT_PAGE_SIZE,
args.ad_group_id,
args.omit_unselected_resource_names,
)
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'\tError with message "{error.message}".')
if error.location:
for field_path_element in error.location.field_path_elements:
print(f"\t\tOn 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 retrieves keywords for a customer or for a specific Ad Group and
# demonstrates how to use the omit_unselected_resource_names option in GAQL to
# reduce payload size.
require 'optparse'
require 'google/ads/google_ads'
def get_keywords(customer_id, ad_group_id=nil, omit_unselected_resource_names=false)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
search_query = <<~QUERY
SELECT ad_group.id,
ad_group_criterion.type,
ad_group_criterion.criterion_id,
ad_group_criterion.keyword.text,
ad_group_criterion.keyword.match_type
FROM ad_group_criterion
WHERE ad_group_criterion.type = KEYWORD
QUERY
if ad_group_id
search_query << " AND ad_group.id = #{ad_group_id}"
end
# Adds omit_unselected_resource_names=true to the PARAMETERS clause of the
# Google Ads Query Language (GAQL) query, which excludes the resource names of
# all resources that aren't explicitly requested in the SELECT clause.
# Enabling this option reduces payload size, but if you plan to use a returned
# object in subsequent mutate operations, make sure you explicitly request its
# "resource_name" field in the SELECT clause.
#
# Read more about PARAMETERS:
# https://developers.google.com/google-ads/api/docs/query/structure#parameters
if omit_unselected_resource_names
search_query << ' PARAMETERS omit_unselected_resource_names=true'
end
response = client.service.google_ads.search(
customer_id: customer_id,
query: search_query,
page_size: PAGE_SIZE,
)
response.each do |row|
ad_group = row.ad_group
ad_group_criterion = row.ad_group_criterion
keyword_info = ad_group_criterion.keyword
if omit_unselected_resource_names
and_resource_name = ''
else
and_resource_name = " and resource name #{ad_group.resource_name}"
end
puts "Keyword with text '#{keyword_info.text}', match type #{keyword_info.match_type}, " \
"criteria type #{ad_group_criterion.type}, and ID #{ad_group_criterion.criterion_id} " \
"was found in ad group with ID #{ad_group.id}#{and_resource_name}."
end
end
if __FILE__ == $0
PAGE_SIZE = 1000
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.
#
options[:customer_id] = 'INSERT_CUSTOMER_ID_HERE'
options[:ad_group_id] = 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('-A', '--ad-group-id AD-GROUP-ID', String,
'(Optional) Ad Group ID') do |v|
options[:ad_group_id] = v
end
opts.on('-o', '--omit-unselected-resource-names OMIT-UNSELECTED-RESOURCE-NAMES', TrueClass,
'(Optional) Omit unselected resource names') do |v|
options[:omit_unselected_resource_names] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
get_keywords(
options.fetch(:customer_id).tr("-", ""),
options[:ad_group_id],
options[:omit_unselected_resource_names])
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
e.failure.errors.each do |error|
STDERR.printf("Error with message: %s\n", error.message)
if error.location
error.location.field_path_elements.each do |field_path_element|
STDERR.printf("\tOn field: %s\n", field_path_element.field_name)
end
end
error.error_code.to_h.each do |k, v|
next if v == :UNSPECIFIED
STDERR.printf("\tType: %s\n\tCode: %s\n", k, v)
end
end
raise
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 retrieves keywords for a customer or for a specific ad group and
# demonstrates how to use the omit_unselected_resource_names option in GAQL to
# reduce payload size.
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::Utils::SearchGoogleAdsIterator;
use
Google::Ads::GoogleAds::V13::Services::GoogleAdsService::SearchGoogleAdsRequest;
use Getopt::Long qw(:config auto_help);
use Pod::Usage;
use Cwd qw(abs_path);
use constant PAGE_SIZE => 1000;
# 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";
# Optional: Specify an ad group ID below to restrict search to only a given ad group.
my $ad_group_id = undef;
# Optional: Change the below value to "true" to omit unselected resource names from
# the returned response of GoogleAdsService.
my $omit_unselected_resource_names = undef;
sub get_keywords {
my ($api_client, $customer_id, $ad_group_id, $omit_unselected_resource_names)
= @_;
# Create the search query.
my $search_query =
"SELECT ad_group.id, ad_group_criterion.type, " .
"ad_group_criterion.criterion_id, " .
"ad_group_criterion.keyword.text, " .
"ad_group_criterion.keyword.match_type FROM ad_group_criterion " .
"WHERE ad_group_criterion.type = KEYWORD";
if (defined $ad_group_id) {
$search_query .= " AND ad_group.id = $ad_group_id";
}
# Add omit_unselected_resource_names = true to the PARAMETERS clause of the
# Google Ads Query Language (GAQL) query, which excludes the resource names of
# all resources that aren't explicitly requested in the SELECT clause.
# Enabling this option reduces payload size, but if you plan to use a returned
# object in subsequent mutate operations, make sure you explicitly request its
# "resource_name" field in the SELECT clause.
#
# Read more about PARAMETERS:
# https://developers.google.com/google-ads/api/docs/query/structure#parameters
if (defined $omit_unselected_resource_names) {
$search_query .= " PARAMETERS omit_unselected_resource_names = true";
}
# Create a search Google Ads request that will retrieve all keywords using pages
# of the specified page size.
my $search_request =
Google::Ads::GoogleAds::V13::Services::GoogleAdsService::SearchGoogleAdsRequest
->new({
customerId => $customer_id,
query => $search_query,
pageSize => PAGE_SIZE
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
my $iterator = Google::Ads::GoogleAds::Utils::SearchGoogleAdsIterator->new({
service => $google_ads_service,
request => $search_request
});
# Iterate over all rows in all pages and print the requested field values for
# the keyword in each row.
while ($iterator->has_next) {
my $google_ads_row = $iterator->next;
my $ad_group = $google_ads_row->{adGroup};
my $ad_group_criterion = $google_ads_row->{adGroupCriterion};
my $keyword_info = $ad_group_criterion->{keyword};
my $resource_name_string =
defined $omit_unselected_resource_names
? ""
: sprintf " and resource name '%s'", $ad_group->{resourceName};
printf
"Keyword with text '%s', match type '%s', criteria type '%s', and ID %d "
. "was found in ad group with ID %d%s.\n",
$keyword_info->{text},
$keyword_info->{matchType},
$ad_group_criterion->{type},
$ad_group_criterion->{criterionId},
$ad_group->{id},
$resource_name_string;
}
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,
"ad_group_id=i" => \$ad_group_id,
"omit_unselected_resource_names=s" => \$omit_unselected_resource_names
);
# 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);
# Call the example.
get_keywords(
$api_client, $customer_id =~ s/-//gr,
$ad_group_id, $omit_unselected_resource_names
);
=pod
=head1 NAME
get_keywords
=head1 DESCRIPTION
This example retrieves keywords for a customer or for a specific ad group and
demonstrates how to use the omit_unselected_resource_names option in GAQL to
reduce payload size.
=head1 SYNOPSIS
get_keywords.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id [optional] The ad group ID from which keywords will be retrieved.
If not set, keywords from all ad groups will be returned.
-omit_unselected_resource_names [optional] Whether to omit the resource names of all resources
not explicitly requested in the SELECT clause of the GAQL query.
=cut