SearchClientLinks 服务操作 - 客户管理
搜索当前经过身份验证的用户的客户端链接，并按搜索条件进行筛选。 该操作返回代理客户和客户帐户的每个唯一组合的最新链接。
注意
只有具有超级管理员或Standard凭据的用户才能添加、更新和搜索指向广告客户帐户的客户端链接。 只有具有超级管理员凭据的用户才能添加、更新和搜索指向客户的客户端链接。 有关详细信息，请参阅 用户角色 技术指南。
如果你的用户位于具有代理机构管理的一个或多个帐户的客户客户中，则可以一次搜索一个帐户，查找已或有资格链接的个人帐户。 若要按个人帐户搜索，请将谓词字段设置为 ClientAccountId，并将谓词值设置为要查找的帐户标识符。
提示
有关客户端链接生命周期的详细信息，请参阅 帐户层次结构 技术指南。 有关成为代理机构的详细信息，请参阅 代理合作伙伴的资源。 有关客户角度的详细信息，请参阅 如何让代理管理Microsoft广告帐户。
请求元素
SearchClientLinksRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明，否则需要所有请求元素。
请求正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| 订购 | 确定结果的顺序。 此请求元素是可选的。 如果指定，则只应在列表中包括一个 OrderBy 元素。 其他元素不受支持，服务将忽略。 对于此服务操作，OrderBy 对象的 Field 元素支持以下值。 Id - 顺序由返回的 ClientLink 的 ClientAccountId 元素决定。 名称 - 顺序由返回的 ClientLink 的 Name 元素决定。 Number - 顺序由返回的 ClientLink 的 ManagingCustomerNumber 元素决定。 |
OrderBy 数组 |
| PageInfo | 确定每页结果的索引和大小。 | 分页 |
| 谓词 | 确定返回客户端链接必须满足的条件。 必须包含一个或两个谓词。 有关如何为每个受支持的谓词 字段 值确定结果的详细信息，请参阅 谓词备注。 |
谓词 数组 |
请求标头元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| AuthenticationToken | OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。 |
string |
| DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。 |
string |
| Password | 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
| UserName | 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
SearchClientLinksResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| ClientLinks | 客户端链接邀请列表。 | ClientLink 数组 |
响应标头元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| 跟踪 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">SearchClientLinks</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchClientLinksRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Predicates xmlns:e67="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e67:Predicate>
<e67:Field i:nil="false">ValueHere</e67:Field>
<e67:Operator>ValueHere</e67:Operator>
<e67:Value i:nil="false">ValueHere</e67:Value>
</e67:Predicate>
</Predicates>
<Ordering xmlns:e68="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e68:OrderBy>
<e68:Field>ValueHere</e68:Field>
<e68:Order>ValueHere</e68:Order>
</e68:OrderBy>
</Ordering>
<PageInfo xmlns:e69="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e69:Index>ValueHere</e69:Index>
<e69:Size>ValueHere</e69:Size>
</PageInfo>
</SearchClientLinksRequest>
</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>
<SearchClientLinksResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<ClientLinks xmlns:e70="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e70:ClientLink>
<e70:Type d4p1:nil="false">ValueHere</e70:Type>
<e70:ClientEntityId d4p1:nil="false">ValueHere</e70:ClientEntityId>
<e70:ClientEntityNumber d4p1:nil="false">ValueHere</e70:ClientEntityNumber>
<e70:ClientEntityName d4p1:nil="false">ValueHere</e70:ClientEntityName>
<e70:ManagingCustomerId d4p1:nil="false">ValueHere</e70:ManagingCustomerId>
<e70:ManagingCustomerNumber d4p1:nil="false">ValueHere</e70:ManagingCustomerNumber>
<e70:ManagingCustomerName d4p1:nil="false">ValueHere</e70:ManagingCustomerName>
<e70:Note d4p1:nil="false">ValueHere</e70:Note>
<e70:Name d4p1:nil="false">ValueHere</e70:Name>
<e70:InviterEmail d4p1:nil="false">ValueHere</e70:InviterEmail>
<e70:InviterName d4p1:nil="false">ValueHere</e70:InviterName>
<e70:InviterPhone d4p1:nil="false">ValueHere</e70:InviterPhone>
<e70:IsBillToClient d4p1:nil="false">ValueHere</e70:IsBillToClient>
<e70:StartDate d4p1:nil="false">ValueHere</e70:StartDate>
<e70:Status d4p1:nil="false">ValueHere</e70:Status>
<e70:SuppressNotification>ValueHere</e70:SuppressNotification>
<e70:LastModifiedDateTime>ValueHere</e70:LastModifiedDateTime>
<e70:LastModifiedByUserId>ValueHere</e70:LastModifiedByUserId>
<e70:Timestamp d4p1:nil="false">ValueHere</e70:Timestamp>
<e70:ForwardCompatibilityMap xmlns:e71="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e71:KeyValuePairOfstringstring>
<e71:key d4p1:nil="false">ValueHere</e71:key>
<e71:value d4p1:nil="false">ValueHere</e71:value>
</e71:KeyValuePairOfstringstring>
</e70:ForwardCompatibilityMap>
<e70:CustomerLinkPermission d4p1:nil="false">ValueHere</e70:CustomerLinkPermission>
</e70:ClientLink>
</ClientLinks>
</SearchClientLinksResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。
public async Task<SearchClientLinksResponse> SearchClientLinksAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo)
{
var request = new SearchClientLinksRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchClientLinksAsync(r), request));
}
static SearchClientLinksResponse searchClientLinks(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo) throws RemoteException, Exception
{
SearchClientLinksRequest request = new SearchClientLinksRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
return CustomerManagementService.getService().searchClientLinks(request);
}
static function SearchClientLinks(
$predicates,
$ordering,
$pageInfo)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchClientLinksRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchClientLinks($request);
}
response=customermanagement_service.SearchClientLinks(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo)
要求
服务： CustomerManagementService.svc v13
命名空间： https://bingads.microsoft.com/Customer/v13
请求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/ClientLinks/Search
请求元素
SearchClientLinksRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明，否则需要所有请求元素。
请求正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| 订购 | 确定结果的顺序。 此请求元素是可选的。 如果指定，则只应在列表中包括一个 OrderBy 元素。 其他元素不受支持，服务将忽略。 对于此服务操作，OrderBy 对象的 Field 元素支持以下值。 Id - 顺序由返回的 ClientLink 的 ClientAccountId 元素决定。 名称 - 顺序由返回的 ClientLink 的 Name 元素决定。 Number - 顺序由返回的 ClientLink 的 ManagingCustomerNumber 元素决定。 |
OrderBy 数组 |
| PageInfo | 确定每页结果的索引和大小。 | 分页 |
| 谓词 | 确定返回客户端链接必须满足的条件。 必须包含一个或两个谓词。 有关如何为每个受支持的谓词 字段 值确定结果的详细信息，请参阅 谓词备注。 |
谓词 数组 |
请求标头元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| Authorization | OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。 |
string |
| DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。 |
string |
| Password | 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
| UserName | 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
SearchClientLinksResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| ClientLinks | 客户端链接邀请列表。 | ClientLink 数组 |
响应标头元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| 跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
}
}
响应 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"
}
]
}
代码语法
若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。
public async Task<SearchClientLinksResponse> SearchClientLinksAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo)
{
var request = new SearchClientLinksRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchClientLinksAsync(r), request));
}
static SearchClientLinksResponse searchClientLinks(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo) throws RemoteException, Exception
{
SearchClientLinksRequest request = new SearchClientLinksRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
return CustomerManagementService.getService().searchClientLinks(request);
}
static function SearchClientLinks(
$predicates,
$ordering,
$pageInfo)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchClientLinksRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchClientLinks($request);
}
response=customermanagement_service.SearchClientLinks(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo)