Method: customers.userListCustomerTypes.mutate

附加或移除用户名单客户类型。返回操作状态。

抛出的错误的列表:AuthenticationError AuthorizationError UserListCustomerTypeError HeaderError InternalError QuotaError RequestError

HTTP 请求

POST https://googleads.googleapis.com/v17/customers/{customerId}/userListCustomerTypes:mutate

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

必需。要修改其用户名单客户类型的客户的 ID。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "operations": [
    {
      object (UserListCustomerTypeOperation)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean
}
字段
operations[]

object (UserListCustomerTypeOperation)

必需。要对用户列表客户类型执行的操作的列表。

partialFailure

boolean

可选。如果值为 true,则系统将执行成功的操作,而无效操作将返回错误。如果为 false,当且仅当所有操作都有效时,所有操作才会在一个事务中执行。默认值为 false。

validateOnly

boolean

可选。如果为 true,则系统会验证该请求,但不会执行该请求。仅返回错误,不返回结果。

响应正文

用户名单客户类型转变的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (MutateUserListCustomerTypeResult)
    }
  ]
}
字段
partialFailureError

object (Status)

与部分失败模式下的操作失败相关的错误。仅当 partialFailure = true 并且所有错误都发生在操作内部时,系统才会返回。如果在操作之外发生任何错误(例如,身份验证错误),我们将返回 RPC 级别的错误。

results[]

object (MutateUserListCustomerTypeResult)

该转变的所有结果。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 OAuth 2.0 概览

UserListCustomerTypeOperation

针对用户列表客户类型的单个转变操作。

JSON 表示法
{

  // Union field operation can be only one of the following:
  "create": {
    object (UserListCustomerType)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
字段
联合字段 operation。Mutate 操作。operation 只能是下列其中一项:
create

object (UserListCustomerType)

将用户列表客户类型附加到用户列表。新用户名单客户类型不需要使用资源名称。

remove

string

请移除一个现有用户名单的客户类型。已移除的用户名单客户类型的资源名称应采用如下格式:

customers/{customerId}/userListCustomerTypes/{userListId}~{customerTypeCategory}

MutateUserListCustomerTypeResult

用户名单客户类型转变的结果。

JSON 表示法
{
  "resourceName": string
}
字段
resourceName

string

操作成功时返回。