Google Ads API is returning to beta status. Please read our blog post for more details.

Dismiss Recommendation

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.v2.utils.ResourceNames;
import com.google.ads.googleads.v2.errors.GoogleAdsError;
import com.google.ads.googleads.v2.errors.GoogleAdsException;
import com.google.ads.googleads.v2.services.DismissRecommendationRequest.DismissRecommendationOperation;
import com.google.ads.googleads.v2.services.DismissRecommendationResponse;
import com.google.ads.googleads.v2.services.DismissRecommendationResponse.DismissRecommendationResult;
import com.google.ads.googleads.v2.services.RecommendationServiceClient;
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;
    try {
      googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
    } catch (FileNotFoundException fnfe) {
      System.err.printf(
          "Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
      return;
    } catch (IOException ioe) {
      System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
      return;
    }

    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);
      }
    }
  }

  /**
   * 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 Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V2.Errors;
using Google.Ads.GoogleAds.V2.Services;

using System;
using static Google.Ads.GoogleAds.V2.Services.DismissRecommendationRequest.Types;
using static Google.Ads.GoogleAds.V2.Services.DismissRecommendationResponse.Types;

namespace Google.Ads.GoogleAds.Examples.V2
{
    /// <summary>
    /// This code example dismisses a given recommendation. To retrieve recommendations for text
    /// ads, run GetTextAdRecommendations.cs.
    /// </summary>
    public class DismissRecommendation : ExampleBase
    {
        /// <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)
        {
            DismissRecommendation codeExample = new DismissRecommendation();
            Console.WriteLine(codeExample.Description);

            // The customer ID for which the call is made.
            int customerId = int.Parse("INSERT_CUSTOMER_ID_HERE");

            // ID of the recommendation to be dismissed.
            int recommendationId = int.Parse("INSERT_RECOMMENDATION_ID_HERE");

            codeExample.Run(new GoogleAdsClient(), customerId, recommendationId);
        }

        /// <summary>
        /// Returns a description about the code example.
        /// </summary>
        public override string Description
        {
            get
            {
                return "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.V2.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}");
            }
        }
    }
}
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\V2\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V2\ResourceNames;
use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V2\Resources\Recommendation;
use Google\Ads\GoogleAds\V2\Services\DismissRecommendationRequest\DismissRecommendationOperation;
use Google\ApiCore\ApiException;

/**
 * This example dismisses a given recommendation. To retrieve recommendations for text ads,
 * run GetTextAdRecommendations.php.
 */
class DismissRecommendation
{
    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>`.
    // An example can be retrieved from GetTextAdRecommendations.php
    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
                );
            }
        } catch (ApiException $apiException) {
            printf(
                "ApiException was thrown with message '%s'.%s",
                $apiException->getMessage(),
                PHP_EOL
            );
        }
    }

    /**
     * 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(
            $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.
"""

from __future__ import absolute_import

import argparse
import six
import sys

import google.ads.google_ads.client


def main(client, customer_id, recommendation_id):
    recommendation_service = client.get_service('RecommendationService')

    dismiss_recommendation_request = client.get_type(
        'DismissRecommendationRequest')

    dismiss_recommendation_operation = (dismiss_recommendation_request.
                                        DismissRecommendationOperation())

    dismiss_recommendation_operation.resource_name = (
        recommendation_service.recommendation_path(
            customer_id, recommendation_id))

    try:
        dismissal_response = recommendation_service.dismiss_recommendation(
            customer_id,
            [dismiss_recommendation_operation])
    except google.ads.google_ads.errors.GoogleAdsException as ex:
        print('Request with ID "%s" failed with status "%s" and includes the '
              'following errors:' % (ex.request_id, ex.error.code().name))
        for error in ex.failure.errors:
            print('\tError with message "%s".' % error.message)
            if error.location:
                for field_path_element in error.location.field_path_elements:
                    print('\t\tOn field: %s' % field_path_element.field_name)
        sys.exit(1)

    print('Dismissed recommendation with resource name: "%s".'
          % dismissal_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.
    google_ads_client = (google.ads.google_ads.client.GoogleAdsClient
                         .load_from_storage())

    parser = 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=six.text_type,
                        required=True, help='The Google Ads customer ID.')
    parser.add_argument('-r', '--recommendation_id', type=six.text_type,
                        required=True, help='The recommendation ID.')
    args = parser.parse_args()

    main(google_ads_client, args.customer_id, args.recommendation_id)
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,
    [dismiss_recommendation_operation]
  )
  dismissed_recommendation = response.results.first

  puts "Dismissed recommendation with resource name: " +
      "#{dismissed_recommendation.resource_name}"
end

if __FILE__ == $0
  PAGE_SIZE = 1000

  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("\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
  rescue Google::Gax::RetryError => e
    STDERR.printf("Error: '%s'\n\tCause: '%s'\n\tCode: %d\n\tDetails: '%s'\n" \
        "\tRequest-Id: '%s'\n", e.message, e.cause.message, e.cause.code,
                  e.cause.details, e.cause.metadata['request-id'])
  end
end