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.common.SitelinkFeedItem;
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.MutateExtensionFeedItemResult;
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;
/** Updates a sitelink extension feed item {@code SitelinkFeedItem} with the specified link text. */
public class UpdateSitelink {
private static class UpdateSitelinkParams 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.SITELINK_TEXT, required = true)
private String sitelinkText;
}
public static void main(String[] args) {
UpdateSitelinkParams params = new UpdateSitelinkParams();
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_ITEM_ID_HERE");
params.sitelinkText = "INSERT_SITELINK_TEXT_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 UpdateSitelink()
.runExample(googleAdsClient, params.customerId, params.feedItemId, params.sitelinkText);
} 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 ID of the feed item to update.
* @param sitelinkText the new sitelink text to update to.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(
GoogleAdsClient googleAdsClient, long customerId, long feedItemId, String sitelinkText) {
try (ExtensionFeedItemServiceClient extensionFeedItemServiceClient =
googleAdsClient.getLatestVersion().createExtensionFeedItemServiceClient()) {
// Creates an extension feed item using the specified feed item ID and sitelink text.
ExtensionFeedItem extensionFeedItem =
ExtensionFeedItem.newBuilder()
.setResourceName(ResourceNames.extensionFeedItem(customerId, feedItemId))
.setSitelinkFeedItem(SitelinkFeedItem.newBuilder().setLinkText(sitelinkText).build())
.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 operation =
ExtensionFeedItemOperation.newBuilder()
.setUpdate(extensionFeedItem)
.setUpdateMask(FieldMasks.allSetFieldsOf(extensionFeedItem))
.build();
// Sends the operation in a mutate request.
MutateExtensionFeedItemsResponse response =
extensionFeedItemServiceClient.mutateExtensionFeedItems(
Long.toString(customerId), ImmutableList.of(operation));
// Prints the resource name of each updated object.
for (MutateExtensionFeedItemResult mutateExtensionFeedItemResult :
response.getResultsList()) {
System.out.printf(
"Updated extension feed item with the resource name: '%s'.%n",
mutateExtensionFeedItemResult.getResourceName());
}
}
}
}
C#
This example is not yet available in C#; you can take a look at the other languages.
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\Common\SitelinkFeedItem;
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;
/**
* Updates the sitelink extension feed item with the specified link text.
*/
class UpdateSitelink
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const FEED_ITEM_ID = 'INSERT_FEED_ITEM_ID_HERE';
private const SITELINK_TEXT = 'INSERT_SITELINK_TEXT_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::FEED_ITEM_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::SITELINK_TEXT => 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)
// 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::SITELINK_TEXT] ?: self::SITELINK_TEXT
);
} 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 string $sitelinkText the new sitelink text to update to
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $feedItemId,
string $sitelinkText
) {
// Creates an extension feed item using the specified feed item ID and sitelink text.
$extensionFeedItem = new ExtensionFeedItem([
'resource_name' => ResourceNames::forExtensionFeedItem($customerId, $feedItemId),
'sitelink_feed_item' => new SitelinkFeedItem(['link_text' => $sitelinkText])
]);
// 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
);
}
}
UpdateSitelink::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.
"""Update the sitelink extension feed item with the specified link text."""
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, sitelink_text):
"""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.
sitelink_text: the updated sitelink text.
"""
extension_feed_item_service = client.get_service("ExtensionFeedItemService")
extension_feed_item_operation = client.get_type(
"ExtensionFeedItemOperation"
)
extension_feed_item = extension_feed_item_operation.update
# Update the extension feed item using the specified feed item ID
extension_feed_item.resource_name = (
extension_feed_item_service.extension_feed_item_path(
customer_id, feed_item_id
)
)
extension_feed_item.sitelink_feed_item.link_text = sitelink_text
# Produce a field mask enumerating the changed fields
client.copy_from(
extension_feed_item_operation.update_mask,
protobuf_helpers.field_mask(None, extension_feed_item._pb),
)
# Update the extension feed item
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="Update sitelink extension feed item with the specified "
"link text."
)
# 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 update",
)
parser.add_argument(
"-s",
"--sitelink_text",
type=str,
required=True,
help="The updated sitelink text",
)
args = parser.parse_args()
try:
main(
googleads_client,
args.customer_id,
args.feed_item_id,
args.sitelink_text,
)
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.
#
# Updates the sitelink extension feed item with the specified link text.
require 'optparse'
require 'google/ads/google_ads'
def update_sitelink(customer_id, feed_item_id, sitelink_text)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
operation = client.operation.update_resource.extension_feed_item(
client.path.extension_feed_item(customer_id, feed_item_id)
) do |efi|
efi.sitelink_feed_item = client.resource.sitelink_feed_item do |sitelink|
sitelink.link_text = sitelink_text
end
end
response = client.service.extension_feed_item.mutate_extension_feed_items(
customer_id: customer_id,
operations: [operation],
)
puts "Updated extension feed item with resource name " \
"'#{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[:feed_item_id] = 'INSERT_FEED_ITEM_ID_HERE'
options[:sitelink_text] = 'INSERT_SITELINK_TEXT_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('-s', '--sitelink-text SITELINK-TEXT', String, 'Sitelink Text') do |v|
options[:sitelink_text] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
update_sitelink(
options.fetch(:customer_id).tr("-", ""),
options.fetch(:feed_item_id),
options[:sitelink_text],
)
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.
#
# Updates the sitelink extension feed item with the specified link text.
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::Common::SitelinkFeedItem;
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";
my $sitelink_text = "INSERT_SITELINK_TEXT_HERE";
sub update_sitelink {
my ($api_client, $customer_id, $feed_item_id, $sitelink_text) = @_;
# Create an extension feed item using the specified feed item ID and sitelink text.
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
),
sitelinkFeedItem =>
Google::Ads::GoogleAds::V15::Common::SitelinkFeedItem->new({
linkText => $sitelink_text
})});
# 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.
printf
"Updated extension feed item with resource name: '%s'.\n",
$extension_feed_items_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,
"feed_item_id=i" => \$feed_item_id,
"sitelink_text=s" => \$sitelink_text
);
# 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, $sitelink_text);
# Call the example.
update_sitelink($api_client, $customer_id =~ s/-//gr,
$feed_item_id, $sitelink_text);
=pod
=head1 NAME
update_sitelink
=head1 DESCRIPTION
Updates the sitelink extension feed item with the specified link text.
=head1 SYNOPSIS
update_sitelink.pl [options]
-help Show the help message.
-customer_id The Google Ads customer ID.
-feed_item_id The feed item ID.
-sitelink_text The new sitelink text to update to.
=cut
