#!/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
#
#
# 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 changes the status of a given ad to PAUSED.
use strict;
use utf8;
use FindBin qw($Bin);
use lib "$Bin/../../lib";
use Getopt::Long qw(:config auto_help);
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 $ad_id = "INSERT_AD_ID_HERE";
sub pause_ad {
my ($api_client, $customer_id, $ad_group_id, $ad_id) = @_;
# Create an ad group ad with its status set to PAUSED.
my $ad_group_ad = Google::Ads::GoogleAds::V13::Resources::AdGroupAd->new({
resourceName =>
Google::Ads::GoogleAds::V13::Utils::ResourceNames::ad_group_ad(
$customer_id, $ad_group_id, $ad_id
),
status => PAUSED
});
# Create an ad group ad operation for update, using the FieldMasks utility
# to derive the update mask.
my $ad_group_ad_operation =
Google::Ads::GoogleAds::V13::Services::AdGroupAdService::AdGroupAdOperation
->new({
update => $ad_group_ad,
updateMask => all_set_fields_of($ad_group_ad)});
# Update the ad group ad.
my $ad_group_ads_response = $api_client->AdGroupAdService()->mutate({
customerId => $customer_id,
operations => [$ad_group_ad_operation]});
printf "Ad with resource name '%s' is paused.\n",
$ad_group_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_group_id=i" => \$ad_group_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_group_id, $ad_id);
# Call the example.
pause_ad($api_client, $customer_id =~ s/-//gr, $ad_group_id, $ad_id);
=pod
=head1 NAME
pause_ad
=head1 DESCRIPTION
This example changes the status of a given ad to PAUSED.
=head1 SYNOPSIS
pause_ad.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-ad_group_id The ad group ID.
-ad_id The ad ID.
=cut