DeleteUser 服务操作 - 客户管理
删除 user。
注意
只有具有超级管理员凭据的用户才能删除用户。 有关详细信息,请参阅 用户角色 技术指南。
由于删除操作需要最近用户写入操作的时间戳,因此必须首先调用 GetUser 操作。 GetUser 操作返回用户的数据,其中包括时间戳。 如果使用旧的时间戳,则删除调用将失败,例如,用户数据在获取时间戳后由应用程序或其他应用程序更新。
不能删除任何帐户的主要用户。 在删除主用户之前,请将每个帐户的 PrimaryUserId 元素设置为其他用户。
请求元素
DeleteUserRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
时间戳 | 操作用于协调更新的时间戳值。 必须调用 GetUser 才能获取时间戳值。 如果用户对象的时间戳值与传递的时间戳值不同,则删除操作将失败。 | base64Binary |
UserID | 要删除的用户的标识符。 | long |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
DeleteUserResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
操作的响应正文中没有任何元素。
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 SOAP
此模板由一个工具生成,用于显示 SOAP 请求的正文和标头元素的顺序。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
<Action mustUnderstand="1">DeleteUser</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<DeleteUserRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<UserId>ValueHere</UserId>
<TimeStamp i:nil="false">ValueHere</TimeStamp>
</DeleteUserRequest>
</s:Body>
</s:Envelope>
响应 SOAP
此模板由一个工具生成,用于显示 SOAP 响应的 正文 和 标头 元素的顺序。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<DeleteUserResponse xmlns="https://bingads.microsoft.com/Customer/v13" />
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<DeleteUserResponse> DeleteUserAsync(
long userId,
base64Binary timeStamp)
{
var request = new DeleteUserRequest
{
UserId = userId,
TimeStamp = timeStamp
};
return (await CustomerManagementService.CallAsync((s, r) => s.DeleteUserAsync(r), request));
}
static DeleteUserResponse deleteUser(
java.lang.Long userId,
byte[] timeStamp) throws RemoteException, Exception
{
DeleteUserRequest request = new DeleteUserRequest();
request.setUserId(userId);
request.setTimeStamp(timeStamp);
return CustomerManagementService.getService().deleteUser(request);
}
static function DeleteUser(
$userId,
$timeStamp)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new DeleteUserRequest();
$request->UserId = $userId;
$request->TimeStamp = $timeStamp;
return $GLOBALS['CustomerManagementProxy']->GetService()->DeleteUser($request);
}
response=customermanagement_service.DeleteUser(
UserId=UserId,
TimeStamp=TimeStamp)
要求
服务: CustomerManagementService.svc v13
命名空间: https://bingads.microsoft.com/Customer/v13
请求 URL
请求元素
DeleteUserRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
时间戳 | 操作用于协调更新的时间戳值。 必须调用 GetUser 才能获取时间戳值。 如果用户对象的时间戳值与传递的时间戳值不同,则删除操作将失败。 | base64Binary |
UserID | 要删除的用户的标识符。 | long |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
DeleteUserResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
操作的响应正文中没有任何元素。
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"UserId": "LongValueHere",
"TimeStamp": "ValueHere"
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
{}
代码语法
若要通过 SDK 调用 REST API,需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<DeleteUserResponse> DeleteUserAsync(
long userId,
base64Binary timeStamp)
{
var request = new DeleteUserRequest
{
UserId = userId,
TimeStamp = timeStamp
};
return (await CustomerManagementService.CallAsync((s, r) => s.DeleteUserAsync(r), request));
}
static DeleteUserResponse deleteUser(
java.lang.Long userId,
byte[] timeStamp) throws RemoteException, Exception
{
DeleteUserRequest request = new DeleteUserRequest();
request.setUserId(userId);
request.setTimeStamp(timeStamp);
return CustomerManagementService.getService().deleteUser(request);
}
static function DeleteUser(
$userId,
$timeStamp)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new DeleteUserRequest();
$request->UserId = $userId;
$request->TimeStamp = $timeStamp;
return $GLOBALS['CustomerManagementProxy']->GetService()->DeleteUser($request);
}
response=customermanagement_service.DeleteUser(
UserId=UserId,
TimeStamp=TimeStamp)