Operazione del servizio SearchClientLinks - Gestione clienti
Cerca i collegamenti client per il cliente dell'utente autenticato corrente, filtrato in base ai criteri di ricerca. L'operazione restituisce il collegamento più recente per ogni combinazione univoca di cliente dell'agenzia e account client.
Nota
Solo un utente con credenziali Super Amministrazione o Standard può aggiungere, aggiornare e cercare collegamenti client agli account degli inserzionisti. Solo un utente con credenziali Super Amministrazione può aggiungere, aggiornare e cercare collegamenti client ai clienti. Per altre informazioni, vedere la Guida tecnica per i ruoli utente .
Se l'utente si trova all'interno di un cliente client con uno o più account gestiti da un'agenzia, è possibile cercarne uno alla volta per individuare singoli account che erano o sono idonei per essere collegati. Per eseguire la ricerca per singolo account, impostare il campo predicato su ClientAccountId e impostare il valore del predicato sull'identificatore dell'account che si desidera trovare.
Consiglio
Per altre informazioni sul ciclo di vita dei collegamenti client, vedere la guida tecnica relativa alla gerarchia degli account . Per altre informazioni su come diventare un'agenzia, vedere Risorse per i partner dell'agenzia. Per altre informazioni dal punto di vista di un cliente, vedere Come fare in modo che un'agenzia gestisa l'account Microsoft Advertising.
Elementi della richiesta
L'oggetto SearchClientLinksRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.
Nota
Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.
Elementi del corpo della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| Ordinando | Determina l'ordine dei risultati. Questo elemento della richiesta è facoltativo. Se specificato, è necessario includere un solo elemento OrderBy nell'elenco. Gli elementi aggiuntivi non sono supportati e verranno ignorati dal servizio. Per questa operazione di servizio, i valori seguenti sono supportati nell'elemento Field di un oggetto OrderBy . Id : l'ordine è determinato dall'elemento ClientAccountId dell'oggetto ClientLink restituito. Name : l'ordine è determinato dall'elemento Name dell'oggetto ClientLink restituito. Number : l'ordine è determinato dall'elemento ManagingCustomerNumber dell'oggetto ClientLink restituito. |
Matrice OrderBy |
| PageInfo | Determina l'indice e le dimensioni dei risultati per pagina. | Paging |
| Predicati | Determina le condizioni che devono essere soddisfatte per restituire i collegamenti client. È necessario includere uno o due predicati. Per informazioni dettagliate sul modo in cui vengono determinati i risultati per ogni valore del campo predicato supportato, vedere Predicate Remarks.For details about how results are determined for each supported predicate Field value see Predicate Remarks. |
Matrice predicato |
Elementi dell'intestazione della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| AuthenticationToken | Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth. |
corda |
| DeveloperToken | Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori. |
corda |
| Password | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
| UserName | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
Elementi di risposta
L'oggetto SearchClientLinksResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.
Elementi del corpo della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| ClientLinks | Elenco di inviti ai collegamenti client. | Matrice ClientLink |
Elementi dell'intestazione della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| TrackingId | Identificatore della voce di log che contiene i dettagli della chiamata API. | corda |
Richiedi SOAP
Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.
<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:e531="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e531:Predicate>
<e531:Field i:nil="false">ValueHere</e531:Field>
<e531:Operator>ValueHere</e531:Operator>
<e531:Value i:nil="false">ValueHere</e531:Value>
</e531:Predicate>
</Predicates>
<Ordering xmlns:e532="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e532:OrderBy>
<e532:Field>ValueHere</e532:Field>
<e532:Order>ValueHere</e532:Order>
</e532:OrderBy>
</Ordering>
<PageInfo xmlns:e533="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e533:Index>ValueHere</e533:Index>
<e533:Size>ValueHere</e533:Size>
</PageInfo>
</SearchClientLinksRequest>
</s:Body>
</s:Envelope>
SOAP della risposta
Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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:e534="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e534:ClientLink>
<e534:Type d4p1:nil="false">ValueHere</e534:Type>
<e534:ClientEntityId d4p1:nil="false">ValueHere</e534:ClientEntityId>
<e534:ClientEntityNumber d4p1:nil="false">ValueHere</e534:ClientEntityNumber>
<e534:ClientEntityName d4p1:nil="false">ValueHere</e534:ClientEntityName>
<e534:ManagingCustomerId d4p1:nil="false">ValueHere</e534:ManagingCustomerId>
<e534:ManagingCustomerNumber d4p1:nil="false">ValueHere</e534:ManagingCustomerNumber>
<e534:ManagingCustomerName d4p1:nil="false">ValueHere</e534:ManagingCustomerName>
<e534:Note d4p1:nil="false">ValueHere</e534:Note>
<e534:Name d4p1:nil="false">ValueHere</e534:Name>
<e534:InviterEmail d4p1:nil="false">ValueHere</e534:InviterEmail>
<e534:InviterName d4p1:nil="false">ValueHere</e534:InviterName>
<e534:InviterPhone d4p1:nil="false">ValueHere</e534:InviterPhone>
<e534:IsBillToClient d4p1:nil="false">ValueHere</e534:IsBillToClient>
<e534:StartDate d4p1:nil="false">ValueHere</e534:StartDate>
<e534:Status d4p1:nil="false">ValueHere</e534:Status>
<e534:SuppressNotification>ValueHere</e534:SuppressNotification>
<e534:LastModifiedDateTime>ValueHere</e534:LastModifiedDateTime>
<e534:LastModifiedByUserId>ValueHere</e534:LastModifiedByUserId>
<e534:Timestamp d4p1:nil="false">ValueHere</e534:Timestamp>
<e534:ForwardCompatibilityMap xmlns:e535="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e535:KeyValuePairOfstringstring>
<e535:key d4p1:nil="false">ValueHere</e535:key>
<e535:value d4p1:nil="false">ValueHere</e535:value>
</e535:KeyValuePairOfstringstring>
</e534:ForwardCompatibilityMap>
<e534:CustomerLinkPermission d4p1:nil="false">ValueHere</e534:CustomerLinkPermission>
</e534:ClientLink>
</ClientLinks>
</SearchClientLinksResponse>
</s:Body>
</s:Envelope>
Sintassi del codice
La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'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)
Requisiti
Servizio: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
URL richiesta
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/ClientLinks/Search
Elementi della richiesta
L'oggetto SearchClientLinksRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio.
Nota
Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.
Elementi del corpo della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| Ordinando | Determina l'ordine dei risultati. Questo elemento della richiesta è facoltativo. Se specificato, è necessario includere un solo elemento OrderBy nell'elenco. Gli elementi aggiuntivi non sono supportati e verranno ignorati dal servizio. Per questa operazione di servizio, i valori seguenti sono supportati nell'elemento Field di un oggetto OrderBy . Id : l'ordine è determinato dall'elemento ClientAccountId dell'oggetto ClientLink restituito. Name : l'ordine è determinato dall'elemento Name dell'oggetto ClientLink restituito. Number : l'ordine è determinato dall'elemento ManagingCustomerNumber dell'oggetto ClientLink restituito. |
Matrice OrderBy |
| PageInfo | Determina l'indice e le dimensioni dei risultati per pagina. | Paging |
| Predicati | Determina le condizioni che devono essere soddisfatte per restituire i collegamenti client. È necessario includere uno o due predicati. Per informazioni dettagliate sul modo in cui vengono determinati i risultati per ogni valore del campo predicato supportato, vedere Predicate Remarks.For details about how results are determined for each supported predicate Field value see Predicate Remarks. |
Matrice predicato |
Elementi dell'intestazione della richiesta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| Autorizzazione | Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Assicurarsi che il token sia preceduto da "Bearer", necessario per l'autenticazione corretta. Per altre informazioni, vedere Autenticazione con OAuth. |
corda |
| DeveloperToken | Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori. |
corda |
| Password | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
| UserName | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | corda |
Elementi di risposta
L'oggetto SearchClientLinksResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nel codice JSON della risposta.
Elementi del corpo della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| ClientLinks | Elenco di inviti ai collegamenti client. | Matrice ClientLink |
Elementi dell'intestazione della risposta
| Elemento | Descrizione | Tipo di dati |
|---|---|---|
| TrackingId | Identificatore della voce di log che contiene i dettagli della chiamata API. | corda |
Richiedere JSON
Questo modello è stato generato da uno strumento per visualizzare il corpo e gli elementi di intestazione per la richiesta JSON. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
}
}
Risposta JSON
Questo modello è stato generato da uno strumento per mostrare il corpo e gli elementi dell'intestazione per la risposta 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"
}
]
}
Sintassi del codice
Per chiamare l'API REST tramite SDK, è necessario aggiornare l'SDK a una determinata versione e configurare i parametri di sistema. La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'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)