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
//
// 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.extensions;
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.v15.errors.GoogleAdsError;
import com.google.ads.googleads.v15.errors.GoogleAdsException;
import com.google.ads.googleads.v15.resources.ExtensionFeedItem;
import com.google.ads.googleads.v15.services.ExtensionFeedItemOperation;
import com.google.ads.googleads.v15.services.ExtensionFeedItemServiceClient;
import com.google.ads.googleads.v15.services.MutateExtensionFeedItemsResponse;
import com.google.ads.googleads.v15.utils.ResourceNames;
import com.google.common.collect.ImmutableList;
import java.io.FileNotFoundException;
import java.io.IOException;
/** Adds a geo target to an extension feed item for targeting. */
public class AddGeoTarget {
// A list of country codes can be referenced here:
// https://developers.google.com/google-ads/api/reference/data/geotargets
private static long GEO_TARGET_CONSTANT_ID = 2840L; // US
private static class AddGeoTargetParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.FEED_ITEM_ID, required = true)
private Long feedItemId;
@Parameter(
names = ArgumentNames.GEO_TARGET_CONSTANT_ID,
description =
"The geo target constant ID to add to the extension feed item. A default value will be"
+ " used if no value is provided.")
private Long geoTargetConstantId = GEO_TARGET_CONSTANT_ID;
}
public static void main(String[] args) {
AddGeoTargetParams params = new AddGeoTargetParams();
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.feedItemId = Long.parseLong("INSERT_FEED_ID_HERE");
// Optional: Specify a geoTargetConstantId.
params.geoTargetConstantId = GEO_TARGET_CONSTANT_ID;
}
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 AddGeoTarget()
.runExample(
googleAdsClient, params.customerId, params.feedItemId, params.geoTargetConstantId);
} 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 feedItemId the feed item ID.
* @param geoTargetConstantId the geo target constant ID to add to the extension feed item.
*/
private void runExample(
GoogleAdsClient googleAdsClient, long customerId, long feedItemId, Long geoTargetConstantId) {
// Creates an extension feed item using the specified feed item ID and geo target constant
// ID for targeting.
ExtensionFeedItem extensionFeedItem =
ExtensionFeedItem.newBuilder()
.setResourceName(ResourceNames.extensionFeedItem(customerId, feedItemId))
.setTargetedGeoTargetConstant(ResourceNames.geoTargetConstant(geoTargetConstantId))
.build();
// Constructs an operation that will update the extension feed item, using the FieldMasks
// utility to derive the update mask. This mask tells the Google Ads API which attributes of
// the extension feed item you want to change.
ExtensionFeedItemOperation extensionFeedItemOperation =
ExtensionFeedItemOperation.newBuilder()
.setUpdate(extensionFeedItem)
.setUpdateMask(FieldMasks.allSetFieldsOf(extensionFeedItem))
.build();
// Creates the service client.
try (ExtensionFeedItemServiceClient extensionFeedItemServiceClient =
googleAdsClient.getLatestVersion().createExtensionFeedItemServiceClient()) {
// Issues a mutate request to update the extension feed item.
MutateExtensionFeedItemsResponse response =
extensionFeedItemServiceClient.mutateExtensionFeedItems(
Long.toString(customerId), ImmutableList.of(extensionFeedItemOperation));
// Prints the resource name of the updated extension feed item.
System.out.printf(
"Updated feed item with resource name '%s'.%n", response.getResults(0).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.Gax.Util;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V15.Errors;
using Google.Ads.GoogleAds.V15.Resources;
using Google.Ads.GoogleAds.V15.Services;
using System;
using System.Collections.Generic;
using System.Linq;
namespace Google.Ads.GoogleAds.Examples.V15
{
/// <summary>
/// Adds a geo target to a extension feed item for targeting.
/// </summary>
public class AddGeoTarget : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddGeoTarget"/> 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>
/// The feed item ID.
/// </summary>
[Option("feedItemId", Required = true, HelpText =
"The feed item ID.")]
public long FeedItemId { get; set; }
/// <summary>
/// Geo target constant ID to add to the extension feed item. Reverts to the United
/// States (2840) if no value passed.
/// </summary>
[Option("geoTargetConstantId", Required = false, HelpText =
"Geo target constant ID to add to the extension feed item. Reverts to the United" +
" States (2840) if no value passed.")]
public long? GeoTargetConstantId { 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);
AddGeoTarget codeExample = new AddGeoTarget();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.FeedItemId,
options.GeoTargetConstantId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"Adds a geo target to an extension feed item for targeting.";
/// <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="feedItemId">The feed item ID.</param>
/// <param name="geoTargetConstantId">Geo target constant ID to add to the extension
/// feed item. Reverts to the United States (2840) if no value passed.</param>
public void Run(GoogleAdsClient client, long customerId, long feedItemId,
long? geoTargetConstantId)
{
// Get the ExtensionFeedItemServiceClient.
ExtensionFeedItemServiceClient extensionFeedItemServiceClient =
client.GetService(Services.V15.ExtensionFeedItemService);
// Apply the default geo target constant ID (USA) if none was passed to the function.
if (!geoTargetConstantId.HasValue)
{
geoTargetConstantId = 2840L;
}
// Creates an extension feed item using the specified feed item ID and geo target
// constant ID for targeting.
ExtensionFeedItem extensionFeedItem = new ExtensionFeedItem()
{
ResourceName = ResourceNames.ExtensionFeedItem(customerId, feedItemId),
TargetedGeoTargetConstant = ResourceNames.GeoTargetConstant(geoTargetConstantId.Value)
};
// Constructs an operation that will update the extension feed item, using the
// FieldMasks utility to derive the update mask. This mask tells the Google Ads API
// which attributes of the extension feed item you want to change.
ExtensionFeedItemOperation operation = new ExtensionFeedItemOperation()
{
Update = extensionFeedItem,
UpdateMask = FieldMasks.AllSetFieldsOf(extensionFeedItem)
};
try
{
// Issues a mutate request to update the extension feed item.
MutateExtensionFeedItemsResponse response =
extensionFeedItemServiceClient.MutateExtensionFeedItems(customerId.ToString(),
new[] { operation });
// Prints the resource name of the updated extension feed item.
Console.WriteLine("Updated extension feed item with resource name " +
$"{response.Results.First().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 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\Extensions;
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\V15\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V15\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V15\GoogleAdsException;
use Google\Ads\GoogleAds\Util\FieldMasks;
use Google\Ads\GoogleAds\Util\V15\ResourceNames;
use Google\Ads\GoogleAds\V15\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V15\Resources\ExtensionFeedItem;
use Google\Ads\GoogleAds\V15\Services\ExtensionFeedItemOperation;
use Google\Ads\GoogleAds\V15\Services\MutateExtensionFeedItemsRequest;
use Google\ApiCore\ApiException;
/**
* Adds a geo target to an extension feed item for targeting.
*/
class AddGeoTarget
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const FEED_ITEM_ID = 'INSERT_FEED_ITEM_ID_HERE';
// A list of country codes can be referenced here:
// https://developers.google.com/adwords/api/docs/appendix/geotargeting
private const GEO_TARGET_CONSTANT_ID = 2840; // US
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::FEED_ITEM_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::GEO_TARGET_CONSTANT_ID => 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)
// 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::FEED_ITEM_ID] ?: self::FEED_ITEM_ID,
$options[ArgumentNames::GEO_TARGET_CONSTANT_ID] ?: self::GEO_TARGET_CONSTANT_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 client customer ID
* @param int $feedItemId the feed item ID
* @param int $geoTargetConstantId the geo target constant ID to add to the extension feed item
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $feedItemId,
int $geoTargetConstantId
) {
// Creates an extension feed item using the specified feed item ID and geo target constant
// ID for targeting.
$extensionFeedItem = new ExtensionFeedItem([
'resource_name' => ResourceNames::forExtensionFeedItem($customerId, $feedItemId),
'targeted_geo_target_constant'
=> ResourceNames::forGeoTargetConstant($geoTargetConstantId)
]);
// Constructs an operation that will update the extension feed item, using the FieldMasks
// utility to derive the update mask. This mask tells the Google Ads API which attributes of
// the extension feed item you want to change.
$extensionFeedItemOperation = new ExtensionFeedItemOperation();
$extensionFeedItemOperation->setUpdate($extensionFeedItem);
$extensionFeedItemOperation->setUpdateMask(FieldMasks::allSetFieldsOf($extensionFeedItem));
// Issues a mutate request to update the extension feed item.
$extensionFeedItemServiceClient = $googleAdsClient->getExtensionFeedItemServiceClient();
$response = $extensionFeedItemServiceClient->mutateExtensionFeedItems(
MutateExtensionFeedItemsRequest::build($customerId, [$extensionFeedItemOperation])
);
// Prints the resource name of the updated extension feed item.
/** @var ExtensionFeedItem $updatedExtensionFeedItem */
$updatedExtensionFeedItem = $response->getResults()[0];
printf(
"Updated extension feed item with resource name: '%s'.%s",
$updatedExtensionFeedItem->getResourceName(),
PHP_EOL
);
}
}
AddGeoTarget::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.
"""Adds a geo target to an extension feed item for targeting."""
import argparse
import sys
from google.api_core import protobuf_helpers
from google.ads.googleads.client import GoogleAdsClient
from google.ads.googleads.errors import GoogleAdsException
def main(client, customer_id, feed_item_id, geo_target_constant_id):
"""The main method that creates all necessary entities for the example.
Args:
client: an initialized GoogleAdsClient instance.
customer_id: a client customer ID.
feed_item_id: the ID of an extension feed item.
geo_target_constant_id: the geo target constant ID to add to the
extension feed item.
"""
extension_feed_item_service = client.get_service("ExtensionFeedItemService")
extension_feed_item_operation = client.get_type(
"ExtensionFeedItemOperation"
)
extension_feed_item = extension_feed_item_operation.update
# Creates an extension feed item using the specified feed item ID and
# geo target constant ID for targeting.
extension_feed_item.resource_name = (
extension_feed_item_service.extension_feed_item_path(
customer_id, feed_item_id
)
)
extension_feed_item.targeted_geo_target_constant = client.get_service(
"GeoTargetConstantService"
).geo_target_constant_path(geo_target_constant_id)
client.copy_from(
extension_feed_item_operation.update_mask,
protobuf_helpers.field_mask(None, extension_feed_item._pb),
)
response = extension_feed_item_service.mutate_extension_feed_items(
customer_id=customer_id, operations=[extension_feed_item_operation]
)
print(
"Updated extension feed item with resource name: "
f"'{response.results[0].resource_name}'."
)
if __name__ == "__main__":
# GoogleAdsClient will read the google-ads.yaml configuration file in the
# home directory if none is specified.
googleads_client = GoogleAdsClient.load_from_storage(version="v15")
parser = argparse.ArgumentParser(
description="Adds a geo target to an extension feed item for targeting."
)
# 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(
"-f",
"--feed_item_id",
type=str,
required=True,
help="The ID of the extension feed item to add a geo target to.",
)
parser.add_argument(
"-g",
"--geo_target_constant_id",
type=str,
default="2840", # country code for "US"
help="A geo target constant ID. A list of available IDs can be "
"referenced here: https://developers.google.com/google-ads/api/reference/data/geotargets",
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
args.feed_item_id,
args.geo_target_constant_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'\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)
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 adds a geo target to an extension feed item for targeting.
require 'optparse'
require 'google/ads/google_ads'
require 'date'
def add_geo_target(customer_id, feed_item_id, geo_target_constant_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
if geo_target_constant_id.nil?
geo_target_constant_id = GEO_TARGET_CONSTANT_ID
end
resource_name = client.path.extension_feed_item(customer_id, feed_item_id)
# Creates the update operation for extension feed item using the
# specified feed item ID and geo target constant ID for targeting.
operation = client.operation.update_resource.extension_feed_item(resource_name) do |efi|
efi.targeted_geo_target_constant = client.path.geo_target_constant(geo_target_constant_id)
end
# Issues a mutate request to update the extension feed item.
response = client.service.extension_feed_item.mutate_extension_feed_items(
customer_id: customer_id,
operations: [operation]
)
# Prints the resource name of the updated extension feed item.
puts "Updated extension feed item with resource name: " \
"'#{response.results.first.resource_name}'"
end
if __FILE__ == $0
# Geo target constant ID for US.
GEO_TARGET_CONSTANT_ID = 2840
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[:feed_item_id] = 'INSERT_FEED_ITEM_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('-f', '--feed-item-id FEED-ITEM-ID', String, 'Feed Item ID') do |v|
options[:feed_item_id] = v
end
opts.on('-g', '--geo-target-constant-id GEO-TARGET-CONSTANT-ID', String, 'Geo Target Constant ID') do |v|
options[:geo_target_constant_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_geo_target(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:feed_item_id),
options[:geo_target_constant_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 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.
#
# Adds a geo target to a extension feed item for targeting.
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::V15::Resources::ExtensionFeedItem;
use
Google::Ads::GoogleAds::V15::Services::ExtensionFeedItemService::ExtensionFeedItemOperation;
use Google::Ads::GoogleAds::V15::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 $feed_item_id = "INSERT_FEED_ITEM_ID_HERE";
# A list of country codes can be referenced here:
# https://developers.google.com/google-ads/api/reference/data/geotargets
my $geo_target_constant_id = 2840; # US
sub add_geo_target {
my ($api_client, $customer_id, $feed_item_id, $geo_target_constant_id) = @_;
# Create an extension feed item using the specified feed item ID and geo target
# constant ID for targeting.
my $extension_feed_item =
Google::Ads::GoogleAds::V15::Resources::ExtensionFeedItem->new({
resourceName =>
Google::Ads::GoogleAds::V15::Utils::ResourceNames::extension_feed_item(
$customer_id, $feed_item_id
),
targetedGeoTargetConstant =>
Google::Ads::GoogleAds::V15::Utils::ResourceNames::geo_target_constant(
$geo_target_constant_id)});
# Construct an operation that will update the extension feed item, using the
# FieldMasks utility to derive the update mask. This mask tells the Google Ads
# API which attributes of the extension feed item you want to change.
my $extension_feed_item_operation =
Google::Ads::GoogleAds::V15::Services::ExtensionFeedItemService::ExtensionFeedItemOperation
->new({
update => $extension_feed_item,
updateMask => all_set_fields_of($extension_feed_item)});
# Issue a mutate request to update the extension feed item.
my $extension_feed_items_response =
$api_client->ExtensionFeedItemService()->mutate({
customerId => $customer_id,
operations => [$extension_feed_item_operation]});
# Print the resource name of the updated extension feed item.
my $updated_extension_feed_item =
$extension_feed_items_response->{results}[0];
printf "Updated extension feed item with resource name: '%s'.\n",
$updated_extension_feed_item->{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,
"feed_item_id=i" => \$feed_item_id,
"geo_target_constant_id=i" => \$geo_target_constant_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, $feed_item_id);
# Call the example.
add_geo_target(
$api_client, $customer_id =~ s/-//gr,
$feed_item_id, $geo_target_constant_id
);
=pod
=head1 NAME
add_geo_target
=head1 DESCRIPTION
Adds a geo target to a extension feed item for targeting.
=head1 SYNOPSIS
add_geo_target.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-feed_item_id The feed item ID.
-geo_target_constant_id [optional] The geo target constant ID to add
to the extension feed item.
=cut
