Operazione del servizio SearchAccounts - Gestione clienti

  • Articolo

Cerca gli account che corrispondono ai criteri di richiesta.

Ad esempio, è possibile cercare gli account a cui l'utente autenticato corrente può accedere.

Consiglio

Per una panoramica con esempi, vedere la guida alle autorizzazioni utente e hierchy per gli account.

Elementi della richiesta

L'oggetto SearchAccountsRequest 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
Ordinare Determina l'ordine dei risultati in base alla proprietà specificata di un account.

Questo elemento della richiesta è facoltativo. È possibile specificare fino a un elemento OrderBy nella matrice. Gli elementi aggiuntivi non sono supportati e verranno ignorati dal servizio.

Se si imposta l'elemento Field dell'oggetto OrderBy su "Id", "Name" o "Number", gli account restituiti verranno ordinati in base agli identificatori, ai nomi o ai numeri dell'account di conseguenza.

Questo elemento della richiesta è facoltativo.		 Matrice OrderBy
Pageinfo Determina l'indice e le dimensioni dei risultati per pagina. Paging
Predicati Determina le condizioni che devono essere soddisfatte per restituire gli account.

È necessario includere esattamente un predicato. Se il campo predicato è impostato su "AccountLifeCycleStatus", è necessario specificare un predicato aggiuntivo con Field impostato su un altro valore, ad esempio UserId.

Per informazioni dettagliate su ogni valore del campo predicato supportato, vedere Osservazioni predicato.		 Matrice predicato
ReturnAdditionalFields Elenco di proprietà aggiuntive da includere in ogni account restituito. I valori di campo aggiuntivi consentono di ottenere le funzionalità più recenti usando la versione corrente dell'API Gestione clienti e nella versione successiva gli elementi corrispondenti verranno inclusi per impostazione predefinita.

Questo elemento della richiesta è facoltativo.		 AccountAdditionalField

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.		 Stringa
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 Stringa
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. Stringa
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. Stringa

Elementi di risposta

L'oggetto SearchAccountsResponse 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
Account Elenco di account che soddisfano i criteri di richiesta. Array AdvertiserAccount

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. Stringa

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">SearchAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e243="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e243:Predicate>
          <e243:Field i:nil="false">ValueHere</e243:Field>
          <e243:Operator>ValueHere</e243:Operator>
          <e243:Value i:nil="false">ValueHere</e243:Value>
        </e243:Predicate>
      </Predicates>
      <Ordering xmlns:e244="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e244:OrderBy>
          <e244:Field>ValueHere</e244:Field>
          <e244:Order>ValueHere</e244:Order>
        </e244:OrderBy>
      </Ordering>
      <PageInfo xmlns:e245="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e245:Index>ValueHere</e245:Index>
        <e245:Size>ValueHere</e245:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchAccountsRequest>
  </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>
    <SearchAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Accounts xmlns:e246="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e246:AdvertiserAccount>
          <e246:BillToCustomerId d4p1:nil="false">ValueHere</e246:BillToCustomerId>
          <e246:CurrencyCode d4p1:nil="false">ValueHere</e246:CurrencyCode>
          <e246:AccountFinancialStatus d4p1:nil="false">ValueHere</e246:AccountFinancialStatus>
          <e246:Id d4p1:nil="false">ValueHere</e246:Id>
          <e246:Language d4p1:nil="false">ValueHere</e246:Language>
          <e246:LastModifiedByUserId d4p1:nil="false">ValueHere</e246:LastModifiedByUserId>
          <e246:LastModifiedTime d4p1:nil="false">ValueHere</e246:LastModifiedTime>
          <e246:Name d4p1:nil="false">ValueHere</e246:Name>
          <e246:Number d4p1:nil="false">ValueHere</e246:Number>
          <e246:ParentCustomerId>ValueHere</e246:ParentCustomerId>
          <e246:PaymentMethodId d4p1:nil="false">ValueHere</e246:PaymentMethodId>
          <e246:PaymentMethodType d4p1:nil="false">ValueHere</e246:PaymentMethodType>
          <e246:PrimaryUserId d4p1:nil="false">ValueHere</e246:PrimaryUserId>
          <e246:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e246:AccountLifeCycleStatus>
          <e246:TimeStamp d4p1:nil="false">ValueHere</e246:TimeStamp>
          <e246:TimeZone d4p1:nil="false">ValueHere</e246:TimeZone>
          <e246:PauseReason d4p1:nil="false">ValueHere</e246:PauseReason>
          <e246:ForwardCompatibilityMap xmlns:e247="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e247:KeyValuePairOfstringstring>
              <e247:key d4p1:nil="false">ValueHere</e247:key>
              <e247:value d4p1:nil="false">ValueHere</e247:value>
            </e247:KeyValuePairOfstringstring>
          </e246:ForwardCompatibilityMap>
          <e246:LinkedAgencies d4p1:nil="false">
            <e246:CustomerInfo>
              <e246:Id d4p1:nil="false">ValueHere</e246:Id>
              <e246:Name d4p1:nil="false">ValueHere</e246:Name>
            </e246:CustomerInfo>
          </e246:LinkedAgencies>
          <e246:SalesHouseCustomerId d4p1:nil="false">ValueHere</e246:SalesHouseCustomerId>
          <e246:TaxInformation xmlns:e248="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e248:KeyValuePairOfstringstring>
              <e248:key d4p1:nil="false">ValueHere</e248:key>
              <e248:value d4p1:nil="false">ValueHere</e248:value>
            </e248:KeyValuePairOfstringstring>
          </e246:TaxInformation>
          <e246:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e246:BackUpPaymentInstrumentId>
          <e246:BillingThresholdAmount d4p1:nil="false">ValueHere</e246:BillingThresholdAmount>
          <e246:BusinessAddress d4p1:nil="false">
            <e246:City d4p1:nil="false">ValueHere</e246:City>
            <e246:CountryCode d4p1:nil="false">ValueHere</e246:CountryCode>
            <e246:Id d4p1:nil="false">ValueHere</e246:Id>
            <e246:Line1 d4p1:nil="false">ValueHere</e246:Line1>
            <e246:Line2 d4p1:nil="false">ValueHere</e246:Line2>
            <e246:Line3 d4p1:nil="false">ValueHere</e246:Line3>
            <e246:Line4 d4p1:nil="false">ValueHere</e246:Line4>
            <e246:PostalCode d4p1:nil="false">ValueHere</e246:PostalCode>
            <e246:StateOrProvince d4p1:nil="false">ValueHere</e246:StateOrProvince>
            <e246:TimeStamp d4p1:nil="false">ValueHere</e246:TimeStamp>
            <e246:BusinessName d4p1:nil="false">ValueHere</e246:BusinessName>
          </e246:BusinessAddress>
          <e246:AutoTagType d4p1:nil="false">ValueHere</e246:AutoTagType>
          <e246:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e246:SoldToPaymentInstrumentId>
          <e246:TaxCertificate d4p1:nil="false">
            <e246:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e246:TaxCertificateBlobContainerName>
            <e246:TaxCertificates xmlns:e249="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
              <e249:KeyValuePairOfstringbase64Binary>
                <e249:key d4p1:nil="false">ValueHere</e249:key>
                <e249:value d4p1:nil="false">ValueHere</e249:value>
              </e249:KeyValuePairOfstringbase64Binary>
            </e246:TaxCertificates>
            <e246:Status d4p1:nil="false">ValueHere</e246:Status>
          </e246:TaxCertificate>
          <e246:AccountMode d4p1:nil="false">ValueHere</e246:AccountMode>
        </e246:AdvertiserAccount>
      </Accounts>
    </SearchAccountsResponse>
  </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<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchAccountsAsync(r), request));
}

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return CustomerManagementService.getService().searchAccounts(request);
}

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchAccountsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchAccounts($request);
}

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requisiti

Servizio: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13