Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.recommendations.dismiss

Dismisses given recommendations.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RecommendationError RequestError

HTTP request

POST https://googleads.googleapis.com/v7/customers/{customerId}/recommendations:dismiss

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer with the recommendation.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operations": [
    {
      object (DismissRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Fields
operations[]

object (DismissRecommendationOperation)

Required. The list of operations to dismiss recommendations. If partialFailure=false all recommendations should be of the same type There is a limit of 100 operations per request.

partialFailure

boolean

If true, successful operations will be carried out and invalid operations will return errors. If false, operations will be carried in a single transaction if and only if they are all valid. Default is false.

Response body

If successful, the response body contains data with the following structure:

Response message for RecommendationService.DismissRecommendation.

JSON representation
{
  "results": [
    {
      object (DismissRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Fields
results[]

object (DismissRecommendationResult)

Results of operations to dismiss recommendations.

partialFailureError

object (Status)

Errors that pertain to operation failures in the partial failure mode. Returned only when partialFailure = true and all errors occur inside the operations. If any errors occur outside the operations (e.g. auth errors) we return the RPC level error.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DismissRecommendationOperation

Operation to dismiss a single recommendation identified by resourceName.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

The resource name of the recommendation to dismiss.

DismissRecommendationResult

The result of dismissing a recommendation.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful dismissals.