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

Creates or updates a customer client link. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError FieldMaskError HeaderError InternalError ManagerLinkError MutateError NewResourceCreationError QuotaError RequestError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose customer link are being modified.

Request body

The request body contains data with the following structure:

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

object (CustomerClientLinkOperation)

Required. The operation to perform on the individual CustomerClientLink.

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 a CustomerClientLink mutate.

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

object (MutateCustomerClientLinkResult)

A result that identifies the resource affected by the mutate request.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

CustomerClientLinkOperation

A single operation (create, update) on a CustomerClientLink.

JSON representation
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "create": {
    object (CustomerClientLink)
  },
  "update": {
    object (CustomerClientLink)
  }
  // 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 mutate operation. operation can be only one of the following:
create

object (CustomerClientLink)

Create operation: No resource name is expected for the new link.

update

object (CustomerClientLink)

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

MutateCustomerClientLinkResult

The result for a single customer client link mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.