Ява
// 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.
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.lib.utils.FieldMasks;
import com.google.ads.googleads.v17.common.DeviceInfo;
import com.google.ads.googleads.v17.enums.DeviceEnum.Device;
import com.google.ads.googleads.v17.errors.GoogleAdsError;
import com.google.ads.googleads.v17.errors.GoogleAdsException;
import com.google.ads.googleads.v17.resources.CampaignCriterion;
import com.google.ads.googleads.v17.services.CampaignCriterionOperation;
import com.google.ads.googleads.v17.services.CampaignCriterionServiceClient;
import com.google.ads.googleads.v17.services.MutateCampaignCriteriaResponse;
import com.google.ads.googleads.v17.services.MutateCampaignCriterionResult;
import com.google.ads.googleads.v17.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;
/** Updates a campaign criterion with a new bid modifier. */
public class UpdateCampaignCriterionBidModifier {
private static class UpdateCampaignCriterionBidModifierParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.CAMPAIGN_ID, required = true)
private Long campaignId;
@Parameter(names = ArgumentNames.CRITERION_ID, required = true)
private Long criterionId;
/** Specify the bid modifier value here or the default specified below will be used. */
@Parameter(names = ArgumentNames.BID_MODIFIER_VALUE)
private Float bidModifier = 1.5f;
}
public static void main(String[] args) throws IOException {
UpdateCampaignCriterionBidModifierParams params =
new UpdateCampaignCriterionBidModifierParams();
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");
params.criterionId = Long.parseLong("INSERT_CRITERION_ID_HERE");
// Optional: To use a different bid modifier value from the default (1.5f), uncomment
// the line below and insert the desired bid modifier value.
// params.bidModifier = Float.parseFloat("INSERT_BID_MODIFIER_VALUE_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 UpdateCampaignCriterionBidModifier()
.runExample(
googleAdsClient,
params.customerId,
params.campaignId,
params.criterionId,
params.bidModifier);
} 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 campaign ID.
* @param criterionId the ID of the criterion to be updated.
* @param bidModifier the bid modifier for the campaign criterion.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(
GoogleAdsClient googleAdsClient,
long customerId,
long campaignId,
long criterionId,
float bidModifier) {
// Creates the criterion resource name.
String criterionResourceName =
ResourceNames.campaignCriterion(customerId, campaignId, criterionId);
// Creates the CampaignCriterion.
CampaignCriterion campaignCriterion =
CampaignCriterion.newBuilder()
.setResourceName(criterionResourceName)
.setBidModifier(bidModifier)
.setDevice(DeviceInfo.newBuilder().setType(Device.MOBILE).build())
.build();
// Creates the operation.
CampaignCriterionOperation operation =
CampaignCriterionOperation.newBuilder()
.setUpdate(campaignCriterion)
.setUpdateMask(FieldMasks.allSetFieldsOf(campaignCriterion))
.build();
// Creates the CampaignCriterionServiceClient.
try (CampaignCriterionServiceClient campaignCriterionServiceClient =
googleAdsClient.getLatestVersion().createCampaignCriterionServiceClient()) {
// Adds the CampaignCriterion.
MutateCampaignCriteriaResponse response =
campaignCriterionServiceClient.mutateCampaignCriteria(
Long.toString(customerId), ImmutableList.of(operation));
for (MutateCampaignCriterionResult result : response.getResultsList()) {
System.out.printf(
"Campaign criterion with resource name '%s' was modified.%n", result.getResourceName());
}
}
}
}
С#
// 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.Gax.Util;
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 updates a campaign criterion with a new bid modifier.
/// </summary>
public class UpdateCampaignCriterionBidModifier : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="UpdateCampaignCriterionBidModifier"/>
/// 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 that contains the criterion.
/// </summary>
[Option("campaignId", Required = true, HelpText =
"ID of the campaign that contains the criterion.")]
public long CampaignId { get; set; }
/// <summary>
/// ID of the criterion for which bid modifier is updated.
/// </summary>
[Option("criterionId", Required = true, HelpText =
"ID of the criterion for which bid modifier is updated.")]
public long CriterionId { get; set; }
/// <summary>
/// The new value of the bid modifier to update.
/// </summary>
[Option("bidModifierValue", Required = false, HelpText =
"The new value of the bid modifier to update.")]
public float? BidModifierValue { 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);
UpdateCampaignCriterionBidModifier codeExample = new UpdateCampaignCriterionBidModifier();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.CampaignId,
options.CriterionId, options.BidModifierValue);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example updates a campaign criterion with a new bid modifier.";
/// <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 that contains the criterion.</param>
/// <param name="criterionId">ID of the criterion for which bid modifier is updated.</param>
/// <param name="bidModifierValue">The new value of the bid modifier to update.</param>
public void Run(GoogleAdsClient client, long customerId, long campaignId, long criterionId,
float? bidModifierValue)
{
// Get the CampaignCriterionServiceClient .
CampaignCriterionServiceClient campaignCriterionService =
client.GetService(Services.V17.CampaignCriterionService);
string criterionResourceName = ResourceNames.CampaignCriteria(customerId,
campaignId, criterionId);
// Construct a campaign bid modifier.
CampaignCriterion campaignCriterion = new CampaignCriterion()
{
ResourceName = criterionResourceName,
BidModifier = (bidModifierValue != null) ? bidModifierValue.Value : 1.5f,
};
// Construct an operation to create the campaign criterion.
CampaignCriterionOperation op = new CampaignCriterionOperation()
{
Update = campaignCriterion,
UpdateMask = FieldMasks.AllSetFieldsOf(campaignCriterion)
};
// Send the operation in a mutate request.
try
{
MutateCampaignCriteriaResponse response =
campaignCriterionService.MutateCampaignCriteria(customerId.ToString(),
new CampaignCriterionOperation[] { op });
foreach (MutateCampaignCriterionResult result in response.Results)
{
Console.WriteLine($"Campaign criterion with resource name" +
$" '{result.ResourceName}' was modified.");
}
}
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\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\OAuth2TokenBuilder;
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\Util\FieldMasks;
use Google\Ads\GoogleAds\Util\V17\ResourceNames;
use Google\Ads\GoogleAds\V17\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V17\Resources\CampaignCriterion;
use Google\Ads\GoogleAds\V17\Services\CampaignCriterionOperation;
use Google\Ads\GoogleAds\V17\Services\MutateCampaignCriteriaRequest;
use Google\ApiCore\ApiException;
/**
* This example updates a campaign criterion with a new bid modifier value.
*/
class UpdateCampaignCriterionBidModifier
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
private const CRITERION_ID = 'INSERT_CRITERION_ID_HERE';
// Specify the bid modifier value here or the default specified below will be used.
private const BID_MODIFIER_VALUE = 1.5;
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,
ArgumentNames::CRITERION_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::BID_MODIFIER_VALUE => GetOpt::OPTIONAL_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,
$options[ArgumentNames::CRITERION_ID] ?: self::CRITERION_ID,
$options[ArgumentNames::BID_MODIFIER_VALUE] ?: self::BID_MODIFIER_VALUE
);
} 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 the campaign for which the bid modifier will be updated
* @param int $criterionId the ID of the criterion to update
* @param float $bidModifierValue the bid modifier value to set
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $campaignId,
int $criterionId,
float $bidModifierValue
) {
// Creates a campaign criterion with the specified resource name and updated bid modifier
// value.
$campaignCriterion = new CampaignCriterion([
'resource_name' => ResourceNames::forCampaignCriterion(
$customerId,
$campaignId,
$criterionId
),
'bid_modifier' => $bidModifierValue
]);
// Creates the campaign criterion operation.
$campaignCriterionOperation = new CampaignCriterionOperation();
$campaignCriterionOperation->setUpdate($campaignCriterion);
$campaignCriterionOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaignCriterion));
// Issues a mutate request to update the bid modifier of campaign criterion.
$campaignCriterionServiceClient = $googleAdsClient->getCampaignCriterionServiceClient();
$response = $campaignCriterionServiceClient->mutateCampaignCriteria(
MutateCampaignCriteriaRequest::build($customerId, [$campaignCriterionOperation])
);
// Prints the resource name of the updated campaign criterion.
/** @var CampaignCriterion $updatedCampaignCriterion */
$updatedCampaignCriterion = $response->getResults()[0];
printf(
"Campaign criterion with resource name '%s' was modified.%s",
$updatedCampaignCriterion->getResourceName(),
PHP_EOL
);
}
}
UpdateCampaignCriterionBidModifier::main();
Питон
#!/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.
"""Updates a campaign criterion with a new bid modifier."""
import argparse
import sys
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
from google.api_core import protobuf_helpers
def main(client, customer_id, campaign_id, criterion_id, bid_modifier_value):
campaign_criterion_service = client.get_service("CampaignCriterionService")
criterion_rname = campaign_criterion_service.campaign_criterion_path(
customer_id, campaign_id, criterion_id
)
campaign_criterion_operation = client.get_type("CampaignCriterionOperation")
campaign_criterion = campaign_criterion_operation.update
campaign_criterion.resource_name = criterion_rname
campaign_criterion.bid_modifier = bid_modifier_value
client.copy_from(
campaign_criterion_operation.update_mask,
protobuf_helpers.field_mask(None, campaign_criterion._pb),
)
campaign_criterion_response = (
campaign_criterion_service.mutate_campaign_criteria(
customer_id=customer_id,
operations=[campaign_criterion_operation],
)
)
print(
"Campaign criterion with resource name "
f'"{campaign_criterion_response.results[0].resource_name}" was '
"modified."
)
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description=(
"Updates the bid modifier and device type for the given "
"customer ID and campaign criterion 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", "--campaign_id", type=str, required=True, help="The campaign ID."
)
parser.add_argument(
"-k",
"--criterion_id",
type=str,
required=True,
help="The criterion ID.",
)
parser.add_argument(
"-b",
"--bid_modifier_value",
type=float,
default=1.5,
help="The desired campaign criterion bid modifier.",
)
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")
try:
main(
googleads_client,
args.customer_id,
args.campaign_id,
args.criterion_id,
args.bid_modifier_value,
)
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)
Руби
#!/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 demonstrates how to update a campaign criterion with a new bid
# modifier.
require 'optparse'
require 'google/ads/google_ads'
def update_campaign_criterion_bid_modifier(
customer_id,
campaign_id,
criterion_id,
bid_modifier
)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Create the resource name.
resource_name = client.path.campaign_criterion(
customer_id,
campaign_id,
criterion_id
)
operation = client.operation.update_resource.campaign_criterion(resource_name) do |campaign_criterion|
# Sets the Bid Modifier.
campaign_criterion.bid_modifier = bid_modifier
end
# Create campaign criterion Service
criteria_service = client.service.campaign_criterion
# Update the Campaign Bid Modifier
response = criteria_service.mutate_campaign_criteria(
customer_id: customer_id,
operations: [operation]
)
puts "Updated #{response.results.size} campaign criterion bid modifiers:"
response.results.each do |criteria_service|
puts "\t#{criteria_service.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[:campaign_id] = 'INSERT_CAMPAIGN_ID_HERE'
options[:criterion_id] = 'INSERT_CRITERION_ID_HERE'
options[:bid_modifier] = 'INSERT_BID_MODIFIER_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.on('-r', '--criterion-id CRITERION-ID', String, 'Criterion ID') do |v|
options[:criterion_id] = v
end
opts.on('-B', '--bid-modifier-value BID-MODIFIER-VALUE', String,
'Bid Modifier') do |v|
options[:bid_modifier] = v.to_f
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
update_campaign_criterion_bid_modifier(
options.fetch(:customer_id).tr("-", ""),
options[:campaign_id],
options[:criterion_id],
options[:bid_modifier]
)
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
Перл
#!/usr/bin/perl -w
#
# 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.
#
# This example updates a campaign criterion with a new bid modifier value.
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::V17::Resources::CampaignCriterion;
use
Google::Ads::GoogleAds::V17::Services::CampaignCriterionService::CampaignCriterionOperation;
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 $campaign_id = "INSERT_CAMPAIGN_ID_HERE";
my $criterion_id = "INSERT_CRITERION_ID_HERE";
# Specify the bid modifier value here or the default specified below will be used.
my $bid_modifier_value = 1.5;
sub update_campaign_criterion_bid_modifier {
my ($api_client, $customer_id, $campaign_id, $criterion_id,
$bid_modifier_value)
= @_;
# Create a campaign criterion with the specified resource name and updated bid
# modifier value.
my $campaign_criterion =
Google::Ads::GoogleAds::V17::Resources::CampaignCriterion->new({
resourceName =>
Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign_criterion(
$customer_id, $campaign_id, $criterion_id
),
bidModifier => $bid_modifier_value
});
# Create the campaign criterion operation.
my $campaign_criterion_operation =
Google::Ads::GoogleAds::V17::Services::CampaignCriterionService::CampaignCriterionOperation
->new({
update => $campaign_criterion,
updateMask => all_set_fields_of($campaign_criterion)});
# Issue a mutate request to update the bid modifier of campaign criterion.
my $campaign_criteria_response =
$api_client->CampaignCriterionService()->mutate({
customerId => $customer_id,
operations => [$campaign_criterion_operation]});
# Print the resource name of the updated campaign criterion.
printf "Campaign criterion with resource name '%s' was modified.\n",
$campaign_criteria_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,
"criterion_id=i" => \$criterion_id,
"bid_modifier_value=f" => \$bid_modifier_value
);
# 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, $criterion_id,
$bid_modifier_value);
# Call the example.
update_campaign_criterion_bid_modifier($api_client, $customer_id =~ s/-//gr,
$campaign_id, $criterion_id, $bid_modifier_value);
=pod
=head1 NAME
update_campaign_criterion_bid_modifier
=head1 DESCRIPTION
This example updates a campaign criterion with a new bid modifier value.
=head1 SYNOPSIS
update_campaign_criterion_bid_modifier.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-campaign_id The campaign ID.
-criterion_id The ID of the campaign criterion to update.
-bid_modifier_value [optional] The bid modifier value to set.
=cut
