AI-generated Key Takeaways
-
This code example demonstrates how to dismiss a given recommendation using the Google Ads API.
-
To identify the recommendation to dismiss, you need its resource name which can be obtained from retrieving recommendations, for example by running GetTextAdRecommendations.
-
The dismissal is performed by creating a DismissRecommendationOperation with the recommendation's resource name and executing a mutate request.
-
The example is provided in multiple programming languages: Java, C#, PHP, Python, and Ruby.
-
Error handling is included to catch potential GoogleAdsException errors during the API call.
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.recommendations ; 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.v22.errors.GoogleAdsError ; import com.google.ads.googleads.v22.errors.GoogleAdsException ; import com.google.ads.googleads.v22.services.DismissRecommendationRequest.DismissRecommendationOperation ; import com.google.ads.googleads.v22.services.DismissRecommendationResponse ; import com.google.ads.googleads.v22.services.DismissRecommendationResponse.DismissRecommendationResult ; import com.google.ads.googleads.v22.services.RecommendationServiceClient ; import com.google.ads.googleads.v22.utils.ResourceNames ; import java.io.FileNotFoundException ; import java.io.IOException ; import java.util.Arrays ; /** * Dismisses a given recommendation. To retrieve recommendations for text ads, run * GetTextAdRecommendations.java. */ public class DismissRecommendation { private static class DismissRecommendationParams extends CodeSampleParams { @Parameter ( names = ArgumentNames . CUSTOMER_ID , required = true ) private Long customerId ; @Parameter ( names = ArgumentNames . RECOMMENDATION_ID , required = true ) private String recommendationId ; } public static void main ( String [] args ) { DismissRecommendationParams params = new DismissRecommendationParams (); 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" ); // Recommendation ID is the last alphanumeric portion of the value from // Recommendation.getResourceName(), which has the format of // `customers/<customer_id>/recommendations/<recommendation_id>`. // Its example can be retrieved from GetTextAdRecommendations.java. params . recommendationId = "INSERT_RECOMMENDATION_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 DismissRecommendation () . runExample ( googleAdsClient , params . customerId , params . recommendationId ); } 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. */ private void runExample ( GoogleAdsClient googleAdsClient , Long customerId , String recommendationId ) { // Converts the customer and recommendation ID to a resource name. String resourceName = ResourceNames . recommendation ( customerId , recommendationId ); // Constructs a dismiss operation for the recommendation. DismissRecommendationOperation operation = DismissRecommendationOperation . newBuilder (). setResourceName ( resourceName ). build (); // Issues a mutate request to dismiss the recommendation. try ( RecommendationServiceClient client = googleAdsClient . getLatestVersion (). createRecommendationServiceClient ()) { DismissRecommendationResponse response = client . dismissRecommendation ( customerId . toString (), Arrays . asList ( operation )); DismissRecommendationResult result = response . getResultsList (). get ( 0 ); System . out . printf ( "Dismissed recommendation with resource name: '%s'%n" , result . getResourceName ()); } } }
C#
// 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. using CommandLine ; using Google.Ads.Gax.Examples ; using Google.Ads.GoogleAds.Lib ; using Google.Ads.GoogleAds.V22.Errors ; using Google.Ads.GoogleAds.V22.Services ; using System ; using static Google . Ads . GoogleAds . V22 . Services . DismissRecommendationRequest . Types ; using static Google . Ads . GoogleAds . V22 . Services . DismissRecommendationResponse . Types ; namespace Google.Ads.GoogleAds.Examples.V22 { /// <summary> /// This code example dismisses a given recommendation. To retrieve recommendations for text /// ads, run GetTextAdRecommendations.cs. /// </summary> public class DismissRecommendation : ExampleBase { /// <summary> /// Command line options for running the <see cref="DismissRecommendation"/> example. /// </summary> public class Options : OptionsBase { /// <summary> /// The customer ID for which the call is made. /// </summary> [Option("customerId", Required = true, HelpText = "The customer ID for which the call is made.")] public long CustomerId { get ; set ; } /// <summary> /// ID of the recommendation to dismiss. /// </summary> [Option("recommendationId", Required = true, HelpText = "ID of the recommendation to dismiss.")] public long RecommendationId { 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 ); DismissRecommendation codeExample = new DismissRecommendation (); Console . WriteLine ( codeExample . Description ); codeExample . Run ( new GoogleAdsClient (), options . CustomerId , options . RecommendationId ); } /// <summary> /// Returns a description about the code example. /// </summary> public override string Description = > "This code example dismisses a given recommendation. To retrieve recommendations for " + "text ads, run GetTextAdRecommendations.cs." ; /// <summary> /// Runs the code example. /// </summary> /// <param name="client">The Google Ads client.</param> /// <param name="customerId">The customer ID for which the call is made.</param> /// <param name="recommendationId">ID of the recommendation to dismiss.</param> public void Run ( GoogleAdsClient client , long customerId , long recommendationId ) { // Get the RecommendationServiceClient. RecommendationServiceClient service = client . GetService ( Services . V22 . RecommendationService ); DismissRecommendationOperation operation = new DismissRecommendationOperation () { ResourceName = ResourceNames . Recommendation ( customerId , recommendationId ), }; try { DismissRecommendationResponse response = service . DismissRecommendation ( customerId . ToString (), new DismissRecommendationOperation [] { operation }); foreach ( DismissRecommendationResult result in response . Results ) { Console . WriteLine ( $"Dismissed recommendation with resource name = " + $"'{result.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 2018 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\Recommendations; 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\V22\GoogleAdsClient; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsClientBuilder; use Google\Ads\GoogleAds\Lib\V22\GoogleAdsException; use Google\Ads\GoogleAds\Util\V22\ResourceNames; use Google\Ads\GoogleAds\V22\Errors\GoogleAdsError; use Google\Ads\GoogleAds\V22\Resources\Recommendation; use Google\Ads\GoogleAds\V22\Services\DismissRecommendationRequest; use Google\Ads\GoogleAds\V22\Services\DismissRecommendationRequest\DismissRecommendationOperation; use Google\ApiCore\ApiException; /** * This example dismisses a given recommendation. */ class DismissRecommendation { private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE'; // Recommendation ID is the last alphanumeric portion of the resource name obtained from // ResourceNames::forRecommendation(), which has the format of // `customers/<customer_id>/recommendations/<recommendation_id>`. private const RECOMMENDATION_ID = 'INSERT_RECOMMENDATION_ID_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::RECOMMENDATION_ID => 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) ->build(); try { self::runExample( $googleAdsClient, $options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID, $options[ArgumentNames::RECOMMENDATION_ID] ?: self::RECOMMENDATION_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 customer ID * @param string $recommendationId the recommendation ID to dismiss */ public static function runExample( GoogleAdsClient $googleAdsClient, int $customerId, string $recommendationId ) { $recommendationResourceName = ResourceNames::forRecommendation($customerId, $recommendationId); $dismissRecommendationOperation = new DismissRecommendationOperation(); $dismissRecommendationOperation->setResourceName($recommendationResourceName); // Issues a mutate request to dismiss the recommendation. $recommendationServiceClient = $googleAdsClient->getRecommendationServiceClient(); $response = $recommendationServiceClient->dismissRecommendation( DismissRecommendationRequest::build($customerId, [$dismissRecommendationOperation]) ); /** @var Recommendation $dismissedRecommendation */ $dismissedRecommendation = $response->getResults()[0]; printf( "Dismissed recommendation with resource name: '%s'.%s", $dismissedRecommendation->getResourceName(), PHP_EOL ); } } DismissRecommendation::main();
Python
#!/usr/bin/env python # 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. """This example dismisses a given recommendation. To retrieve recommendations for text ads, run get_text_ad_recommendations.py. """ import argparse import sys from google.ads.googleads.client import GoogleAdsClient from google.ads.googleads.errors import GoogleAdsException from google.ads.googleads.v22.services.services.recommendation_service import ( RecommendationServiceClient , ) from google.ads.googleads.v22.services.types.recommendation_service import ( DismissRecommendationRequest , DismissRecommendationResponse , ) def main ( client : GoogleAdsClient , customer_id : str , recommendation_id : str ) - > None : recommendation_service : RecommendationServiceClient = client . get_service ( "RecommendationService" ) request : DismissRecommendationRequest = client . get_type ( "DismissRecommendationRequest" ) operation = request . DismissRecommendationOperation () operation . resource_name = recommendation_service . recommendation_path ( customer_id , recommendation_id ) request . customer_id = customer_id request . operations . append ( operation ) response : DismissRecommendationResponse = ( recommendation_service . dismiss_recommendation ( request = request ) ) print ( "Dismissed recommendation with resource name: " f "' { response . results [ 0 ] . resource_name } '." ) if __name__ == "__main__" : parser : argparse . ArgumentParser = argparse . ArgumentParser ( description = ( "Dismisses a recommendation with the given 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 ( "-r" , "--recommendation_id" , type = str , required = True , help = "The recommendation ID." , ) args : argparse . Namespace = parser . parse_args () # GoogleAdsClient will read the google-ads.yaml configuration file in the # home directory if none is specified. googleads_client : GoogleAdsClient = GoogleAdsClient . load_from_storage ( version = "v22" ) try : main ( googleads_client , args . customer_id , args . recommendation_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 ' \t Error with message " { error . message } ".' ) if error . location : for field_path_element in error . location . field_path_elements : print ( f " \t\t On field: { field_path_element . field_name } " ) sys . exit ( 1 )
Ruby
#!/usr/bin/env ruby # Encoding: utf-8 # # Copyright 2018 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 dismisses a given recommendation. To retrieve recommendations for # text ads, run get_text_ad_recommendations.rb. require 'optparse' require 'google/ads/google_ads' def dismiss_recommendation ( customer_id , recommendation_id ) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google :: Ads :: GoogleAds :: GoogleAdsClient . new recommendation_resource = client . path . recommendation ( customer_id , recommendation_id ) dismiss_recommendation_operation = client . operation . dismiss_recommendation dismiss_recommendation_operation . resource_name = recommendation_resource # Issues a mutate request to dismiss the recommendation. recommendation_service = client . service . recommendation response = recommendation_service . dismiss_recommendation ( customer_id : customer_id , operations : [ dismiss_recommendation_operation ] , ) dismissed_recommendation = response . results . first puts "Dismissed recommendation with resource name: " + " #{ dismissed_recommendation . 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' # Recommendation ID is the last alphanumeric portion of the value from the # resource_name field of a Recommendation, which has the format of # customers/<customer_id>/recommendations/<recommendation_id>. # Its example can be retrieved from get_text_ad_recommendations.rb. options [ :recommendation_id ] = 'INSERT_RECOMMENDATION_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 ( '-r' , '--recommendation-id RECOMMENDATION-ID' , String , 'Recommendation ID' ) do | v | options [ :recommendation_id ] = v end opts . separator '' opts . separator 'Help:' opts . on_tail ( '-h' , '--help' , 'Show this message' ) do puts opts exit end end . parse! begin dismiss_recommendation ( options . fetch ( :customer_id ) . tr ( "-" , "" ), options . fetch ( :recommendation_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 ( " \t On 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 ( " \t Type: %s \n\t Code: %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 dismisses a given recommendation. 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::V22::Services::RecommendationService::DismissRecommendationOperation ; use Google::Ads::GoogleAds::V22::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" ; # Recommendation ID is the last alphanumeric portion of the value from the # resourceName field of a Recommendation, which has the format of # customers/<customer_id>/recommendations/<recommendation_id>. # Its example can be retrieved from get_text_ad_recommendations.pl. my $recommendation_id = "INSERT_RECOMMENDATION_ID_HERE" ; sub dismiss_recommendation { my ( $api_client , $customer_id , $recommendation_id ) = @_ ; my $recommendation_resource_name = Google::Ads::GoogleAds::V22::Utils::ResourceNames:: recommendation ( $customer_id , $recommendation_id ); # Create an dismiss recommendation operation. my $dismiss_recommendation_operation = Google::Ads::GoogleAds::V22::Services::RecommendationService:: DismissRecommendationOperation - > new ({ resourceName = > $recommendation_resource_name }); # Dismiss the recommendation. my $dismiss_recommendation_response = $api_client - > RecommendationService () - > dismiss ({ customerId = > $customer_id , operations = > [ $dismiss_recommendation_operation ]}); printf "Dismissed recommendation with resource name: '%s'.\n" , $dismiss_recommendation_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 , "recommendation_id=i" = > \ $recommendation_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 , $recommendation_id ); # Call the example. dismiss_recommendation ( $api_client , $customer_id =~ s/-//g r , $recommendation_id ); =pod =head1 NAME dismiss_recommendation =head1 DESCRIPTION This example dismisses a given recommendation. To retrieve recommendations for text ads, run get_text_ad_recommendations.pl. =head1 SYNOPSIS dismiss_recommendation.pl [options] -help Show the help message. -customer_id The Google Ads customer ID. -recommendation_id The recommendation ID to dismiss. =cut
