AI-generated Key Takeaways
-
This code example demonstrates how to update a responsive search ad.
-
The update involves modifying the ad's final URLs, final mobile URLs, headlines, and descriptions.
-
The example utilizes the Google Ads API client libraries for different programming languages to perform the update operation.
-
To update a responsive search ad, you need the customer ID and the ID of the ad you want to modify.
Java
// 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. package com.google.ads.googleads.examples.basicoperations ; import static com.google.ads.googleads.examples.utils.CodeSampleHelper.getShortPrintableDateTime ; 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.lib.utils.FieldMasks ; import com.google.ads.googleads.v22.common.AdTextAsset ; import com.google.ads.googleads.v22.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType ; import com.google.ads.googleads.v22.errors.GoogleAdsError ; import com.google.ads.googleads.v22.errors.GoogleAdsException ; import com.google.ads.googleads.v22.resources.Ad ; import com.google.ads.googleads.v22.services.AdOperation ; import com.google.ads.googleads.v22.services.AdServiceClient ; import com.google.ads.googleads.v22.services.MutateAdResult ; import com.google.ads.googleads.v22.services.MutateAdsResponse ; import com.google.ads.googleads.v22.utils.ResourceNames ; import com.google.common.collect.ImmutableList ; import java.io.FileNotFoundException ; import java.io.IOException ; /** Updates a responsive search ad. To get responsive search ads, run GetResponsiveSearchAds. */ public class UpdateResponsiveSearchAd { private static class UpdateResponsiveSearchAdParams extends CodeSampleParams { @Parameter ( names = ArgumentNames . CUSTOMER_ID , required = true ) private Long customerId ; @Parameter ( names = ArgumentNames . AD_ID , required = true ) private Long adId ; } public static void main ( String [] args ) { UpdateResponsiveSearchAdParams params = new UpdateResponsiveSearchAdParams (); 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 . adId = Long . parseLong ( "INSERT_AD_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 UpdateResponsiveSearchAd (). runExample ( googleAdsClient , params . customerId , params . adId ); } 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 client to use for connecting to the API. * @param customerId the customer ID to update. * @param adId the ad ID to update. */ private void runExample ( GoogleAdsClient googleAdsClient , long customerId , long adId ) { // Creates an AdOperation to update an ad. AdOperation . Builder adOperation = AdOperation . newBuilder (); // Creates an Ad in the update field of the operation. Ad . Builder adBuilder = adOperation . getUpdateBuilder () . setResourceName ( ResourceNames . ad ( customerId , adId )) . addFinalUrls ( "http://www.example.com/" ) . addFinalMobileUrls ( "http://www.example.com/mobile" ); // Sets the responsive search ad properties to update on the ad. adBuilder . getResponsiveSearchAdBuilder () . addAllHeadlines ( ImmutableList . of ( AdTextAsset . newBuilder () . setText ( "Cruise to Pluto #" + getShortPrintableDateTime ()) . setPinnedField ( ServedAssetFieldType . HEADLINE_1 ) . build (), AdTextAsset . newBuilder (). setText ( "Tickets on sale now" ). build (), AdTextAsset . newBuilder (). setText ( "Buy your ticket now" ). build ())) . addAllDescriptions ( ImmutableList . of ( AdTextAsset . newBuilder (). setText ( "Best space cruise ever." ). build (), AdTextAsset . newBuilder () . setText ( "The most wonderful space experience you will ever have." ) . build ())); // Sets the update mask (the fields which will be modified) to be all the fields we set above. adOperation . setUpdateMask ( FieldMasks . allSetFieldsOf ( adBuilder . build ())); // Creates a service client to connect to the API. try ( AdServiceClient adServiceClient = googleAdsClient . getLatestVersion (). createAdServiceClient ()) { // Issues the mutate request. MutateAdsResponse response = adServiceClient . mutateAds ( String . valueOf ( customerId ), ImmutableList . of ( adOperation . build ())); // Displays the result. for ( MutateAdResult result : response . getResultsList ()) { System . out . printf ( "Ad with resource name '%s' was updated.%n" , result . 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.Gax.Util ; using Google.Ads.GoogleAds.Lib ; using Google.Ads.GoogleAds.V22.Common ; using Google.Ads.GoogleAds.V22.Errors ; using Google.Ads.GoogleAds.V22.Resources ; using Google.Ads.GoogleAds.V22.Services ; using System ; using Google.Ads.GoogleAds.V22.Enums ; namespace Google.Ads.GoogleAds.Examples.V22 { /// <summary> /// This code example updates a responsive search ad. To get responsive search ads, /// run GetResponsiveSearchAds.cs. /// </summary> public class UpdateResponsiveSearchAd : ExampleBase { /// <summary> /// Command line options for running the <see cref="UpdateResponsiveSearchAd"/> 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 to update. /// </summary> [Option("adId", Required = true, HelpText = "ID of the ad to update.")] public long AdId { 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 ); UpdateResponsiveSearchAd codeExample = new UpdateResponsiveSearchAd (); Console . WriteLine ( codeExample . Description ); codeExample . Run ( new GoogleAdsClient (), options . CustomerId , options . AdId ); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description = > "This code example updates a responsive search ad. To get responsive search ads, run " + "GetResponsiveSearchAds.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="adId"> ID of the ad to update.</param> public void Run ( GoogleAdsClient client , long customerId , long adId ) { // Get the AdService. AdServiceClient adService = client . GetService ( Services . V22 . AdService ); Ad ad = new Ad () { ResourceName = ResourceNames . Ad ( customerId , adId ), ResponsiveSearchAd = new ResponsiveSearchAdInfo () { // Update some properties of the responsive search ad. Headlines = { new AdTextAsset () { Text = "Cruise to Pluto #" + ExampleUtilities . GetShortRandomString (), PinnedField = ServedAssetFieldTypeEnum . Types . ServedAssetFieldType . Headline1 }, new AdTextAsset () { Text = "Tickets on sale now" }, new AdTextAsset () { Text = "Buy your ticket now" } }, Descriptions = { new AdTextAsset () { Text = "Best space cruise ever." }, new AdTextAsset () { Text = "The most wonderful space experience you will ever have." }, } }, FinalUrls = { "http://www.example.com/" }, FinalMobileUrls = { "http://www.example.com/mobile" } }; AdOperation operation = new AdOperation () { Update = ad , UpdateMask = FieldMasks . AllSetFieldsOf ( ad ) }; try { // Issue the update request. MutateAdsResponse response = adService . MutateAds ( customerId . ToString (), new [] { operation }); // Display the results. foreach ( MutateAdResult updatedAd in response . Results ) { Console . WriteLine ( $"Ad with resource ID = '{updatedAd.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}" ); throw ; } } } }
PHP
< ?php /** * 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 * * 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\Examples\Utils\Helper; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsException; use Google\Ads\GoogleAds\Util\FieldMasks; use Google\Ads\GoogleAds\Util\V22\ResourceNames; use Google\Ads\GoogleAds\V22\Common\AdTextAsset; use Google\Ads\GoogleAds\V22\Common\ResponsiveSearchAdInfo; use Google\Ads\GoogleAds\V22\Enums\ServedAssetFieldTypeEnum\ServedAssetFieldType; use Google\Ads\GoogleAds\V22\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V22\Resources\Ad; use Google\Ads\GoogleAds\V22\Services\AdOperation; use Google\Ads\GoogleAds\V22\Services\MutateAdsRequest; use Google\ApiCore\ApiException; /** * This example updates a responsive search ad. To get responsive search ads, run * GetResponsiveSearchAds.php. */ class UpdateResponsiveSearchAd { private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; private const AD_ID = 'INSERT_AD_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_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_ID] ?: self::AD_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 $adId the ad ID to update */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $adId ) { // Creates an ad with the specified resource name and other changes. $ad = new Ad([ 'resource_name' => ResourceNames::forAd($customerId, $adId), 'responsive_search_ad' => new ResponsiveSearchAdInfo([ // Update some properties of the responsive search ad. 'headlines' => [ new AdTextAsset([ 'text' => 'Cruise to Pluto #' . Helper::getShortPrintableDatetime(), 'pinned_field' => ServedAssetFieldType::HEADLINE_1 ]), new AdTextAsset(['text' => 'Tickets on sale now']), new AdTextAsset(['text' => 'Buy your ticket now']) ], 'descriptions' => [ new AdTextAsset(['text' => 'Best space cruise ever.']), new AdTextAsset([ 'text' => 'The most wonderful space experience you will ever have.']) ] ]), 'final_urls' => ['http://www.example.com'], 'final_mobile_urls' => ['http://www.example.com/mobile'] ]); // Constructs an operation that will update the ad, using the FieldMasks to derive the // update mask. This mask tells the Google Ads API which attributes of the ad you want to // change. $adOperation = new AdOperation(); $adOperation->setUpdate($ad); $adOperation->setUpdateMask(FieldMasks::allSetFieldsOf($ad)); // Issues a mutate request to update the ad. $adServiceClient = $googleAdsClient->getAdServiceClient(); $response = $adServiceClient->mutateAds(MutateAdsRequest::build($customerId, [$adOperation])); // Prints the resource name of the updated ad. /** @var Ad $updatedAd */ $updatedAd = $response->getResults()[0]; printf( "Updated ad with resource name: '%s'.%s", $updatedAd->getResourceName(), PHP_EOL ); } } UpdateResponsiveSearchAd::main();
Python
#!/usr/bin/env python # 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 # # 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 responsive search ad. To get responsive search ads, run get_responsive_search_ads.py. """ import argparse import sys from typing import List from uuid import uuid4 from google.api_core import protobuf_helpers from google.ads.googleads.client import GoogleAdsClient from google.ads.googleads.errors import GoogleAdsException from google.ads.googleads.v22.common.types.ad_asset import AdTextAsset from google.ads.googleads.v22.resources.types.ad import Ad from google.ads.googleads.v22.services.services.ad_service import ( AdServiceClient , ) from google.ads.googleads.v22.services.types.ad_service import ( AdOperation , MutateAdsResponse , ) def main ( client : GoogleAdsClient , customer_id : str , ad_id : str ) - > None : ad_service : AdServiceClient = client . get_service ( "AdService" ) ad_operation : AdOperation = client . get_type ( "AdOperation" ) # Update ad operation. ad : Ad = ad_operation . update ad . resource_name = ad_service . ad_path ( customer_id , ad_id ) # Update some properties of the responsive search ad. headline_1 : AdTextAsset = client . get_type ( "AdTextAsset" ) headline_1 . text = f "Cruise to Pluto # { uuid4 () . hex [: 8 ] } " headline_1 . pinned_field = client . enums . ServedAssetFieldTypeEnum . HEADLINE_1 headline_2 : AdTextAsset = client . get_type ( "AdTextAsset" ) headline_2 . text = "Tickets on sale now" headline_3 : AdTextAsset = client . get_type ( "AdTextAsset" ) headline_3 . text = "Buy your tickets now" ad . responsive_search_ad . headlines . extend ( [ headline_1 , headline_2 , headline_3 ] ) description_1 : AdTextAsset = client . get_type ( "AdTextAsset" ) description_1 . text = "Best space cruise ever." description_2 : AdTextAsset = client . get_type ( "AdTextAsset" ) description_2 . text = ( "The most wonderful space experience you will ever have." ) ad . responsive_search_ad . descriptions . extend ([ description_1 , description_2 ]) ad . final_urls . append ( "https://www.example.com" ) ad . final_mobile_urls . append ( "https://www.example.com/mobile" ) client . copy_from ( ad_operation . update_mask , protobuf_helpers . field_mask ( None , ad . _pb ) ) # Updates the ad. operations : List [ AdOperation ] = [ ad_operation ] ad_response : MutateAdsResponse = ad_service . mutate_ads ( customer_id = customer_id , operations = operations ) print ( f 'Ad with resource name " { ad_response . results [ 0 ] . resource_name } " ' "was updated." ) if __name__ == "__main__" : parser = argparse . ArgumentParser ( description = ( "Updates the specified responsive search ad, for the given " "customer 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 ( "-i" , "--ad_id" , type = str , required = True , help = "The ad ID." ) args : argparse . Namespace = parser . parse_args () # GoogleAdsClient will read the google-ads.yaml configuration file in the # home directory if none is specified. googleads_client : GoogleAdsClient = GoogleAdsClient . load_from_storage ( version = "v22" ) try : main ( googleads_client , args . customer_id , args . ad_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 ' \t Error with message " { error . message } ".' ) if error . location : for field_path_element in error . location . field_path_elements : print ( f " \t\t On field: { field_path_element . field_name } " ) sys . exit ( 1 )
Ruby
#!/usr/bin/env ruby # Encoding: utf-8 # # 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 # # 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 responsive search ad. # To get responsive search ads, run get_responsive_search_ads.rb. require 'optparse' require 'google/ads/google_ads' require 'date' def update_responsive_search_ad ( customer_id , ad_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_resource_name = client . path . ad ( customer_id , ad_id ) # Create the operation for updating the ad. ad_operation = client . operation . update_resource . ad ( ad_resource_name ) do | ad | ad . final_urls << 'http://www.example.com' ad . final_mobile_urls << 'http://www.example.com/mobile' ad . responsive_search_ad = client . resource . responsive_search_ad_info do | rsa | rsa . headlines += [ client . resource . ad_text_asset do | ata | ata . text = "Cruise to Pluto #{ ( Time . new . to_f * 100 ) . to_i } " ata . pinned_field = :HEADLINE_1 end , client . resource . ad_text_asset do | ata | ata . text = "Tickets on sale now" end , client . resource . ad_text_asset do | ata | ata . text = "Buy your ticket now" end , ] rsa . descriptions += [ client . resource . ad_text_asset do | ata | ata . text = "Best space cruise ever" end , client . resource . ad_text_asset do | ata | ata . text = "The most wonderful space experience you will ever have" end , ] end end # Update the ad. response = client . service . ad . mutate_ads ( customer_id : customer_id , operations : [ ad_operation ] , ) puts "Updated responsive search ad #{ response . results . first . resource_name } ." 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_id ] = 'INSERT_AD_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-id AD-ID' , String , 'Ad ID' ) do | v | options [ :ad_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_responsive_search_ad ( options . fetch ( :customer_id ) . tr ( '-' , '' ), options [ :ad_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 ( ' \t On 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 ( ' \t Type: %s \n\t Code: %s \n ' , k , v ) end end raise end end
Perl
#!/usr/bin/perl -w # # Copyright 2022, 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 updates an responsive search ad. To get responsive search ads, run # get_responsive_search_ads.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::Utils::FieldMasks ; use Google::Ads::GoogleAds::V22::Resources::Ad ; use Google::Ads::GoogleAds::V22::Common::AdTextAsset ; use Google::Ads::GoogleAds::V22::Common::ResponsiveSearchAdInfo ; use Google::Ads::GoogleAds::V22::Enums::ServedAssetFieldTypeEnum qw(HEADLINE_1) ; use Google::Ads::GoogleAds::V22::Services::AdService::AdOperation ; use Google::Ads::GoogleAds::V22::Utils::ResourceNames ; use Getopt::Long qw(:config auto_help) ; use Pod::Usage ; use Cwd qw(abs_path) ; use Data::Uniqid qw(uniqid) ; # 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_id = "INSERT_AD_ID_HERE" ; sub update_responsive_search_ad { my ( $api_client , $customer_id , $ad_id ) = @_ ; # Create an ad with the proper resource name and any other changes. my $ad = Google::Ads::GoogleAds::V22::Resources:: Ad - > new ({ resourceName = > Google::Ads::GoogleAds::V22::Utils::ResourceNames:: ad ( $customer_id , $ad_id ), responsiveSearchAd = > Google::Ads::GoogleAds::V22::Common:: ResponsiveSearchAdInfo - > new ({ # Update some properties of the responsive search ad. headlines = > [ Google::Ads::GoogleAds::V22::Common:: AdTextAsset - > new ({ text = > "Cruise to Pluto #" . uniqid (), pinnedField = > HEADLINE_1 } ), Google::Ads::GoogleAds::V22::Common:: AdTextAsset - > new ({ text = > "Tickets on sale now" } ), Google::Ads::GoogleAds::V22::Common:: AdTextAsset - > new ({ text = > "Buy your ticket now" } ), ], descriptions = > [ Google::Ads::GoogleAds::V22::Common:: AdTextAsset - > new ({ text = > "Best space cruise ever." } ), Google::Ads::GoogleAds::V22::Common:: AdTextAsset - > new ({ text = > "The most wonderful space experience you will ever have." } ), ]} ), finalUrls = > [ "http://www.example.com/" ], finalMobileUrls = > [ "http://www.example.com/mobile" ]}); # Create an ad operation for update, using the FieldMasks utility to derive # the update mask. my $ad_operation = Google::Ads::GoogleAds::V22::Services::AdService:: AdOperation - > new ({ update = > $ad , updateMask = > all_set_fields_of ( $ad )}); # Issue a mutate request to update the ad. my $ads_response = $api_client - > AdService () - > mutate ({ customerId = > $customer_id , operations = > [ $ad_operation ]}); printf "Updated ad with resource name: '%s'.\n" , $ads_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_id=i" = > \ $ad_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_id ); # Call the example. update_responsive_search_ad ( $api_client , $customer_id =~ s/-//g r , $ad_id ); =pod =head1 NAME update_responsive_search_ad =head1 DESCRIPTION This example updates an responsive search ad. To get responsive search ads, run get_responsive_search_ads.pl. =head1 SYNOPSIS update_responsive_search_ad.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. -ad_id The ID of the ad to update. =cut
