AI-generated Key Takeaways
-
The code updates a Google Ads campaign by setting its status to PAUSED.
-
The examples show how to construct a campaign object with the resource name and desired changes.
-
A campaign operation is created to specify the update, utilizing a field mask to indicate which attributes are being changed.
-
The mutate request is then sent to apply the updates to the campaign.
-
The resource name of the updated campaign is printed as confirmation.
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.lib.utils.FieldMasks ; import com.google.ads.googleads.v22.enums.CampaignStatusEnum.CampaignStatus ; import com.google.ads.googleads.v22.errors.GoogleAdsError ; import com.google.ads.googleads.v22.errors.GoogleAdsException ; import com.google.ads.googleads.v22.resources.Campaign ; import com.google.ads.googleads.v22.services.CampaignOperation ; import com.google.ads.googleads.v22.services.CampaignServiceClient ; import com.google.ads.googleads.v22.services.MutateCampaignResult ; import com.google.ads.googleads.v22.services.MutateCampaignsResponse ; import com.google.ads.googleads.v22.utils.ResourceNames ; import java.io.FileNotFoundException ; import java.io.IOException ; import java.util.Collections ; /** Updates a campaign by setting the status to PAUSED. To get campaigns, run GetCampaigns.java. */ public class UpdateCampaign { private static class UpdateCampaignParams extends CodeSampleParams { @Parameter ( names = ArgumentNames . CUSTOMER_ID , required = true ) private Long customerId ; @Parameter ( names = ArgumentNames . CAMPAIGN_ID , required = true ) private Long campaignId ; } public static void main ( String [] args ) { UpdateCampaignParams params = new UpdateCampaignParams (); if ( ! params . parseArguments ( args )) { // Either pass the required parameters for this example on the command line, or insert them // into the code here. See the parameter class definition above for descriptions. params . customerId = Long . parseLong ( "INSERT_CUSTOMER_ID_HERE" ); params . campaignId = Long . parseLong ( "INSERT_CAMPAIGN_ID_HERE" ); } GoogleAdsClient googleAdsClient = 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 UpdateCampaign (). runExample ( googleAdsClient , params . customerId , params . campaignId ); } catch ( GoogleAdsException gae ) { // GoogleAdsException is the base class for most exceptions thrown by an API request. // Instances of this exception have a message and a GoogleAdsFailure that contains a // collection of GoogleAdsErrors that indicate the underlying causes of the // GoogleAdsException. System . err . printf ( "Request ID %s failed due to GoogleAdsException. Underlying errors:%n" , gae . getRequestId ()); int i = 0 ; for ( GoogleAdsError googleAdsError : gae . getGoogleAdsFailure (). getErrorsList ()) { System . err . printf ( " Error %d: %s%n" , i ++ , googleAdsError ); } System . exit ( 1 ); } } /** * Runs the example. * * @param googleAdsClient the Google Ads API client. * @param customerId the client customer ID. * @param campaignId the ID of the campaign to update. * @throws GoogleAdsException if an API request failed with one or more service errors. */ private void runExample ( GoogleAdsClient googleAdsClient , Long customerId , Long campaignId ) { try ( CampaignServiceClient campaignServiceClient = googleAdsClient . getLatestVersion (). createCampaignServiceClient ()) { // Creates a Campaign object with the proper resource name and any other changes. Campaign campaign = Campaign . newBuilder () . setResourceName ( ResourceNames . campaign ( customerId , campaignId )) . setStatus ( CampaignStatus . PAUSED ) . build (); // Constructs an operation that will update the campaign, using the FieldMasks utility to // derive the update mask. This mask tells the Google Ads API which attributes of the // campaign you want to change. CampaignOperation operation = CampaignOperation . newBuilder () . setUpdate ( campaign ) . setUpdateMask ( FieldMasks . allSetFieldsOf ( campaign )) . build (); // Sends the operation in a mutate request. MutateCampaignsResponse response = campaignServiceClient . mutateCampaigns ( customerId . toString (), Collections . singletonList ( operation )); // Prints the resource name of each updated object. for ( MutateCampaignResult mutateCampaignResult : response . getResultsList ()) { System . out . printf ( "Updated campaign with resourceName: %s.%n" , mutateCampaignResult . 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.Errors ; using Google.Ads.GoogleAds.V22.Resources ; using Google.Ads.GoogleAds.V22.Services ; using System ; using static Google . Ads . GoogleAds . V22 . Enums . CampaignStatusEnum . Types ; using static Google . Ads . GoogleAds . V22 . Resources . Campaign . Types ; namespace Google.Ads.GoogleAds.Examples.V22 { /// <summary> /// This code example updates a campaign. To get campaigns, run GetCampaigns.cs. /// </summary> public class UpdateCampaign : ExampleBase { /// <summary> /// Command line options for running the <see cref="UpdateCampaign"/> 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 campaign to be updated. /// </summary> [Option("campaignId", Required = true, HelpText = "ID of the campaign to be updated.")] public long CampaignId { 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 ); UpdateCampaign codeExample = new UpdateCampaign (); Console . WriteLine ( codeExample . Description ); codeExample . Run ( new GoogleAdsClient (), options . CustomerId , options . CampaignId ); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description = > "This code example updates a campaign. To get campaigns, run GetCampaign.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="campaignId">ID of the campaign to be updated.</param> public void Run ( GoogleAdsClient client , long customerId , long campaignId ) { // Get the CampaignService. CampaignServiceClient campaignService = client . GetService ( Services . V22 . CampaignService ); // Update campaign by setting its status to paused, and "Search network" to false. Campaign campaignToUpdate = new Campaign () { ResourceName = ResourceNames . Campaign ( customerId , campaignId ), Status = CampaignStatus . Paused , NetworkSettings = new NetworkSettings () { TargetSearchNetwork = false } }; // Create the operation. CampaignOperation operation = new CampaignOperation () { Update = campaignToUpdate , UpdateMask = FieldMasks . AllSetFieldsOf ( campaignToUpdate ) }; try { // Update the campaign. MutateCampaignsResponse response = campaignService . MutateCampaigns ( customerId . ToString (), new [] { operation }); // Display the results. foreach ( MutateCampaignResult updatedCampaign in response . Results ) { Console . WriteLine ( $"Campaign with resource ID = " + $"'{updatedCampaign.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 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\V22\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\Util\FieldMasks; use Google\Ads\GoogleAds\Util\V22\ResourceNames; use Google\Ads\GoogleAds\V22\Enums\CampaignStatusEnum\CampaignStatus; use Google\Ads\GoogleAds\V22\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V22\Resources\Campaign; use Google\Ads\GoogleAds\V22\Services\CampaignOperation; use Google\Ads\GoogleAds\V22\Services\MutateCampaignsRequest; use Google\ApiCore\ApiException; /** * This example updates a campaign by setting the status to `PAUSED`. To get campaigns, run * GetCampaigns.php. */ class UpdateCampaign { private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; private const CAMPAIGN_ID = 'INSERT_CAMPAIGN_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::CAMPAIGN_ID => GetOpt::REQUIRED_ARGUMENT ]); // Generate a refreshable OAuth2 credential for authentication. $oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build(); // Construct a Google Ads client configured from a properties file and the // OAuth2 credentials above. $googleAdsClient = (new GoogleAdsClientBuilder())->fromFile() ->withOAuth2Credential($oAuth2Credential) ->build(); try { self::runExample( $googleAdsClient, $options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID, $options[ArgumentNames::CAMPAIGN_ID] ?: self::CAMPAIGN_ID ); } catch (GoogleAdsException $googleAdsException) { printf( "Request with ID '%s' has failed.%sGoogle Ads failure details:%s", $googleAdsException->getRequestId(), PHP_EOL, PHP_EOL ); foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) { /** @var GoogleAdsError $error */ printf( "\t%s: %s%s", $error->getErrorCode()->getErrorCode(), $error->getMessage(), PHP_EOL ); } 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 $campaignId the ID of campaign to update */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $campaignId ) { // Creates a campaign object with the specified resource name and other changes. $campaign = new Campaign([ 'resource_name' => ResourceNames::forCampaign($customerId, $campaignId), 'status' => CampaignStatus::PAUSED ]); // Constructs an operation that will update the campaign with the specified resource name, // using the FieldMasks utility to derive the update mask. This mask tells the Google Ads // API which attributes of the campaign you want to change. $campaignOperation = new CampaignOperation(); $campaignOperation->setUpdate($campaign); $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign)); // Issues a mutate request to update the campaign. $campaignServiceClient = $googleAdsClient->getCampaignServiceClient(); $response = $campaignServiceClient->mutateCampaigns(MutateCampaignsRequest::build( $customerId, [$campaignOperation] )); // Prints the resource name of the updated campaign. /** @var Campaign $updatedCampaign */ $updatedCampaign = $response->getResults()[0]; printf( "Updated campaign with resource name: '%s'%s", $updatedCampaign->getResourceName(), PHP_EOL ); } } UpdateCampaign::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 updates a campaign. To get campaigns, run get_campaigns.py. """ import argparse import sys from typing import List 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.resources.types.campaign import Campaign from google.ads.googleads.v22.services.services.campaign_service import ( CampaignServiceClient , ) from google.ads.googleads.v22.services.types.campaign_service import ( CampaignOperation , MutateCampaignsResponse , ) def main ( client : GoogleAdsClient , customer_id : str , campaign_id : str ) - > None : campaign_service : CampaignServiceClient = client . get_service ( "CampaignService" ) # Create campaign operation. campaign_operation : CampaignOperation = client . get_type ( "CampaignOperation" ) campaign : Campaign = campaign_operation . update campaign . resource_name = campaign_service . campaign_path ( customer_id , campaign_id ) campaign . status = client . enums . CampaignStatusEnum . PAUSED campaign . network_settings . target_search_network = False # Retrieve a FieldMask for the fields configured in the campaign. client . copy_from ( campaign_operation . update_mask , protobuf_helpers . field_mask ( None , campaign . _pb ), ) operations : List [ CampaignOperation ] = [ campaign_operation ] campaign_response : MutateCampaignsResponse = ( campaign_service . mutate_campaigns ( customer_id = customer_id , operations = operations , ) ) print ( f "Updated campaign { campaign_response . results [ 0 ] . resource_name } ." ) if __name__ == "__main__" : parser = argparse . ArgumentParser ( description = "Updates the 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 ( "-i" , "--campaign_id" , type = str , required = True , help = "The campaign 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 . campaign_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 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 campaign. To get campaigns, run get_campaigns.rb. require 'optparse' require 'google/ads/google_ads' def update_campaign ( customer_id , campaign_id ) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google :: Ads :: GoogleAds :: GoogleAdsClient . new resource_name = client . path . campaign ( customer_id , campaign_id ) operation = client . operation . update_resource . campaign ( resource_name ) do | c | c . status = :PAUSED end # The field mask util will misinterpret the change to target_search_network, # since it is a primitive type and we are setting it to the default value. # Because of this, we must add it manually to the field mask. # See # https://developers.google.com/google-ads/api/docs/client-libs/ruby/field-masks#clearing_fields # for more details. operation . update . network_settings = client . resource . network_settings do | ns | ns . target_search_network = false end operation . update_mask . paths << 'network_settings.target_search_network' response = client . service . campaign . mutate_campaigns ( customer_id : customer_id , operations : [ operation ] , ) puts "Campaign with resource name = ' #{ response . results . first . resource_name } ' was updated." 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 [ :campaign_id ] = 'INSERT_CAMPAIGN_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 ( '-c' , '--campaign-id CAMPAIGN-ID' , String , 'Campaign ID' ) do | v | options [ :campaign_id ] = v end opts . separator '' opts . separator 'Help:' opts . on_tail ( '-h' , '--help' , 'Show this message' ) do puts opts exit end end . parse! begin update_campaign ( options . fetch ( :customer_id ) . tr ( "-" , "" ), options [ :campaign_id ] ) rescue Google :: Ads :: GoogleAds :: Errors :: GoogleAdsError = > e e . failure . errors . each do | error | STDERR . printf ( "Error with message: %s \n " , error . message ) if error . location error . location . field_path_elements . each do | field_path_element | STDERR . printf ( " \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 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 updates the status and network settings for a given campaign. To # get campaigns, run get_campaigns.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::Campaign ; use Google::Ads::GoogleAds::V22::Resources::NetworkSettings ; use Google::Ads::GoogleAds::V22::Enums::CampaignStatusEnum qw(PAUSED) ; use Google::Ads::GoogleAds::V22::Services::CampaignService::CampaignOperation ; use Google::Ads::GoogleAds::V22::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 $campaign_id = "INSERT_CAMPAIGN_ID_HERE" ; sub update_campaign { my ( $api_client , $customer_id , $campaign_id ) = @_ ; # Create a campaign with the proper resource name and any other changes. my $campaign = Google::Ads::GoogleAds::V22::Resources:: Campaign - > new ({ resourceName = > Google::Ads::GoogleAds::V22::Utils::ResourceNames:: campaign ( $customer_id , $campaign_id ), status = > PAUSED , networkSettings = > Google::Ads::GoogleAds::V22::Resources:: NetworkSettings - > new ({ targetSearchNetwork = > "false" })}); # Create a campaign operation for update, using the FieldMasks utility to # derive the update mask. my $campaign_operation = Google::Ads::GoogleAds::V22::Services::CampaignService:: CampaignOperation - > new ({ update = > $campaign , updateMask = > all_set_fields_of ( $campaign )}); # Update the campaign. my $campaigns_response = $api_client - > CampaignService () - > mutate ({ customerId = > $customer_id , operations = > [ $campaign_operation ]}); printf "Updated campaign with resource name: '%s'.\n" , $campaigns_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 , "campaign_id=i" = > \ $campaign_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 , $campaign_id ); # Call the example. update_campaign ( $api_client , $customer_id =~ s/-//g r , $campaign_id ); =pod =head1 NAME update_campaign =head1 DESCRIPTION This example updates the status and network settings for a given campaign. To get campaigns, run get_campaigns.pl. =head1 SYNOPSIS update_campaign.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. -campaign_id The campaign ID. =cut
