Method: customers.recommendationSubscriptions.mutateRecommendationSubscription

Mutates given subscription with corresponding apply parameters.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

HTTP request

POST https://googleads.googleapis.com/v15/customers/{customerId}/recommendationSubscriptions:mutateRecommendationSubscription

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the subscribing customer.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operations": [
    {
      object (RecommendationSubscriptionOperation)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "responseContentType": enum (ResponseContentType)
}
Fields
operations[]

object (RecommendationSubscriptionOperation)

Required. The list of create or update operations.

partialFailure

boolean

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

validateOnly

boolean

If true, the request is validated but not executed. Only errors are returned, not results.

responseContentType

enum (ResponseContentType)

The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation. The mutable resource will only be returned if the resource has the appropriate response field. For example, MutateCampaignResult.campaign.

Response body

Response message for [RecommendationSubscriptionService.MutateRecommendationSubscription]

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

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

object (MutateRecommendationSubscriptionResult)

Results, one per operation.

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 (for example, 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.