Java
// 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 // // 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.feeds; 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.v17.errors.GoogleAdsError; import com.google.ads.googleads.v17.errors.GoogleAdsException; import com.google.ads.googleads.v17.services.FeedItemOperation; import com.google.ads.googleads.v17.services.FeedItemServiceClient; import com.google.ads.googleads.v17.services.MutateFeedItemResult; import com.google.ads.googleads.v17.services.MutateFeedItemsResponse; import com.google.ads.googleads.v17.utils.ResourceNames; import java.io.FileNotFoundException; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; import java.util.List; /** Removes feed items from a feed. */ public class RemoveFeedItems { private static class RemoveFeedItemsParams extends CodeSampleParams { @Parameter(names = ArgumentNames.CUSTOMER_ID, required = true) private long customerId; @Parameter(names = ArgumentNames.FEED_ID, required = true) private long feedId; @Parameter(names = ArgumentNames.FEED_ITEM_IDS, required = true) private List<Long> feedItemIds; } public static void main(String[] args) { RemoveFeedItemsParams params = new RemoveFeedItemsParams(); 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.feedId = Long.parseLong("INSERT_CUSTOMER_ID_HERE"); params.feedItemIds = new ArrayList<>( Arrays.asList( Long.parseLong("INSERT_FEED_ITEM_1_ID_HERE"), Long.parseLong("INSERT_FEED_ITEM_2_ID_HERE"), Long.parseLong("INSERT_FEED_ITEM_3_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 RemoveFeedItems().runExample(googleAdsClient, params); } 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 params the RemoveFeedItemsParams for the example. * @throws GoogleAdsException if an API request failed with one or more service errors. */ private void runExample(GoogleAdsClient googleAdsClient, RemoveFeedItemsParams params) { List<FeedItemOperation> operations = new ArrayList<>(); // Creates the remove operations. for (long feedItemId : params.feedItemIds) { String feedItem = ResourceNames.feedItem(params.customerId, params.feedId, feedItemId); FeedItemOperation operation = FeedItemOperation.newBuilder().setRemove(feedItem).build(); operations.add(operation); } // Creates the feed item service client. try (FeedItemServiceClient feedItemServiceClient = googleAdsClient.getLatestVersion().createFeedItemServiceClient()) { // Issues the mutate request. MutateFeedItemsResponse response = feedItemServiceClient.mutateFeedItems(Long.toString(params.customerId), operations); for (MutateFeedItemResult result : response.getResultsList()) { System.out.printf("Removed feed item with resource name '%s'.%n", result.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.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; using System.Linq; namespace Google.Ads.GoogleAds.Examples.V17 { /// <summary> /// Removes feed items from a feed. /// </summary> public class RemoveFeedItems : ExampleBase { /// <summary> /// Command line options for running the <see cref="RemoveFeedItems"/> 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 ID to which the feed items belong. /// </summary> [Option("feedId", Required = true, HelpText = "The Feed ID to which the feed items belong.")] public long FeedId { get; set; } /// <summary> /// The IDs of the feed items to remove. /// </summary> [Option("feedItemIds", Required = true, HelpText = "The IDs of the feed items to remove.")] public IEnumerable<long> FeedItemIds { 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); RemoveFeedItems codeExample = new RemoveFeedItems(); Console.WriteLine(codeExample.Description); codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.FeedId, options.FeedItemIds.ToArray()); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description => "Removes feed items from a feed."; /// <summary> /// Runs the code example. /// </summary> /// <param name="client">The Google Ads API client.</param> /// <param name="customerId">The Google Ads customer ID for which the call is made.</param> /// <param name="feedId">The Feed ID to which the feed items belong.</param> /// <param name="feedItemIds">The IDs of the feed items to remove.</param> public void Run(GoogleAdsClient client, long customerId, long feedId, long[] feedItemIds) { FeedItemServiceClient feedItemServiceClient = client.GetService( Services.V17.FeedItemService); // Creates the remove operations. List<FeedItemOperation> operations = new List<FeedItemOperation>(); foreach (long feedItemId in feedItemIds) { // Constructs the feed item resource name. string feedItemResourceName = ResourceNames.FeedItem(customerId, feedId, feedItemId); // Constructs an operation that will remove the feed item based on the resource name // and adds it to the collection of operations. operations.Add(new FeedItemOperation { Remove = feedItemResourceName }); } try { // Issues a mutate request to remove the feed items. MutateFeedItemsResponse response = feedItemServiceClient.MutateFeedItems(customerId.ToString(), operations); // Prints the resource names of the removed feed items. foreach (MutateFeedItemResult removedFeedItem in response.Results) { Console.WriteLine("Removed feed item with resource name " + $"'{removedFeedItem.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 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 * * 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\Feeds; 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\V17\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V17\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V17\GoogleAdsException; use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder; use Google\Ads\GoogleAds\Util\V17\ResourceNames; use Google\Ads\GoogleAds\V17\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V17\Resources\FeedItem; use Google\Ads\GoogleAds\V17\Services\FeedItemOperation; use Google\Ads\GoogleAds\V17\Services\MutateFeedItemsRequest; use Google\ApiCore\ApiException; /** Removes feed items from a feed. */ class RemoveFeedItems { private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; private const FEED_ID = 'INSERT_FEED_ID_HERE'; private const FEED_ITEM_ID_1 = 'INSERT_FEED_ITEM_ID_1_HERE'; private const FEED_ITEM_ID_2 = 'INSERT_FEED_ITEM_ID_2_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_ID => GetOpt::REQUIRED_ARGUMENT, ArgumentNames::FEED_ITEM_IDS => GetOpt::MULTIPLE_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_ID] ?: self::FEED_ID, $options[ArgumentNames::FEED_ITEM_IDS] ?: [self::FEED_ITEM_ID_1, self::FEED_ITEM_ID_2] ); } 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 $feedId the feed ID that the feed items belong to * @param array $feedItemIds the IDs of the feed items to remove */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, int $feedId, array $feedItemIds ) { // Creates the remove operations. $operations = []; foreach ($feedItemIds as $feedItemId) { // Creates the feed item resource name. $feedItemResourceName = ResourceNames::forFeedItem( $customerId, $feedId, $feedItemId ); // Constructs an operation that will remove the feed item based on the resource name. $feedItemOperation = new FeedItemOperation(); $feedItemOperation->setRemove($feedItemResourceName); $operations[] = $feedItemOperation; } // Issues a mutate request to remove the feed items. $feedItemServiceClient = $googleAdsClient->getFeedItemServiceClient(); $response = $feedItemServiceClient->mutateFeedItems( MutateFeedItemsRequest::build($customerId, $operations) ); // Prints the resource names of the removed feed items. foreach ($response->getResults() as $removedFeedItem) { /** @var FeedItem $removedFeedItem */ printf( "Removed feed item with resource name '%s'.%s", $removedFeedItem->getResourceName(), PHP_EOL ); } } } RemoveFeedItems::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. """Removes feed items from a feed.""" import argparse import sys from google.ads.googleads.client import GoogleAdsClient from google.ads.googleads.errors import GoogleAdsException def main(client, customer_id, feed_id, feed_item_ids): """The main method that creates all necessary entities for the example. Args: client: an initialized GoogleAdsClient instance. customer_id: a client customer ID. feed_id: the ID for a Feed belonging to the given customer. feed_item_ids: a list of FeedItem IDs belonging to the given Feed. """ feed_item_service = client.get_service("FeedItemService") operations = [] for feed_item_id in feed_item_ids: # Constructs an operation that will remove the feed item based on the # resource name. feed_item_operation = client.get_type("FeedItemOperation") # Constructs a resource name for a feed_item, which is in the # format: customers/{customer_id}/feedItems/{feed_id}~{feed_item_id} feed_item_operation.remove = feed_item_service.feed_item_path( customer_id, feed_id, feed_item_id ) operations.append(feed_item_operation) response = feed_item_service.mutate_feed_items( customer_id=customer_id, operations=operations ) for feed_item in response.results: print( "Removed feed item with resource name: " f"'{feed_item.resource_name}'" ) if __name__ == "__main__": parser = argparse.ArgumentParser( description="Removes feed items from a feed." ) # 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_id", type=str, required=True, help="The ID of the feed to remove feed items from.", ) parser.add_argument( "-i", "--feed_item_ids", nargs=2, type=str, required=True, help="Space-delimited list of IDs for feed items to remove from the" "given feed.", ) 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.feed_id, args.feed_item_ids, ) 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. # # Removes feed items from a feed. require 'optparse' require 'google/ads/google_ads' require 'date' def remove_feed_items(customer_id, feed_id, feed_item_ids) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new operations = [] # Creates the remove operations. feed_item_ids.each do |feed_item_id| operations << client.operation.remove_resource.feed_item( # Creates the feed item resource name. client.path.feed_item(customer_id, feed_id, feed_item_id) ) end # Issues a mutate request to remove the feed items. response = client.service.feed_item.mutate_feed_items( customer_id: customer_id, operations: operations, ) # Prints the resource names of the removed feed items. response.results.each do |result| puts "Removed feed item with resource name '#{result.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[:feed_id] = 'INSERT_FEED_ID_HERE' options[:feed_item_ids] = [ 'INSERT_FEED_ITEM_ID_1_HERE', 'INSERT_FEED_ITEM_ID_2_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-id FEED-ID', String, 'Feed ID') do |v| options[:feed_id] = v end opts.on('-f', '--feed-item-ids FEED-ITEM-IDS', String, 'Feed Item IDs (comma-separated)') do |v| options[:feed_item_ids] = v.split(',') end opts.separator '' opts.separator 'Help:' opts.on_tail('-h', '--help', 'Show this message') do puts opts exit end end.parse! begin remove_feed_items( options.fetch(:customer_id).tr("-", ""), options[:feed_id], options[:feed_item_ids], ) 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 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 removes feed items from a feed. 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::V17::Services::FeedItemService::FeedItemOperation; 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 $feed_id = "INSERT_FEED_ID_HERE"; my $feed_item_id1 = "INSERT_FEED_ITEM_ID_1_HERE"; my $feed_item_id2 = "INSERT_FEED_ITEM_ID_2_HERE"; my $feed_item_ids = []; sub remove_feed_items { my ($api_client, $customer_id, $feed_id, $feed_item_ids) = @_; my $feed_item_operations = []; # Create the remove operations. for my $feed_item_id (@$feed_item_ids) { my $feed_item_resource_name = Google::Ads::GoogleAds::V17::Utils::ResourceNames::feed_item($customer_id, $feed_id, $feed_item_id); push @$feed_item_operations, Google::Ads::GoogleAds::V17::Services::FeedItemService::FeedItemOperation ->new({ remove => $feed_item_resource_name }); } # Remove the feed items. my $feed_items_response = $api_client->FeedItemService()->mutate({ customerId => $customer_id, operations => [$feed_item_operations]}); foreach my $feed_item_result (@{$feed_items_response->{results}}) { printf "Removed feed item with resource name '%s'.\n", $feed_item_result->{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_id=i" => \$feed_id, "feed_item_ids=s" => \@$feed_item_ids ); $feed_item_ids = [$feed_item_id1, $feed_item_id2] unless @$feed_item_ids; # 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_id, $feed_item_ids); # Call the example. remove_feed_items($api_client, $customer_id =~ s/-//gr, $feed_id, $feed_item_ids); =pod =head1 NAME remove_feed_items =head1 DESCRIPTION This example removes feed items from a feed. =head1 SYNOPSIS remove_feed_items.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. -feed_id The feed ID. -feed_item_ids The IDs of the feed items to remove. =cut