Java
// Copyright 2019 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package com.google.ads.googleads.examples.campaignmanagement; 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.v17.errors.GoogleAdsError; import com.google.ads.googleads.v17.errors.GoogleAdsException; import com.google.ads.googleads.v17.resources.AdParameter; import com.google.ads.googleads.v17.services.AdParameterOperation; import com.google.ads.googleads.v17.services.AdParameterServiceClient; import com.google.ads.googleads.v17.services.MutateAdParameterResult; import com.google.ads.googleads.v17.services.MutateAdParametersResponse; import com.google.ads.googleads.v17.utils.ResourceNames; import java.io.FileNotFoundException; import java.io.IOException; import java.util.ArrayList; import java.util.List; /** Sets ad parameters for an ad group criterion. To get ad group criteria, run GetKeywords.java */ public class SetAdParameters { private static class SetAdParameterParams 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) throws IOException { SetAdParameters.SetAdParameterParams params = new SetAdParameters.SetAdParameterParams(); 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 = 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 SetAdParameters() .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 ad group ID. * @param criterionId criterion ID. * @throws GoogleAdsException if an API request failed with one or more service errors. */ private void runExample( GoogleAdsClient googleAdsClient, long customerId, long adGroupId, long criterionId) { String adGroupCriterionResourceName = ResourceNames.adGroupCriterion(customerId, adGroupId, criterionId); // Creates ad parameters. // There can be a maximum of two AdParameters per ad group criterion. // (One with parameter_index = 1 and one with parameter_index = 2.) AdParameter adParameter1 = AdParameter.newBuilder() .setAdGroupCriterion(adGroupCriterionResourceName) // The unique index of this ad parameter. Must be either 1 or 2. .setParameterIndex(1) // String containing a numeric value to insert into the ad text. // The following restrictions apply: (a) can use comma or period as a separator, // with an optional period or comma (respectively) for fractional values, // (b) can be prepended or appended with a currency code, (c) can use plus or minus, // (d) can use '/' between two numbers. .setInsertionText("100") .build(); AdParameter adParameter2 = AdParameter.newBuilder() .setAdGroupCriterion(adGroupCriterionResourceName) .setParameterIndex(2) .setInsertionText("$40") .build(); List<AdParameterOperation> operations = new ArrayList<>(); operations.add(AdParameterOperation.newBuilder().setCreate(adParameter1).build()); operations.add(AdParameterOperation.newBuilder().setCreate(adParameter2).build()); try (AdParameterServiceClient adParameterServiceClient = googleAdsClient.getLatestVersion().createAdParameterServiceClient()) { MutateAdParametersResponse response = adParameterServiceClient.mutateAdParameters(Long.toString(customerId), operations); System.out.printf("Set %d ad params:%n", response.getResultsCount()); for (MutateAdParameterResult result : response.getResultsList()) { System.out.println(result.getResourceName()); } } } }
C#
// Copyright 2020 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.V17.Errors; using Google.Ads.GoogleAds.V17.Resources; using Google.Ads.GoogleAds.V17.Services; using System; using System.Collections.Generic; namespace Google.Ads.GoogleAds.Examples.V17 { /// <summary> /// This code example sets ad parameters for a keyword. To get ad group criteria, /// run GetKeywords.cs. /// </summary> public class SetAdParameters : ExampleBase { /// <summary> /// Command line options for running the <see cref="SetAdParameters"/> 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> /// ID of the ad group that contains the keywrd. /// </summary> [Option("adGroupId", Required = true, HelpText = "ID of the ad group that contains the keywrd.")] public long AdGroupId { get; set; } /// <summary> /// ID of the keyword to which ad parameters are attached. /// </summary> [Option("criterionId", Required = true, HelpText = "ID of the keyword to which ad parameters are attached.")] 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); SetAdParameters codeExample = new SetAdParameters(); 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 sets ad parameters for a keyword. To get ad group criteria, run " + "GetKeywords.cs."; /// <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="adGroupId">ID of the ad group that contains the keywrd. /// </param> /// <param name="criterionId">ID of the keyword to which ad parameters are attached.</param> public void Run(GoogleAdsClient client, long customerId, long adGroupId, long criterionId) { // Get the AdParameterServiceClient. AdParameterServiceClient adParameterService = client.GetService(Services.V17.AdParameterService); // Creates ad parameters. // There can be a maximum of two AdParameters per ad group criterion. // (One with parameter_index = 1 and one with parameter_index = 2.) AdParameter adParameter1 = new AdParameter() { AdGroupCriterion = ResourceNames.AdGroupCriterion( customerId, adGroupId, criterionId), // The unique index of this ad parameter. Must be either 1 or 2. ParameterIndex = 1, // String containing a numeric value to insert into the ad text. // The following restrictions apply: (a) can use comma or period as a separator, // with an optional period or comma (respectively) for fractional values, // (b) can be prepended or appended with a currency code, (c) can use plus or minus, // (d) can use '/' between two numbers. InsertionText = "100" }; AdParameter adParameter2 = new AdParameter() { AdGroupCriterion = ResourceNames.AdGroupCriterion( customerId, adGroupId, criterionId), ParameterIndex = 2, InsertionText = "$40" }; AdParameterOperation[] operations = new AdParameterOperation[] { new AdParameterOperation() { Create = adParameter1 }, new AdParameterOperation() { Create = adParameter2 }, }; try { MutateAdParametersResponse response = adParameterService.MutateAdParameters(customerId.ToString(), operations); Console.WriteLine($"Set {response.Results.Count} ad params:"); foreach (MutateAdParameterResult result in response.Results) { Console.WriteLine(result.ResourceName); } } 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 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ namespace Google\Ads\GoogleAds\Examples\CampaignManagement; 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\V17\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V17\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V17\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\Util\V17\ResourceNames; use Google\Ads\GoogleAds\V17\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V17\Resources\AdParameter; use Google\Ads\GoogleAds\V17\Services\AdParameterOperation; use Google\Ads\GoogleAds\V17\Services\MutateAdParametersRequest; use Google\ApiCore\ApiException; /** This example sets ad parameters for an ad group criterion. */ class SetAdParameters { 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 * @param int $criterionId the criterion ID */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $adGroupId, int $criterionId ) { // Gets the resource name of the ad group criterion to be used. $adGroupCriterionResourceName = ResourceNames::forAdGroupCriterion($customerId, $adGroupId, $criterionId); // Creates ad parameters. // There can be a maximum of two ad parameters per ad group criterion. // (One with parameter_index = 1 and one with parameter_index = 2.) $adParameter1 = new AdParameter([ 'ad_group_criterion' => $adGroupCriterionResourceName, 'parameter_index' => 1, // Restrictions apply to the value of the insertion text. // For more information, see the field documentation in the AdParameter class. 'insertion_text' => '100' ]); $adParameter2 = new AdParameter([ 'ad_group_criterion' => $adGroupCriterionResourceName, 'parameter_index' => 2, 'insertion_text' => '$40' ]); // Creates ad parameter operations. $adParameterOperation1 = new AdParameterOperation(); $adParameterOperation1->setCreate($adParameter1); $adParameterOperation2 = new AdParameterOperation(); $adParameterOperation2->setCreate($adParameter2); // Issues a mutate request to set the ad parameters. $adParameterServiceClient = $googleAdsClient->getAdParameterServiceClient(); $response = $adParameterServiceClient->mutateAdParameters(MutateAdParametersRequest::build( $customerId, [$adParameterOperation1, $adParameterOperation2] )); printf("Set %d ad parameters:%s", $response->getResults()->count(), PHP_EOL); foreach ($response->getResults() as $setParameter) { /** @var AdParameter $setParameter */ printf( "Set ad parameter with resource name: '%s'.%s", $setParameter->getResourceName(), PHP_EOL ); } } } SetAdParameters::main();
Python
#!/usr/bin/env python # Copyright 2019 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """This example sets ad parameters for an ad group criterion.""" 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): """Demonstrates how to set ad parameters on an ad group criterion. Args: client: An initialized GoogleAdsClient instance. customer_id: A client customer ID str. ad_group_id: An ad group ID str. criterion_id: A criterion ID str. """ ad_group_criterion_service = client.get_service("AdGroupCriterionService") # Gets the resource name of the ad group criterion to be used. resource_name = ad_group_criterion_service.ad_group_criterion_path( customer_id, ad_group_id, criterion_id ) operations = [ create_ad_parameter(client, resource_name, 1, "100"), create_ad_parameter(client, resource_name, 2, "$40"), ] ad_parameter_service = client.get_service("AdParameterService") # Add the ad parameter. try: response = ad_parameter_service.mutate_ad_parameters( customer_id=customer_id, operations=operations ) 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) else: print(f"Set {len(response.results)} ad parameters:") for result in response.results: print( "Set ad parameter with resource_name: " f"{result.resource_name}" ) def create_ad_parameter(client, resource_name, parameter_index, insertion_text): """Creates a new ad parameter create operation and returns it. There can be a maximum of two ad parameters per ad group criterion, one with "parameter_index" = 1 and another with "parameter_index" = 2. Restrictions apply to the value of the "insertion_text". For more information, see the field documentation in the AdParameter class located here: https://developers.google.com/google-ads/api/fields/latest/ad_parameter#ad_parameterinsertion_text Args: client: An initialized GoogleAdsClient instance. resource_name: The resource name of the ad group criterion. parameter_index: The unique index int of this ad parameter.. insertion_text: A numeric str value to insert into the ad text. Returns: A new AdParameterOperation message class instance. """ ad_param_operation = client.get_type("AdParameterOperation") ad_param = ad_param_operation.create ad_param.ad_group_criterion = resource_name ad_param.parameter_index = parameter_index ad_param.insertion_text = insertion_text return ad_param_operation if __name__ == "__main__": # Initializes a command line argument parser. parser = argparse.ArgumentParser( description="Adds an ad group for specified customer and campaign id." ) # 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.", ) args = parser.parse_args() # GoogleAdsClient will read the google-ads.yaml configuration file in the # home directory if none is specified. googleads_client = GoogleAdsClient.load_from_storage(version="v17") main( googleads_client, args.customer_id, args.ad_group_id, args.criterion_id )
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 exapmle sets ad parameters for an ad group criterion. # To get ad group criteria, run get_keywords.rb require 'optparse' require 'google/ads/google_ads' def add_ad_parameters(customer_id, ad_group_id, criterion_id) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new ad_group_criterion_resource_name = client.path.ad_group_criterion( customer_id, ad_group_id, criterion_id, ) op_1 = client.operation.create_resource.ad_parameter do |parameter| parameter.ad_group_criterion = ad_group_criterion_resource_name parameter.parameter_index = 1 # String containing a numeric value to insert into the ad text. # The following restrictions apply: (a) can use comma or period as a separator, # with an optional period or comma (respectively) for fractional values, # (b) can be prepended or appended with a currency code, (c) can use plus or minus, # (d) can use '/' between two numbers. parameter.insertion_text = "100" end op_2 = client.operation.create_resource.ad_parameter do |parameter| parameter.ad_group_criterion = ad_group_criterion_resource_name parameter.parameter_index = 2 parameter.insertion_text = "$40" end operations = [op_1, op_2] ad_parameter_service = client.service.ad_parameter response = ad_parameter_service.mutate_ad_parameters( customer_id: customer_id, operations: operations, ) response.results.each do |result| puts("Created ad parameter with id #{result.resource_name}") end end if __FILE__ == $0 options = {} # The following parameter(s) should be provided to run the example. You can # either specify these by changing the INSERT_XXX_ID_HERE values below, or on # the command line. # # Parameters passed on the command line will override any parameters set in # code. # # Running the example with -h will print the command line usage. options[:customer_id] = 'INSERT_CUSTOMER_ID_HERE' options[:ad_group_id] = 'INSERT_AD_GROUP_ID_HERE' options[:criterion_id] = 'INSERT_CRITERION_ID_HERE' 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, 'AdGroup ID') do |v| options[:ad_group_id] = v end opts.on('-r', '--criterion-id CRITERION-ID', String, 'Criterion ID') do |v| options[:criterion_id] = v end opts.separator '' opts.separator 'Help:' opts.on_tail('-h', '--help', 'Show this message') do puts opts exit end end.parse! begin add_ad_parameters( options.fetch(:customer_id).tr("-", ""), options.fetch(:ad_group_id), options.fetch(:criterion_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 sets ad parameters for an ad group criterion. 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::V17::Resources::AdParameter; use Google::Ads::GoogleAds::V17::Services::AdParameterService::AdParameterOperation; use Google::Ads::GoogleAds::V17::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 set_ad_parameters { my ($api_client, $customer_id, $ad_group_id, $criterion_id) = @_; my $ad_group_criterion_resource_name = Google::Ads::GoogleAds::V17::Utils::ResourceNames::ad_group_criterion( $customer_id, $ad_group_id, $criterion_id); # Create ad parameters. # There can be a maximum of two ad parameters per ad group criterion. # (One with parameter_index = 1 and one with parameter_index = 2.) my $ad_parameter_1 = Google::Ads::GoogleAds::V17::Resources::AdParameter->new( { adGroupCriterion => $ad_group_criterion_resource_name, # The unique index of this ad parameter. Must be either 1 or 2. parameterIndex => 1, # String containing a numeric value to insert into the ad text. # The following restrictions apply: (a) can use comma or period as a separator, # with an optional period or comma (respectively) for fractional values, # (b) can be prepended or appended with a currency code, (c) can use plus or minus, # (d) can use '/' between two numbers. insertionText => "100" }); my $ad_parameter_2 = Google::Ads::GoogleAds::V17::Resources::AdParameter->new( { adGroupCriterion => $ad_group_criterion_resource_name, parameterIndex => 2, insertionText => "\$40" }); # Create ad parameter operations. my $ad_parameter_operation1 = Google::Ads::GoogleAds::V17::Services::AdParameterService::AdParameterOperation ->new({create => $ad_parameter_1}); my $ad_parameter_operation2 = Google::Ads::GoogleAds::V17::Services::AdParameterService::AdParameterOperation ->new({create => $ad_parameter_2}); # Set the ad parameters. my $ad_parameters_response = $api_client->AdParameterService()->mutate({ customerId => $customer_id, operations => [$ad_parameter_operation1, $ad_parameter_operation2]}); my $ad_parameter_results = $ad_parameters_response->{results}; printf "Set %d ad parameters:\n", scalar @$ad_parameter_results; foreach my $ad_parameter_result (@$ad_parameter_results) { printf "Set ad parameter '%s'.\n", $ad_parameter_result->{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. set_ad_parameters($api_client, $customer_id =~ s/-//gr, $ad_group_id, $criterion_id); =pod =head1 NAME set_ad_parameters =head1 DESCRIPTION This example sets ad parameters for an ad group criterion. =head1 SYNOPSIS set_ad_parameters.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. =cut