UpdateClientLinks 服务操作 - 客户管理
汇报指定客户端链接的状态。
注意
只有具有超级管理员或Standard凭据的用户才能添加、更新和搜索指向广告客户帐户的客户端链接。 只有具有超级管理员凭据的用户才能添加、更新和搜索指向客户的客户端链接。 有关详细信息,请参阅 用户角色 技术指南。
如果你的用户在代理机构内,则操作可用于更新你管理或已邀请管理的任何帐户的客户端链接状态。
如果你的用户在一个客户客户中,该客户客户有一个或多个帐户托管或邀请由代理管理,则你只能使用此操作将状态更新为 LinkAccepted 或 LinkDeclined。 客户端还可以通过Microsoft广告 Web 应用程序接受或拒绝链接请求。
提示
有关客户端链接生命周期的详细信息,请参阅 帐户层次结构 技术指南。 有关成为代理机构的详细信息,请参阅 代理合作伙伴的资源。 有关客户角度的详细信息,请参阅 如何让代理管理Microsoft广告帐户。
请求元素
UpdateClientLinksRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
ClientLinks | 要更新的客户端链接列表。 应将请求限制为每次调用 10 个客户端链接。 |
ClientLink 数组 |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
UpdateClientLinksResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
OperationErrors | 列出服务操作失败的一个或多个原因,并且未添加客户端链接。 | OperationError 数组 |
PartialErrors |
OperationError 列表的数组,其中包含未成功添加的任何客户端链接的详细信息。 结果以与所请求的客户端链接对应的相同顺序返回。 第一个维度列表元素的数目等于请求的客户端链接计数。 对于成功添加的客户端链接,位于相应索引处的 OperationError 元素为 null。 |
OperationError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 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">UpdateClientLinks</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<UpdateClientLinksRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<ClientLinks xmlns:e121="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e121:ClientLink>
<e121:Type i:nil="false">ValueHere</e121:Type>
<e121:ClientEntityId i:nil="false">ValueHere</e121:ClientEntityId>
<e121:ClientEntityNumber i:nil="false">ValueHere</e121:ClientEntityNumber>
<e121:ClientEntityName i:nil="false">ValueHere</e121:ClientEntityName>
<e121:ManagingCustomerId i:nil="false">ValueHere</e121:ManagingCustomerId>
<e121:ManagingCustomerNumber i:nil="false">ValueHere</e121:ManagingCustomerNumber>
<e121:ManagingCustomerName i:nil="false">ValueHere</e121:ManagingCustomerName>
<e121:Note i:nil="false">ValueHere</e121:Note>
<e121:Name i:nil="false">ValueHere</e121:Name>
<e121:InviterEmail i:nil="false">ValueHere</e121:InviterEmail>
<e121:InviterName i:nil="false">ValueHere</e121:InviterName>
<e121:InviterPhone i:nil="false">ValueHere</e121:InviterPhone>
<e121:IsBillToClient i:nil="false">ValueHere</e121:IsBillToClient>
<e121:StartDate i:nil="false">ValueHere</e121:StartDate>
<e121:Status i:nil="false">ValueHere</e121:Status>
<e121:SuppressNotification>ValueHere</e121:SuppressNotification>
<e121:LastModifiedDateTime>ValueHere</e121:LastModifiedDateTime>
<e121:LastModifiedByUserId>ValueHere</e121:LastModifiedByUserId>
<e121:Timestamp i:nil="false">ValueHere</e121:Timestamp>
<e121:ForwardCompatibilityMap xmlns:e122="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e122:KeyValuePairOfstringstring>
<e122:key i:nil="false">ValueHere</e122:key>
<e122:value i:nil="false">ValueHere</e122:value>
</e122:KeyValuePairOfstringstring>
</e121:ForwardCompatibilityMap>
<e121:CustomerLinkPermission i:nil="false">ValueHere</e121:CustomerLinkPermission>
</e121:ClientLink>
</ClientLinks>
</UpdateClientLinksRequest>
</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>
<UpdateClientLinksResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<OperationErrors xmlns:e123="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e123:OperationError>
<e123:Code>ValueHere</e123:Code>
<e123:Details d4p1:nil="false">ValueHere</e123:Details>
<e123:Message d4p1:nil="false">ValueHere</e123:Message>
</e123:OperationError>
</OperationErrors>
<PartialErrors xmlns:e124="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e124:ArrayOfOperationError>
<e124:OperationError>
<e124:Code>ValueHere</e124:Code>
<e124:Details d4p1:nil="false">ValueHere</e124:Details>
<e124:Message d4p1:nil="false">ValueHere</e124:Message>
</e124:OperationError>
</e124:ArrayOfOperationError>
</PartialErrors>
</UpdateClientLinksResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<UpdateClientLinksResponse> UpdateClientLinksAsync(
IList<ClientLink> clientLinks)
{
var request = new UpdateClientLinksRequest
{
ClientLinks = clientLinks
};
return (await CustomerManagementService.CallAsync((s, r) => s.UpdateClientLinksAsync(r), request));
}
static UpdateClientLinksResponse updateClientLinks(
ArrayOfClientLink clientLinks) throws RemoteException, Exception
{
UpdateClientLinksRequest request = new UpdateClientLinksRequest();
request.setClientLinks(clientLinks);
return CustomerManagementService.getService().updateClientLinks(request);
}
static function UpdateClientLinks(
$clientLinks)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new UpdateClientLinksRequest();
$request->ClientLinks = $clientLinks;
return $GLOBALS['CustomerManagementProxy']->GetService()->UpdateClientLinks($request);
}
response=customermanagement_service.UpdateClientLinks(
ClientLinks=ClientLinks)
要求
服务: CustomerManagementService.svc v13
命名空间: https://bingads.microsoft.com/Customer/v13
请求 URL
请求元素
UpdateClientLinksRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
ClientLinks | 要更新的客户端链接列表。 应将请求限制为每次调用 10 个客户端链接。 |
ClientLink 数组 |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
UpdateClientLinksResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
OperationErrors | 列出服务操作失败的一个或多个原因,并且未添加客户端链接。 | OperationError 数组 |
PartialErrors |
OperationError 列表的数组,其中包含未成功添加的任何客户端链接的详细信息。 结果以与所请求的客户端链接对应的相同顺序返回。 第一个维度列表元素的数目等于请求的客户端链接计数。 对于成功添加的客户端链接,位于相应索引处的 OperationError 元素为 null。 |
OperationError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"ClientLinks": [
{
"ClientEntityId": "LongValueHere",
"ClientEntityName": "ValueHere",
"ClientEntityNumber": "ValueHere",
"CustomerLinkPermission": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"InviterEmail": "ValueHere",
"InviterName": "ValueHere",
"InviterPhone": "ValueHere",
"IsBillToClient": "ValueHere",
"LastModifiedByUserId": "LongValueHere",
"LastModifiedDateTime": "ValueHere",
"ManagingCustomerId": "LongValueHere",
"ManagingCustomerName": "ValueHere",
"ManagingCustomerNumber": "ValueHere",
"Name": "ValueHere",
"Note": "ValueHere",
"StartDate": "ValueHere",
"Status": "ValueHere",
"SuppressNotification": "ValueHere",
"Timestamp": "ValueHere",
"Type": "ValueHere"
}
]
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
{
"OperationErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"Message": "ValueHere"
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"Message": "ValueHere"
}
]
}
代码语法
若要通过 SDK 调用 REST API,需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<UpdateClientLinksResponse> UpdateClientLinksAsync(
IList<ClientLink> clientLinks)
{
var request = new UpdateClientLinksRequest
{
ClientLinks = clientLinks
};
return (await CustomerManagementService.CallAsync((s, r) => s.UpdateClientLinksAsync(r), request));
}
static UpdateClientLinksResponse updateClientLinks(
ArrayOfClientLink clientLinks) throws RemoteException, Exception
{
UpdateClientLinksRequest request = new UpdateClientLinksRequest();
request.setClientLinks(clientLinks);
return CustomerManagementService.getService().updateClientLinks(request);
}
static function UpdateClientLinks(
$clientLinks)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new UpdateClientLinksRequest();
$request->ClientLinks = $clientLinks;
return $GLOBALS['CustomerManagementProxy']->GetService()->UpdateClientLinks($request);
}
response=customermanagement_service.UpdateClientLinks(
ClientLinks=ClientLinks)