Opération de service SearchClientLinks - Gestion des clients
Recherche les liens client pour le client de l’utilisateur authentifié actuel, filtrés par les critères de recherche. L’opération retourne le lien le plus récent pour chaque combinaison unique de client d’agence et de compte client.
Notes
Seul un utilisateur disposant d’informations d’identification Super Administrateur ou Standard peut ajouter, mettre à jour et rechercher des liens client vers des comptes d’annonceur. Seul un utilisateur disposant d’informations d’identification de super administrateur peut ajouter, mettre à jour et rechercher des liens client vers des clients. Pour plus d’informations, consultez le guide technique rôles d’utilisateur .
Si votre utilisateur se trouve au sein d’un client qui a un ou plusieurs comptes gérés par une agence, vous pouvez rechercher un à la fois des comptes individuels qui étaient ou sont éligibles pour être liés. Pour effectuer une recherche par compte individuel, définissez le champ de prédicat sur ClientAccountId et définissez la valeur du prédicat sur l’identificateur de compte que vous souhaitez rechercher.
Conseil
Pour plus d’informations sur le cycle de vie des liaisons clientes, consultez le guide technique de la hiérarchie des comptes. Pour plus d’informations sur la façon de devenir une agence, consultez ressources pour les partenaires de l’agence. Pour plus d’informations du point de vue d’un client, consultez Guide pratique pour qu’une agence gère votre compte Microsoft Advertising.
Éléments de demande
L’objet SearchClientLinksRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Notes
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
Élément | Description | Type de données |
---|---|---|
Classement | Détermine l’ordre des résultats. Cet élément de requête est facultatif. Si cette option est spécifiée, vous ne devez inclure qu’un seul élément OrderBy dans la liste. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service. Pour cette opération de service, les valeurs suivantes sont prises en charge dans l’élément Field d’un objet OrderBy . ID : l’ordre est déterminé par l’élément ClientAccountId du ClientLink retourné. Name : l’ordre est déterminé par l’élément Name du ClientLink retourné. Number : l’ordre est déterminé par l’élément ManagingCustomerNumber du ClientLink retourné. |
Tableau OrderBy |
PageInfo | Détermine l’index et la taille des résultats par page. | Pagination |
Prédicats | Détermine les conditions qui doivent être remplies pour retourner des liens clients. Vous devez inclure un ou deux prédicats. Pour plus d’informations sur la façon dont les résultats sont déterminés pour chaque valeur de champ de prédicat prise en charge, consultez Remarques sur le prédicat. |
Tableau de prédicats |
Éléments d’en-tête de requête
Élément | Description | Type de données |
---|---|---|
AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet SearchClientLinksResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
Élément | Description | Type de données |
---|---|---|
ClientLinks | Liste des invitations de lien client. | Tableau ClientLink |
Éléments d’en-tête de réponse
Élément | Description | Type de données |
---|---|---|
TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<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:e250="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e250:Predicate>
<e250:Field i:nil="false">ValueHere</e250:Field>
<e250:Operator>ValueHere</e250:Operator>
<e250:Value i:nil="false">ValueHere</e250:Value>
</e250:Predicate>
</Predicates>
<Ordering xmlns:e251="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e251:OrderBy>
<e251:Field>ValueHere</e251:Field>
<e251:Order>ValueHere</e251:Order>
</e251:OrderBy>
</Ordering>
<PageInfo xmlns:e252="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e252:Index>ValueHere</e252:Index>
<e252:Size>ValueHere</e252:Size>
</PageInfo>
</SearchClientLinksRequest>
</s:Body>
</s:Envelope>
Soap de réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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:e253="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e253:ClientLink>
<e253:Type d4p1:nil="false">ValueHere</e253:Type>
<e253:ClientEntityId d4p1:nil="false">ValueHere</e253:ClientEntityId>
<e253:ClientEntityNumber d4p1:nil="false">ValueHere</e253:ClientEntityNumber>
<e253:ClientEntityName d4p1:nil="false">ValueHere</e253:ClientEntityName>
<e253:ManagingCustomerId d4p1:nil="false">ValueHere</e253:ManagingCustomerId>
<e253:ManagingCustomerNumber d4p1:nil="false">ValueHere</e253:ManagingCustomerNumber>
<e253:ManagingCustomerName d4p1:nil="false">ValueHere</e253:ManagingCustomerName>
<e253:Note d4p1:nil="false">ValueHere</e253:Note>
<e253:Name d4p1:nil="false">ValueHere</e253:Name>
<e253:InviterEmail d4p1:nil="false">ValueHere</e253:InviterEmail>
<e253:InviterName d4p1:nil="false">ValueHere</e253:InviterName>
<e253:InviterPhone d4p1:nil="false">ValueHere</e253:InviterPhone>
<e253:IsBillToClient d4p1:nil="false">ValueHere</e253:IsBillToClient>
<e253:StartDate d4p1:nil="false">ValueHere</e253:StartDate>
<e253:Status d4p1:nil="false">ValueHere</e253:Status>
<e253:SuppressNotification>ValueHere</e253:SuppressNotification>
<e253:LastModifiedDateTime>ValueHere</e253:LastModifiedDateTime>
<e253:LastModifiedByUserId>ValueHere</e253:LastModifiedByUserId>
<e253:Timestamp d4p1:nil="false">ValueHere</e253:Timestamp>
<e253:ForwardCompatibilityMap xmlns:e254="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e254:KeyValuePairOfstringstring>
<e254:key d4p1:nil="false">ValueHere</e254:key>
<e254:value d4p1:nil="false">ValueHere</e254:value>
</e254:KeyValuePairOfstringstring>
</e253:ForwardCompatibilityMap>
<e253:CustomerLinkPermission d4p1:nil="false">ValueHere</e253:CustomerLinkPermission>
</e253:ClientLink>
</ClientLinks>
</SearchClientLinksResponse>
</s:Body>
</s:Envelope>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
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)
Configuration requise
Service : CustomerManagementService.svc v13
Espace de noms: https://bingads.microsoft.com/Customer/v13