// 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.targeting;
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.v1.errors.GoogleAdsException;
import com.google.ads.googleads.v1.errors.GoogleAdsError;
import com.google.ads.googleads.v1.resources.CampaignCriterion;
import com.google.ads.googleads.v1.resources.CampaignCriterion.CriterionCase;
import com.google.ads.googleads.v1.services.GoogleAdsRow;
import com.google.ads.googleads.v1.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v1.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v1.services.SearchGoogleAdsRequest;
import java.io.FileNotFoundException;
import java.io.IOException;
/**
* This example gets all campaign criteria. To add campaign criteria, run AddCampaignCriteria.java.
*/
public class GetCampaignTargetingCriteria {
private static final int PAGE_SIZE = 1_000;
private static class GetCampaignsWithStatsParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.CAMPAIGN_ID, required = true)
private Long campaignId;
}
public static void main(String[] args) {
GetCampaignsWithStatsParams params = new GetCampaignsWithStatsParams();
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.campaignId = Long.parseLong("INSERT_CAMPAIGN_ID_HERE");
}
GoogleAdsClient googleAdsClient;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
return;
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
return;
}
try {
new GetCampaignTargetingCriteria()
.runExample(googleAdsClient, params.customerId, params.campaignId);
} 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);
}
}
}
/**
* Runs the example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @param campaignId the campaign ID.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(GoogleAdsClient googleAdsClient, long customerId, long campaignId) {
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
// Creates a request that will retrieve all campaign criteria using pages of the specified
// page size.
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setPageSize(PAGE_SIZE)
.setQuery(
String.format(
"SELECT campaign.id, campaign_criterion.campaign, "
+ " campaign_criterion.criterion_id,"
+ " campaign_criterion.negative, campaign_criterion.keyword.text,"
+ " campaign_criterion.keyword.match_type FROM campaign_criterion"
+ " WHERE campaign.id = %s",
Long.toString(campaignId)))
.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 campaign
// criteria in each row.
for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
CampaignCriterion campaignCriterion = googleAdsRow.getCampaignCriterion();
System.out.printf(
"Campaign criterion with ID %d was found as a %s",
campaignCriterion.getCriterionId().getValue(),
campaignCriterion.getNegative().getValue() ? "negative " : "");
if (CriterionCase.KEYWORD.equals(campaignCriterion.getCriterionCase())) {
System.out.printf(
"keyword with text '%s' and match type '%s'.%n",
campaignCriterion.getKeyword().getText().getValue(),
campaignCriterion.getKeyword().getMatchType());
} else {
System.out.printf("non-keyword.%n");
}
}
}
}
}
// 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
//
// 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 Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V1.Errors;
using Google.Ads.GoogleAds.V1.Resources;
using Google.Ads.GoogleAds.V1.Services;
using Google.Api.Gax;
using System;
using static Google.Ads.GoogleAds.V1.Resources.CampaignCriterion;
namespace Google.Ads.GoogleAds.Examples.V1
{
/// <summary>
/// This code example illustrates getting campaign targeting criteria.
/// </summary>
public class GetCampaignTargetingCriteria : ExampleBase
{
/// <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)
{
GetCampaignTargetingCriteria codeExample = new GetCampaignTargetingCriteria();
Console.WriteLine(codeExample.Description);
// The Google Ads customer ID for which the call is made.
long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE");
// ID of the campaign to from which targeting criteria are retrieved.
long campaignId = long.Parse("INSERT_CAMPAIGN_ID_HERE");
codeExample.Run(new GoogleAdsClient(), customerId, campaignId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description
{
get
{
return "This code example illustrates getting campaign targeting criteria.";
}
}
/// <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="campaignId">ID of the campaign to from which targeting criteria are
/// retrieved.</param>
public void Run(GoogleAdsClient client, long customerId, long campaignId)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V1.GoogleAdsService);
// Create the query.
string query = $@"SELECT campaign.id, campaign_criterion.campaign,
campaign_criterion.criterion_id, campaign_criterion.negative,
campaign_criterion.keyword.text, campaign_criterion.keyword.match_type
FROM campaign_criterion WHERE campaign.id = {campaignId}";
try
{
// Issue a search request.
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> result =
googleAdsService.Search(customerId.ToString(), query);
// Display the results.
foreach (GoogleAdsRow criterionRow in result)
{
CampaignCriterion criterion = criterionRow.CampaignCriterion;
Console.Write($"Campaign criterion with id = '{criterion.CriterionId}' " +
"was retrieved:");
if (criterion.Negative.Value)
{
Console.Write("Negative ");
}
switch (criterion.CriterionCase)
{
case CriterionOneofCase.Keyword:
Console.Write($"Keyword with text '{criterion.Keyword.Text}' ");
Console.WriteLine($"and match type {criterion.Keyword.MatchType}.");
break;
default:
Console.WriteLine("Not a Keyword!");
break;
}
}
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
}
}
}
}
<?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\Targeting;
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\V1\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V1\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V1\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V1\Enums\CriterionTypeEnum\CriterionType;
use Google\Ads\GoogleAds\V1\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V1\Services\GoogleAdsRow;
use Google\ApiCore\ApiException;
/**
* This example gets all campaign criteria. To add campaign criteria, run
* AddCampaignTargetingCriteria.php.
*/
class GetCampaignTargetingCriteria
{
const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
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::CAMPAIGN_ID => GetOpt::REQUIRED_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::CAMPAIGN_ID] ?: self::CAMPAIGN_ID
);
} 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
);
}
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the client customer ID without hyphens
* @param int $campaignId the campaign ID for which campaign criteria will be retrieved
*/
public static function runExample(GoogleAdsClient $googleAdsClient, $customerId, $campaignId)
{
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves campaign criteria.
$query = 'SELECT campaign.id, campaign_criterion.campaign, '
. 'campaign_criterion.criterion_id, campaign_criterion.type, '
. 'campaign_criterion.negative, campaign_criterion.keyword.text, '
. 'campaign_criterion.keyword.match_type FROM campaign_criterion'
. ' WHERE campaign.id = ' . $campaignId;
// 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 campaign criterion in each row.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$campaignCriterion = $googleAdsRow->getCampaignCriterion();
// Note that the match type printed below is an enum value.
// For example, a value of 4 will be returned when the keyword match type is 'BROAD'.
// A mapping of enum names to values can be found at KeywordMatchType.php
printf(
"Campaign criterion with ID %d was found as a %s",
$campaignCriterion->getCriterionId()->getValue(),
$campaignCriterion->getNegative()->getValue() ? 'negative ' : ''
);
if ($campaignCriterion->getType() === CriterionType::KEYWORD) {
printf(
"keyword with text '%s' and match type %d.%s",
$campaignCriterion->getKeyword()->getText()->getValue(),
$campaignCriterion->getKeyword()->getMatchType(),
PHP_EOL
);
} else {
print 'non-keyword.' . PHP_EOL;
}
}
}
}
GetCampaignTargetingCriteria::main();
# 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 illustrates how to get campaign criteria, or negative keywords.
"""
from __future__ import absolute_import
import argparse
import six
import sys
import google.ads.google_ads.client
_DEFAULT_PAGE_SIZE = 1000
def main(client, customer_id, campaign_id, page_size):
ga_service = client.get_service('GoogleAdsService', version='v1')
query = ('SELECT campaign.id, campaign_criterion.campaign, '
'campaign_criterion.criterion_id, campaign_criterion.negative, '
'campaign_criterion.type, campaign_criterion.keyword.text, '
'campaign_criterion.keyword.match_type '
'FROM campaign_criterion '
'WHERE campaign.id = %s') % campaign_id
results = ga_service.search(customer_id, query=query, page_size=page_size)
try:
for row in results:
criterion = row.campaign_criterion
print('Campaign criterion with ID "%s" was retrieved:'
% criterion.criterion_id.value)
if criterion.type == client.get_type('CriterionTypeEnum',
version='v1').KEYWORD:
print('\t%sKeyword with text "%s" and match type %s.'
% ('' if criterion.negative.value else 'Negative',
criterion.keyword.text.value,
criterion.keyword.match_type))
else:
print('Not a keyword!')
except google.ads.google_ads.errors.GoogleAdsException as ex:
print('Request with ID "%s" failed with status "%s" and includes the '
'following errors:' % (ex.request_id, ex.error.code().name))
for error in ex.failure.errors:
print('\tError with message "%s".' % error.message)
if error.location:
for field_path_element in error.location.field_path_elements:
print('\t\tOn field: %s' % field_path_element.field_name)
sys.exit(1)
if __name__ == '__main__':
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
google_ads_client = (google.ads.google_ads.client.GoogleAdsClient
.load_from_storage())
parser = argparse.ArgumentParser(
description=('List campaign criteria, or negative keywords, for a '
'given campaign.'))
# The following argument(s) should be provided to run the example.
parser.add_argument('-c', '--customer_id', type=six.text_type,
required=True, help='The Google Ads customer ID.')
parser.add_argument('-i', '--campaign_id', type=six.text_type,
required=True, help='The campaign ID.')
args = parser.parse_args()
main(google_ads_client, args.customer_id, args.campaign_id,
_DEFAULT_PAGE_SIZE)
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright:: 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 code example illustrates how to get campaign criteria, which is getting
# negative keywords in a campaign.
require 'optparse'
require 'google/ads/google_ads'
def get_campaign_targeting_criteria(customer_id, campaign_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
ga_service = client.service(:GoogleAds)
query = <<~QUERY
SELECT campaign.id,
campaign_criterion.campaign,
campaign_criterion.criterion_id,
campaign_criterion.negative,
campaign_criterion.type,
campaign_criterion.keyword.text,
campaign_criterion.keyword.match_type
FROM campaign_criterion
WHERE campaign.id = %s
QUERY
response = ga_service.search(customer_id, sprintf(query, campaign_id),
page_size: PAGE_SIZE)
response.each do |row|
criterion = row.campaign_criterion
puts sprintf("Campaign criterion with id = '%s' was retrieved:",
criterion.criterion_id)
if criterion.type == :KEYWORD
puts sprintf("\t%sKeyword with text '%s' and match type %s.",
criterion.negative.value ? "Negative " : "",
criterion.keyword.text,
criterion.keyword.match_type)
else
puts "Not a keyword!"
end
end
end
if __FILE__ == $PROGRAM_NAME
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.
#
# Running the example with -h will print the command line usage.
options[:customer_id] = 'INSERT_ADWORDS_CUSTOMER_ID_HERE'
options[:campaign_id] = 'INSERT_CAMPAIGN_ID_HERE'
OptionParser.new do |opts|
opts.banner = sprintf('Usage: ruby %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('-c', '--campaign-id CAMPAIGN-ID', String, 'Campaign ID') do |v|
options[:campaign_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
get_campaign_targeting_criteria(options.fetch(:customer_id).tr("-", ""),
options[:campaign_id])
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
rescue Google::Gax::RetryError => e
STDERR.printf("Error: '%s'\n\tCause: '%s'\n\tCode: %d\n\tDetails: '%s'\n" \
"\tRequest-Id: '%s'\n", e.message, e.cause.message, e.cause.code,
e.cause.details, e.cause.metadata['request-id'])
end
end
Need help? Visit our