// 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.v2.errors.GoogleAdsException; import com.google.ads.googleads.lib.utils.FieldMasks; import com.google.ads.googleads.v2.utils.ResourceNames; import com.google.ads.googleads.v2.enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus; import com.google.ads.googleads.v2.errors.GoogleAdsError; import com.google.ads.googleads.v2.resources.AdGroupCriterion; import com.google.ads.googleads.v2.services.AdGroupCriterionOperation; import com.google.ads.googleads.v2.services.AdGroupCriterionServiceClient; import com.google.ads.googleads.v2.services.MutateAdGroupCriteriaResponse; import com.google.ads.googleads.v2.services.MutateAdGroupCriterionResult; import com.google.common.collect.ImmutableList; import com.google.protobuf.StringValue; import java.io.FileNotFoundException; import java.io.IOException; /** * Updates a keyword ({@code AdGroupCriterion}) in an ad group. To get keywords, run * GetKeywords.java. */ public class UpdateKeyword { private static class UpdateAdGroupParams 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) { UpdateAdGroupParams params = new UpdateAdGroupParams(); 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_CRITERION_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 UpdateKeyword() .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); } } } /** * Runs the example. * * @param googleAdsClient the Google Ads API client. * @param customerId the client customer ID. * @param adGroupId the ID of the ad group that the criterionId belongs to. * @param criterionId the ID of criterion to update. * @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()) { // Creates an ad group criterion object with the proper resource name and any other changes. AdGroupCriterion adGroupCriterion = AdGroupCriterion.newBuilder() .setResourceName(ResourceNames.adGroupCriterion(customerId, adGroupId, criterionId)) .setStatus(AdGroupCriterionStatus.ENABLED) .addFinalUrls(StringValue.of("https://www.example.com")) .build(); // Constructs an operation that will update the ad group criterion, using the FieldMasks // utility to derive the update mask. This mask tells the Google Ads API which attributes of // the ad group criterion you want to change. AdGroupCriterionOperation operation = AdGroupCriterionOperation.newBuilder() .setUpdate(adGroupCriterion) .setUpdateMask(FieldMasks.allSetFieldsOf(adGroupCriterion)) .build(); // Sends the operation in a mutate request. MutateAdGroupCriteriaResponse response = adGroupCriterionServiceClient.mutateAdGroupCriteria( Long.toString(customerId), ImmutableList.of(operation)); // Prints the resource name of each updated object. for (MutateAdGroupCriterionResult mutateAdGroupCriterionResult : response.getResultsList()) { System.out.printf( "Updated ad group criterion with the resource name: '%s'.%n", mutateAdGroupCriterionResult.getResourceName()); } } } }
// 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 Google.Ads.GoogleAds.Lib; using Google.Ads.GoogleAds.Util; using Google.Ads.GoogleAds.V2.Errors; using Google.Ads.GoogleAds.V2.Resources; using Google.Ads.GoogleAds.V2.Services; using System; using static Google.Ads.GoogleAds.V2.Enums.AdGroupCriterionStatusEnum.Types; namespace Google.Ads.GoogleAds.Examples.V2 { /// <summary> /// This code example illustrates udating a keyword. /// </summary> public class UpdateKeyword : 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) { UpdateKeyword codeExample = new UpdateKeyword(); Console.WriteLine(codeExample.Description); // the Google Ads Customer Id long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE"); // the Google Ads adgroup Id long adGroupId = long.Parse("INSERT_ADGROUP_ID_HERE"); // the Google Ads adgroup criterion Id long keywordId = long.Parse("INSERT_ADGROUP_CRITERION_ID_HERE"); codeExample.Run(new GoogleAdsClient(), customerId, adGroupId, keywordId); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description { get { return "This code example illustrates updating a keyword."; } } /// <summary> /// Runs the code example. /// </summary> /// <param name="client">The Google Ads client.</param> /// <param name="customerId">The Google Ads customer Id.</param> /// <param name="adGroupId">The Google Ads ad group Id.</param> /// <param name="keywordId">The Google Ads keyword Id.</param> public void Run(GoogleAdsClient client, long customerId, long adGroupId, long keywordId) { // Get the CampaignCriterionService. AdGroupCriterionServiceClient adGroupCriterionService = client.GetService(Services.V2.AdGroupCriterionService); // Create the keyword for update. AdGroupCriterion keyword = new AdGroupCriterion() { ResourceName = ResourceNames.AdGroupCriterion(customerId, adGroupId, keywordId), CriterionId = keywordId, Status = AdGroupCriterionStatus.Enabled, FinalUrls = { "https://www.example.com" } }; AdGroupCriterionOperation keywordOperation = new AdGroupCriterionOperation() { Update = keyword, UpdateMask = FieldMasks.AllSetFieldsOf(keyword) }; try { // Update the keyword. MutateAdGroupCriteriaResponse response = adGroupCriterionService.MutateAdGroupCriteria(customerId.ToString(), new AdGroupCriterionOperation[] { keywordOperation }); // Display the results. foreach (MutateAdGroupCriterionResult criterionResult in response.Results) { Console.WriteLine($"Keyword with resource name = " + $"'{criterionResult.ResourceName}' was updated."); } } 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\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\V2\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V2\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V2\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\Util\FieldMasks; use Google\Ads\GoogleAds\Util\V2\ResourceNames; use Google\Ads\GoogleAds\V2\Enums\AdGroupCriterionStatusEnum\AdGroupCriterionStatus; use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V2\Resources\AdGroupCriterion; use Google\Ads\GoogleAds\V2\Services\AdGroupCriterionOperation; use Google\ApiCore\ApiException; use Google\Protobuf\StringValue; /** * This example updates an ad group criterion (keyword) of an ad group. To get keywords, * run GetKeywords.php. This example can also be used to update other types of ad group * criterion. */ class UpdateKeyword { const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE'; 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) ->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 ); } } 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 customer ID * @param int $adGroupId the ad group ID that the criterion ID belongs to * @param int $criterionId the ID of the ad group criterion to update */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $adGroupId, int $criterionId ) { // Creates an ad group criterion with the proper resource name and any other changes. $adGroupCriterion = new AdGroupCriterion([ 'resource_name' => ResourceNames::forAdGroupCriterion( $customerId, $adGroupId, $criterionId ), 'status' => AdGroupCriterionStatus::ENABLED, 'final_urls' => [new StringValue(['value' => 'https://www.example.com'])] ]); // Constructs an operation that will update the ad group criterion, using the FieldMasks // utility to derive the update mask. This mask tells the Google Ads API which attributes of // the ad group criterion you want to change. $adGroupCriterionOperation = new AdGroupCriterionOperation(); $adGroupCriterionOperation->setUpdate($adGroupCriterion); $adGroupCriterionOperation->setUpdateMask(FieldMasks::allSetFieldsOf($adGroupCriterion)); // Issues a mutate request to update the ad group criterion. $adGroupCriterionServiceClient = $googleAdsClient->getAdGroupCriterionServiceClient(); $response = $adGroupCriterionServiceClient->mutateAdGroupCriteria( $customerId, [$adGroupCriterionOperation] ); // Prints the resource name of the updated ad group criterion. /** @var AdGroupCriterion $updatedAdGroupCriterion */ $updatedAdGroupCriterion = $response->getResults()[0]; printf( "Updated ad group criterion with resource name: '%s'%s", $updatedAdGroupCriterion->getResourceName(), PHP_EOL ); } } UpdateKeyword::main();
#!/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 updates a keyword for the specified ad group.""" import argparse import sys from google.api_core import protobuf_helpers from google.ads.google_ads.client import GoogleAdsClient from google.ads.google_ads.util import ResourceName def main(client, customer_id, ad_group_id, criterion_id): agc_service = client.get_service('AdGroupCriterionService', version='v2') ad_group_criterion_operation = client.get_type('AdGroupCriterionOperation', version='v2') ad_group_criterion = ad_group_criterion_operation.update ad_group_criterion.resource_name = agc_service.ad_group_criteria_path( customer_id, ResourceName.format_composite(ad_group_id, criterion_id)) ad_group_criterion.status = (client.get_type('AdGroupCriterionStatusEnum', version='v2') .ENABLED) final_url = ad_group_criterion.final_urls.add() final_url.value = 'https://www.example.com' fm = protobuf_helpers.field_mask(None, ad_group_criterion) ad_group_criterion_operation.update_mask.CopyFrom(fm) try: agc_response = agc_service.mutate_ad_group_criteria( customer_id, [ad_group_criterion_operation]) 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) print('Updated keyword %s.' % 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. google_ads_client = GoogleAdsClient.load_from_storage() parser = argparse.ArgumentParser( description=('Pauses an ad in the specified customer\'s 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, 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() main(google_ads_client, args.customer_id, args.ad_group_id, args.criterion_id)
#!/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 update a keyword in an ad group require "optparse" require "google/ads/google_ads" def update_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_name = client.path.ad_group_criterion(customer_id, ad_group_id, criteria_id) operation = client.operation.update_resource.ad_group_criterion(resource_name) do |agc| agc.status = :ENABLED # final_urls is an optional repeated field. Since we're starting with a # blank criterion, all existing final_urls will be replaced. # You could alternatively fetch the existing criterion from the server # first, then pass that to the update_resource.ad_group_criterion call # above, in which case this code would rather append a new value to the # repeated field. agc.final_urls << "https://www.example.com" end # Update keyword response = client.service.ad_group_criterion.mutate_ad_group_criteria(customer_id, [operation]) puts "Updated 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_ADWORDS_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', '--criteria_id CRITERIA-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 update_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 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