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.v14.errors.GoogleAdsError;
import com.google.ads.googleads.v14.errors.GoogleAdsException;
import com.google.ads.googleads.v14.services.AdGroupCriterionOperation;
import com.google.ads.googleads.v14.services.AdGroupCriterionServiceClient;
import com.google.ads.googleads.v14.services.MutateAdGroupCriteriaResponse;
import com.google.ads.googleads.v14.services.MutateAdGroupCriterionResult;
import com.google.ads.googleads.v14.utils.ResourceNames;
import com.google.common.collect.Lists;
import java.io.FileNotFoundException;
import java.io.IOException;
/**
* Deletes a keyword as an ad group criterion using the 'REMOVE' operation. To get keyword, run
* GetKeywords.java.
*/
public class RemoveKeyword {
private static class RemoveKeywordParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.AD_GROUP_ID, required = true)
private Long adGroupId;
@Parameter(names = ArgumentNames.CRITERION_ID, required = true)
private Long criterionId;
}
public static void main(String[] args) {
RemoveKeywordParams params = new RemoveKeywordParams();
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.adGroupId = Long.parseLong("INSERT_AD_GROUP_ID_HERE");
params.criterionId = Long.parseLong("INSERT_AD_GROUP_CRITERION_ID_HERE");
}
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 RemoveKeyword()
.runExample(googleAdsClient, params.customerId, params.adGroupId, params.criterionId);
} 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 ID of the ad group for the keyword criterion.
* @param criterionId the ID of the keyword criterion to remove.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(
GoogleAdsClient googleAdsClient, long customerId, long adGroupId, long criterionId) {
try (AdGroupCriterionServiceClient adGroupCriterionServiceClient =
googleAdsClient.getLatestVersion().createAdGroupCriterionServiceClient()) {
String adGroupCriterionResourceName =
ResourceNames.adGroupCriterion(customerId, adGroupId, criterionId);
// Constructs an operation that will remove the keyword with the specified resource name.
AdGroupCriterionOperation operation =
AdGroupCriterionOperation.newBuilder().setRemove(adGroupCriterionResourceName).build();
// Sends the operation in a mutate request.
MutateAdGroupCriteriaResponse response =
adGroupCriterionServiceClient.mutateAdGroupCriteria(
Long.toString(customerId), Lists.newArrayList(operation));
// Prints the resource name of each removed object.
for (MutateAdGroupCriterionResult mutateAdGroupCriterionResult : response.getResultsList()) {
System.out.printf(
"Removed ad group criterion with resource name: '%s'.%n",
mutateAdGroupCriterionResult.getResourceName());
}
}
}
}
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.V14.Errors;
using Google.Ads.GoogleAds.V14.Resources;
using Google.Ads.GoogleAds.V14.Services;
using System;
using System.Collections.Generic;
namespace Google.Ads.GoogleAds.Examples.V14
{
/// <summary>
/// This code example removes a keyword. To get keywords, run GetKeywords.cs.
/// </summary>
public class RemoveKeyword : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="RemoveKeyword"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The customer account ID.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The customer account ID.")]
public long CustomerId { get; set; }
/// <summary>
/// Id of the ad group that contains the keyword.
/// </summary>
[Option("adGroupId", Required = true, HelpText =
"Id of the ad group that contains the keyword.")]
public long AdGroupId { get; set; }
/// <summary>
/// Id of the keyword to be removed.
/// </summary>
[Option("criterionId", Required = true, HelpText =
"Id of the keyword to be removed.")]
public long CriterionId { 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);
RemoveKeyword codeExample = new RemoveKeyword();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(),
options.CustomerId,
options.AdGroupId,
options.CriterionId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example removes a keyword using the 'REMOVE' operator. To get keywords, " +
"run GetKeywords.cs.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer account ID.</param>
/// <param name="adGroupId">Id of the ad group that contains the keyword.</param>
/// <param name="criterionId">Id of the keyword to be removed.</param>
public void Run(GoogleAdsClient client, long customerId, long adGroupId, long criterionId)
{
// Get the AdGroupCriterionService.
AdGroupCriterionServiceClient adGroupCriterionService = client.GetService(
Services.V14.AdGroupCriterionService);
// Create the operation.
AdGroupCriterionOperation operation = new AdGroupCriterionOperation();
operation.Remove = ResourceNames.AdGroupCriterion(customerId, adGroupId, criterionId);
try
{
// Remove the keyword.
MutateAdGroupCriteriaResponse retVal =
adGroupCriterionService.MutateAdGroupCriteria(customerId.ToString(),
new AdGroupCriterionOperation[] { operation });
// Display the results.
MutateAdGroupCriterionResult removedKeyword = retVal.Results[0];
Console.WriteLine($"Keyword with resource name = " +
$"'{removedKeyword.ResourceName}' was removed.");
}
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\V14\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V14\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V14\ResourceNames;
use Google\Ads\GoogleAds\V14\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V14\Resources\AdGroupCriterion;
use Google\Ads\GoogleAds\V14\Services\AdGroupCriterionOperation;
use Google\Ads\GoogleAds\V14\Services\MutateAdGroupCriteriaRequest;
use Google\ApiCore\ApiException;
/**
* This example deletes a keyword (ad group criterion) using the 'REMOVE' operation. To get
* keywords, run GetKeywords.php. This example can also be used to remove other types of
* ad group criterion.
*/
class RemoveKeyword
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE';
private const CRITERION_ID = 'INSERT_CRITERION_ID_HERE';
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::REQUIRED_ARGUMENT,
ArgumentNames::CRITERION_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)
// We set this value to true to show how to use GAPIC v2 source code. You can remove the
// below line if you wish to use the old-style source code. Note that in that case, you
// probably need to modify some parts of the code below to make it work.
// For more information, see
// https://developers.devsite.corp.google.com/google-ads/api/docs/client-libs/php/gapic.
->usingGapicV2Source(true)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::AD_GROUP_ID] ?: self::AD_GROUP_ID,
$options[ArgumentNames::CRITERION_ID] ?: self::CRITERION_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
);
}
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 $adGroupId the ad group ID that the ad group criterion belongs to
* @param int $criterionId the ID of the ad group criterion to remove
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $adGroupId,
int $criterionId
) {
// Creates ad group criterion resource name.
$adGroupCriterionResourceName =
ResourceNames::forAdGroupCriterion($customerId, $adGroupId, $criterionId);
// Constructs an operation that will remove the keyword with the specified resource name.
$adGroupCriterionOperation = new AdGroupCriterionOperation();
$adGroupCriterionOperation->setRemove($adGroupCriterionResourceName);
// Issues a mutate request to remove the ad group criterion.
$adGroupCriterionServiceClient = $googleAdsClient->getAdGroupCriterionServiceClient();
$response = $adGroupCriterionServiceClient->mutateAdGroupCriteria(
MutateAdGroupCriteriaRequest::build($customerId, [$adGroupCriterionOperation])
);
// Prints the resource name of the removed ad group criterion.
/** @var AdGroupCriterion $removedAdGroupCriterion */
$removedAdGroupCriterion = $response->getResults()[0];
printf(
"Removed ad group criterion with resource name: '%s'%s",
$removedAdGroupCriterion->getResourceName(),
PHP_EOL
);
}
}
RemoveKeyword::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 removes an existing keyword from an ad group."""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, ad_group_id, criterion_id):
agc_service = client.get_service("AdGroupCriterionService")
agc_operation = client.get_type("AdGroupCriterionOperation")
resource_name = agc_service.ad_group_criterion_path(
customer_id, ad_group_id, criterion_id
)
agc_operation.remove = resource_name
agc_response = agc_service.mutate_ad_group_criteria(
customer_id=customer_id, operations=[agc_operation]
)
print(f"Removed keyword {agc_response.results[0].resource_name}.")
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="v14")
parser = argparse.ArgumentParser(
description=("Removes given campaign for the specified customer.")
)
# 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, required=True, help="The ad group ID."
)
parser.add_argument(
"-k",
"--criterion_id",
type=str,
required=True,
help="The criterion ID, or keyword ID.",
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
args.ad_group_id,
args.criterion_id,
)
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.
#
# Example demonstrating how to remove keyword in an ad group
require 'optparse'
require 'google/ads/google_ads'
def remove_keyword(customer_id, ad_group_id, criteria_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
resource = client.path.ad_group_criterion(customer_id, ad_group_id, criteria_id)
# Remove keyword
operation = client.operation.remove_resource.ad_group_criterion(resource)
response = client.service.ad_group_criterion.mutate_ad_group_criteria(
customer_id: customer_id,
operations: [operation],
)
puts "Removed keyword #{response.results.first.resource_name}"
end
if __FILE__ == $PROGRAM_NAME
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_GOOGLE_ADS_CUSTOMER_ID_HERE'
options[:ad_group_id] = 'INSERT_AD_GROUP_ID_HERE'
options[:criteria_id] = 'INSERT_CRITERIA_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('-A', '--ad-group-id AD-GROUP-ID', String, 'Ad Group ID') do |v|
options[:ad_group_id] = v
end
opts.on('-r', '--criterion-id CRITERION-ID', String,
'Criteria ID (aka Keyword ID)') do |v|
options[:criteria_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
remove_keyword(
options.fetch(:customer_id).tr("-", ""), options[:ad_group_id], options[:criteria_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
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 deletes a keyword as an ad group criterion. To get keywords, run
# get_keywords.pl.
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::V14::Services::AdGroupCriterionService::AdGroupCriterionOperation;
use Google::Ads::GoogleAds::V14::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";
my $ad_group_id = "INSERT_AD_GROUP_ID_HERE";
my $criterion_id = "INSERT_CRITERION_ID_HERE";
sub remove_keyword {
my ($api_client, $customer_id, $ad_group_id, $criterion_id) = @_;
# Create a single remove operation, specifying the keyword ad group criterion's
# resource name.
my $ad_group_criterion_operation =
Google::Ads::GoogleAds::V14::Services::AdGroupCriterionService::AdGroupCriterionOperation
->new({
remove =>
Google::Ads::GoogleAds::V14::Utils::ResourceNames::ad_group_criterion(
$customer_id, $ad_group_id, $criterion_id
)});
# Remove the keyword criterion.
my $ad_group_criteria_response =
$api_client->AdGroupCriterionService()->mutate({
customerId => $customer_id,
operations => [$ad_group_criterion_operation]});
printf "Removed keyword criterion with resource name: '%s'.\n",
$ad_group_criteria_response->{results}[0]{resourceName};
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,
"criterion_id=i" => \$criterion_id
);
# 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, $ad_group_id, $criterion_id);
# Call the example.
remove_keyword($api_client, $customer_id =~ s/-//gr,
$ad_group_id, $criterion_id);
=pod
=head1 NAME
remove_keyword
=head1 DESCRIPTION
This example deletes a keyword as an ad group criterion. To get keywords,
run get_keywords.pl.
=head1 SYNOPSIS
remove_keyword.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id The ad group ID.
-criterion_id The criterion ID, aka the keyword ID.
=cut
