Partilhar via

Operação de Serviço SearchAccounts - Gestão de Clientes

  • Artigo

Procura contas que correspondam aos critérios do pedido.

Por exemplo, pode procurar contas às quais o utilizador autenticado atual possa aceder.

Sugestão

Veja o Guia de Permissões de Utilizador e Hierárquios de Conta para obter uma descrição geral com exemplos.

Elementos do Pedido

O objeto SearchAccountsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
Encomenda Determina a ordem dos resultados pela propriedade especificada de uma conta.

Este elemento de pedido é opcional. Pode especificar até um elemento OrderBy na matriz. Os elementos adicionais não são suportados e serão ignorados pelo serviço.

Se definir o elemento Campo do objeto OrderBy como "Id", "Nome" ou "Número", as Contas devolvidas serão ordenadas pelos identificadores, nomes ou números da conta em conformidade.

Este elemento de pedido é opcional.		 Matriz OrderBy
PageInfo Determina o índice e o tamanho dos resultados por página. Paginação
Predicados Determina as condições que têm de ser cumpridas para devolver contas.

Tem de incluir exatamente um predicado. Se o Campo de predicado estiver definido como "AccountLifeCycleStatus", tem de especificar um predicado adicional com o Campo definido para outro valor, como UserId.

Para obter detalhes sobre cada valor de Campo predicado suportado, veja Predicado Observações.		 Predicado de matriz
ReturnAdditionalFields A lista de propriedades adicionais que pretende incluir em cada conta devolvida. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Gestão de Clientes e, na próxima versão, os elementos correspondentes serão incluídos por predefinição.

Este elemento de pedido é opcional.		 AccountAdditionalField

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
AuthenticationToken O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto SearchAccountsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
Contas Uma lista de contas que cumprem os critérios do pedido. Matriz AdvertiserAccount

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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 de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CustomerManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Customer/v13