SearchClientLinks 服務作業 - 客戶管理

搜尋目前已驗證使用者的客戶端連結，並依搜尋準則進行篩選。 此作業會針對代理程式客戶和客戶端帳戶的每個唯一組合，傳回最新的連結。

注意事項

只有具有超級 管理員 或 Standard 認證的使用者可以新增、更新及搜尋廣告客戶帳戶的客戶連結。 只有具有超級 管理員 認證的使用者可以新增、更新及搜尋客戶端連結。 如需詳細資訊，請參閱 使用者角色 技術指南。

如果您的用戶位於具有一或多個由代理商管理之帳戶的客戶端客戶內，則您可以一次搜尋一個帳戶，以尋找已或符合連結資格的個別帳戶。 若要依個別帳戶搜尋，請將述詞字段設定為 ClientAccountId，並將述詞值設定為您想要尋找的帳戶標識碼。

提示

如需客戶端連結生命週期的詳細資訊，請參閱 帳戶階層 技術指南。 如需成為機構的詳細資訊，請參閱 機構合作夥伴的資源。 如需客戶端觀點的詳細資訊，請參閱 如何讓機構管理您的 Microsoft Advertising 帳戶。

要求專案

SearchClientLinksRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
訂購	決定結果的順序。 此要求項目是選擇性的。 如果指定，您應該只在清單中包含一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。 針對此服務作業，OrderBy 物件的 Field 元素支援下列值。 標識碼 - 訂單取決於傳回之 ClientLink 的 ClientAccountId 元素。 名稱 - 順序取決於傳回之 ClientLink 的 Name 元素。 Number - 順序取決於傳回之 ClientLink 的 ManagingCustomerNumber 元素。	OrderBy 陣 列
PageInfo	決定每頁結果的索引和大小。	分頁
謂詞	決定必須符合才能傳回用戶端連結的條件。 您必須包含一或兩個述詞。 如需如何為每個支援的述詞 域 值決定結果的詳細資訊，請參閱 述詞備註。	述詞陣 語

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchClientLinksResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
ClientLinks	用戶端連結邀請的清單。	ClientLink 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 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:e523="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e523:Predicate>
          <e523:Field i:nil="false">ValueHere</e523:Field>
          <e523:Operator>ValueHere</e523:Operator>
          <e523:Value i:nil="false">ValueHere</e523:Value>
        </e523:Predicate>
      </Predicates>
      <Ordering xmlns:e524="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e524:OrderBy>
          <e524:Field>ValueHere</e524:Field>
          <e524:Order>ValueHere</e524:Order>
        </e524:OrderBy>
      </Ordering>
      <PageInfo xmlns:e525="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e525:Index>ValueHere</e525:Index>
        <e525:Size>ValueHere</e525: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:e526="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e526:ClientLink>
          <e526:Type d4p1:nil="false">ValueHere</e526:Type>
          <e526:ClientEntityId d4p1:nil="false">ValueHere</e526:ClientEntityId>
          <e526:ClientEntityNumber d4p1:nil="false">ValueHere</e526:ClientEntityNumber>
          <e526:ClientEntityName d4p1:nil="false">ValueHere</e526:ClientEntityName>
          <e526:ManagingCustomerId d4p1:nil="false">ValueHere</e526:ManagingCustomerId>
          <e526:ManagingCustomerNumber d4p1:nil="false">ValueHere</e526:ManagingCustomerNumber>
          <e526:ManagingCustomerName d4p1:nil="false">ValueHere</e526:ManagingCustomerName>
          <e526:Note d4p1:nil="false">ValueHere</e526:Note>
          <e526:Name d4p1:nil="false">ValueHere</e526:Name>
          <e526:InviterEmail d4p1:nil="false">ValueHere</e526:InviterEmail>
          <e526:InviterName d4p1:nil="false">ValueHere</e526:InviterName>
          <e526:InviterPhone d4p1:nil="false">ValueHere</e526:InviterPhone>
          <e526:IsBillToClient d4p1:nil="false">ValueHere</e526:IsBillToClient>
          <e526:StartDate d4p1:nil="false">ValueHere</e526:StartDate>
          <e526:Status d4p1:nil="false">ValueHere</e526:Status>
          <e526:SuppressNotification>ValueHere</e526:SuppressNotification>
          <e526:LastModifiedDateTime>ValueHere</e526:LastModifiedDateTime>
          <e526:LastModifiedByUserId>ValueHere</e526:LastModifiedByUserId>
          <e526:Timestamp d4p1:nil="false">ValueHere</e526:Timestamp>
          <e526:ForwardCompatibilityMap xmlns:e527="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e527:KeyValuePairOfstringstring>
              <e527:key d4p1:nil="false">ValueHere</e527:key>
              <e527:value d4p1:nil="false">ValueHere</e527:value>
            </e527:KeyValuePairOfstringstring>
          </e526:ForwardCompatibilityMap>
          <e526:CustomerLinkPermission d4p1:nil="false">ValueHere</e526:CustomerLinkPermission>
        </e526:ClientLink>
      </ClientLinks>
    </SearchClientLinksResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 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

生產URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/ClientLinks/Search

沙箱 URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/ClientLinks/Search

要求專案

SearchClientLinksRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
訂購	決定結果的順序。 此要求項目是選擇性的。 如果指定，您應該只在清單中包含一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。 針對此服務作業，OrderBy 物件的 Field 元素支援下列值。 標識碼 - 訂單取決於傳回之 ClientLink 的 ClientAccountId 元素。 名稱 - 順序取決於傳回之 ClientLink 的 Name 元素。 Number - 順序取決於傳回之 ClientLink 的 ManagingCustomerNumber 元素。	OrderBy 陣 列
PageInfo	決定每頁結果的索引和大小。	分頁
謂詞	決定必須符合才能傳回用戶端連結的條件。 您必須包含一或兩個述詞。 如需如何為每個支援的述詞 域 值決定結果的詳細資訊，請參閱 述詞備註。	述詞陣 語

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchClientLinksResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
ClientLinks	用戶端連結邀請的清單。	ClientLink 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 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 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 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)