SearchClientLinks Service Operation - Customer Management

This feature is not supported in sandbox.Searches for the client links for the customer of the current authenticated user, filtered by the search criteria. The operation returns the most recent link for each unique combination of agency customer and client account. For more information about the client link lifecycle, see Link to Client Accounts.

If your user is within a client customer that has one or more accounts managed by an agency, then you may search one at a time for individual accounts that were or are eligible to be linked. To search by individual account, set the predicate field to ClientAccountId and set the predicate value to the account identifier that you want to find.

The role of the user calling this operation must be Super Admin. For more information, see User Roles and Available Service Operations.

Request Elements

The SearchClientLinksRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Request Body Elements

Element Description Data Type
Ordering Determines the order of results.

If specified, you should only include one OrderBy element in the list. Additional elements are not supported and will be ignored by the service.

For this service operation, the following values are supported in the Field element of a OrderBy object.

Id - The order is determined by the ClientAccountId element of the returned ClientLink.

Name - The order is determined by the Name element of the returned ClientLink.

Number - The order is determined by the ManagingCustomerNumber element of the returned ClientLink.
OrderBy array
PageInfo Determines the index and size of results per page. Paging
Predicates Determines the request conditions. This operation's response will include client links that match all of the specified predicates.

You can specify either one or two predicates.

For a list of supported Field and Operator elements of a Predicate object for this service operation, see Predicate Remarks.
Predicate array

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts. string
DeveloperToken The developer token used to access the Bing Ads API. string
Password The Bing Ads managed user's sign-in password. string
UserName The Bing Ads managed user's sign-in name. You must not set this element to a Microsoft account or email address. string

Important

The UserName and Password header elements are deprecated. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account (email address) authentication. For more information, see Authentication with OAuth. UserName and Password are still required for Bing Ads managed credentials, but they are not applicable for Microsoft account authentication. To authenticate a Microsoft account, use the AuthenticationToken] header instead of UserName and Password.

Response Elements

The SearchClientLinksResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
ClientLinks The list of client link invitations. ClientLink array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

The following template shows the order of the body and header elements for the SOAP request.

<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/v12">
    <Action mustUnderstand="1">SearchClientLinks</Action>
    <ApplicationToken i:nil="false">ValueHere</ApplicationToken>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
    <Password i:nil="false">ValueHere</Password>
    <UserName i:nil="false">ValueHere</UserName>
  </s:Header>
  <s:Body>
    <SearchClientLinksRequest xmlns="https://bingads.microsoft.com/Customer/v12">
      <Predicates xmlns:e886="https://bingads.microsoft.com/Customer/v12/Entities" i:nil="false">
        <e886:Predicate>
          <e886:Field i:nil="false">ValueHere</e886:Field>
          <e886:Operator>ValueHere</e886:Operator>
          <e886:Value i:nil="false">ValueHere</e886:Value>
        </e886:Predicate>
      </Predicates>
      <Ordering xmlns:e887="https://bingads.microsoft.com/Customer/v12/Entities" i:nil="false">
        <e887:OrderBy>
          <e887:Field>ValueHere</e887:Field>
          <e887:Order>ValueHere</e887:Order>
        </e887:OrderBy>
      </Ordering>
      <PageInfo xmlns:e888="https://bingads.microsoft.com/Customer/v12/Entities" i:nil="false">
        <e888:Index>ValueHere</e888:Index>
        <e888:Size>ValueHere</e888:Size>
      </PageInfo>
    </SearchClientLinksRequest>
  </s:Body>
</s:Envelope>

Response SOAP

The following template shows the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v12">
    <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/v12">
      <ClientLinks xmlns:e889="https://bingads.microsoft.com/Customer/v12/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e889:ClientLink>
          <e889:ClientAccountId d4p1:nil="false">ValueHere</e889:ClientAccountId>
          <e889:ClientAccountNumber d4p1:nil="false">ValueHere</e889:ClientAccountNumber>
          <e889:ManagingCustomerId d4p1:nil="false">ValueHere</e889:ManagingCustomerId>
          <e889:ManagingCustomerNumber d4p1:nil="false">ValueHere</e889:ManagingCustomerNumber>
          <e889:Note d4p1:nil="false">ValueHere</e889:Note>
          <e889:Name d4p1:nil="false">ValueHere</e889:Name>
          <e889:InviterEmail d4p1:nil="false">ValueHere</e889:InviterEmail>
          <e889:InviterName d4p1:nil="false">ValueHere</e889:InviterName>
          <e889:InviterPhone d4p1:nil="false">ValueHere</e889:InviterPhone>
          <e889:IsBillToClient>ValueHere</e889:IsBillToClient>
          <e889:StartDate d4p1:nil="false">ValueHere</e889:StartDate>
          <e889:Status d4p1:nil="false">ValueHere</e889:Status>
          <e889:SuppressNotification>ValueHere</e889:SuppressNotification>
          <e889:LastModifiedDateTime>ValueHere</e889:LastModifiedDateTime>
          <e889:LastModifiedByUserId>ValueHere</e889:LastModifiedByUserId>
          <e889:Timestamp d4p1:nil="false">ValueHere</e889:Timestamp>
          <ForwardCompatibilityMap xmlns:e890="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e890:KeyValuePairOfstringstring>
              <e890:key d4p1:nil="false">ValueHere</e890:key>
              <e890:value d4p1:nil="false">ValueHere</e890:value>
            </e890:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
        </e889:ClientLink>
      </ClientLinks>
    </SearchClientLinksResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads Code Examples for more examples.

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)

Requirements

Service: CustomerManagementService.svc v12
Namespace: https://bingads.microsoft.com/Customer/v12