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.merchantCenterLinks.mutate

Updates status or removes a Merchant Center link.

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

HTTP request

POST https://googleads.googleapis.com/v7/customers/{customerId}/merchantCenterLinks:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer being modified.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (MerchantCenterLinkOperation)
  },
  "validateOnly": boolean
}
Fields
operation

object (MerchantCenterLinkOperation)

Required. The operation to perform on the link

validateOnly

boolean

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

Response body

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

Response message for Merchant Center link mutate.

JSON representation
{
  "result": {
    object (MutateMerchantCenterLinkResult)
  }
}
Fields
result

object (MutateMerchantCenterLinkResult)

Result for the mutate.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

MerchantCenterLinkOperation

A single update on a Merchant Center link.

JSON representation
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "update": {
    object (MerchantCenterLink)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Fields
updateMask

string (FieldMask format)

FieldMask that determines which resource fields are modified in an update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Union field operation. The operation to perform operation can be only one of the following:
update

object (MerchantCenterLink)

Update operation: The merchant center link is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed merchant center link is expected, in this format:

customers/{customerId}/merchantCenterLinks/{merchant_center_id}

MutateMerchantCenterLinkResult

The result for the Merchant Center link mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.