Predicar Objeto de Dados - Gestão de Clientes

Artigo
11/13/2024

Define um predicado para a lista de entidades pedidas através de uma das operações de pesquisa, por exemplo SearchAccounts, SearchClientLinks, SearchCustomers ou SearchUserInvitations.

Sintaxe

XML
JSON

<xs:complexType name="Predicate" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Field" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Operator" type="tns:PredicateOperator" />
    <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

{
  "Field": "ValueHere",
  "Operator": "ValueHere",
  "Value": "ValueHere"
}

Elementos

O objeto Predicado tem os seguintes elementos: Campo, Operador, Valor.

Elemento	Descrição	Tipo de Dados
Campo	O nome do elemento do objeto que está a procurar. Para obter os valores possíveis, veja as Observações abaixo.	cadeia
Operador	Define a relação entre o campo e o valor.	PredicateOperator
Valor	A cadeia a procurar no campo especificado. O comprimento desta cadeia tem de ser quatro ou maior, a menos que o campo esteja definido como MarketCountry ou MarketLanguage.	cadeia

Observações

Os elementos Campo suportados e Operador de um objeto Predicado para cada operação de serviço são fornecidos em detalhe abaixo.

Predicados searchAccounts

Para a operação de serviço SearchAccounts, são suportados os elementos Campo e Operador de um objeto Predicado.

Campo	Operador	Descrição
AccountId	É igual a Em	Utilize este campo para procurar o elemento ID da AdvertiserAccount.
AccountLifeCycleStatus	É igual a	Utilize este campo para pesquisar o elemento AccountLifeCycleStatus da AdvertiserAccount. Os valores possíveis incluem "Ativo", "Rascunho", "Inativo", "Pausa", "Pendente" e "Suspenso". - Quando pede contas por estado "Ativo", a operação devolve contas com AccountLifeCycleStatus definido como Ativo. A operação também devolve contas com AccountLifeCycleStatus definido como Pausa, em que o valor PauseReason é 2 (o serviço de faturação fez uma pausa na conta). - Quando pede contas por estado "Pausa", a operação devolve contas com AccountLifeCycleStatus definido como Pausa, em que o valor PauseReason é 1 (o utilizador fez uma pausa na conta) ou 4 (o utilizador e o serviço de faturação colocaram a conta em pausa).
AccountName	Contém É igual a	Utilize este campo para procurar o elemento Name da AdvertiserAccount.
AccountNumber	Contém É igual a Em	Utilize este campo para procurar o elemento Número da AdvertiserAccount.
CustomerId	É igual a	Utilize este campo para procurar o elemento ID do Cliente.
UserId	É igual a	Utilize este campo para procurar o elemento UserId do Utilizador.

Predicados searchClientLinks

Para a operação de serviço SearchClientLinks, são suportados os elementos Campo e Operador de um objeto Predicado.

Campo	Operador	Descrição
ClientAccountId	É igual a Em	Procure objetos ClientLink da conta de anunciante pelo identificador da conta do anunciante cliente.
ClientCustomerId	É igual a Em	Procure objetos ClientLink do cliente pelo identificador do cliente do cliente.
DirectManagingCustomerId	É igual a	Procure objetos ClientLink da conta do cliente e do anunciante pelo identificador de cliente de gestão da agência. Se outros clientes também ligarem ao cliente cliente, os resultados não incluirão essas ligações de cliente.
ManagingCustomerId	É igual a	Procure objetos ClientLink da conta de anunciante pelo identificador de cliente de gestão da agência. Se outros clientes também ligarem à conta do anunciante cliente, os resultados incluirão essas ligações de cliente. Este valor predicado foi preterido a favor do predicado DirectManagingCustomerId.

Tenha em atenção as seguintes regras de predicado para SearchClientLinks.

Não pode incluir DirectManagingCustomerId e ManagingCustomerId.
Não pode incluir ClientAccountId e ClientCustomerId.
Se incluir os predicados ClientAccountId e ManagingCustomerId na mesma chamada de serviço, o ManagingCustomerId será ignorado.
Se incluir predicados ClientCustomerId e DirectManagingCustomerId na mesma chamada de serviço, os resultados incluirão apenas ligações de cliente do cliente que cumpram ambas as condições de predicado.
Se incluir predicados ClientAccountId e DirectManagingCustomerId na mesma chamada de serviço, os resultados incluirão apenas ligações de cliente de conta de anunciante que cumpram ambas as condições de predicado.

Predicados SearchCustomers

Para a operação de serviço SearchCustomers , são suportados os elementos Campo e Operador de um objeto Predicado.

Campo	Operador	Descrição
AccountId	É igual a	Utilize este campo para procurar o elemento ID da AdvertiserAccount.
AccountName	Contém É igual a	Utilize este campo para procurar o elemento Name da AdvertiserAccount.
AccountNumber	Contém É igual a	Utilize este campo para procurar o elemento Número da AdvertiserAccount.
ApplicationScope	É igual a	Apenas para utilização interna.
Data De Criação	GreaterThanEquals LessThanEquals	Utilize este campo para pesquisar a data em que o cliente foi criado ou se inscreveu. A data é armazenada na Hora Universal Coordenada (UTC). Apenas o mês, dia e ano da cadeia especificada são utilizados para pesquisa. Se especificar a hora, os minutos e os segundos de uma data, estes serão ignorados. Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.
CustomerId	É igual a Em	Utilize este campo para procurar o elemento ID do Cliente.
CustomerName	Contém É igual a	Utilize este campo para procurar o elemento Nome do Cliente.
MarketCountry	É igual a	Utilize este campo para pesquisar o elemento MarketCountry do Cliente. Os campos de predicado MarketCountry e MarketLanguage não são necessários; no entanto, se um dos dois for especificado, ambos são necessários.
MarketLanguage	É igual a	Utilize este campo para procurar o elemento MarketLanguage do Cliente. Os campos de predicado MarketCountry e MarketLanguage não são necessários; no entanto, se um dos dois for especificado, ambos são necessários.
Nome de Utilizador	É igual a	Utilize este campo para procurar o elemento UserName do Utilizador.

Predicados searchUserInvitations

Para a operação do serviço SearchUserInvitations , são suportados os elementos Campo suportados e Elementos de operador de um objeto Predicado.

Campo	Operador	Descrição
CustomerId	É igual a	Utilize este campo para procurar o elemento CustomerId da UserInvitation.

Requisitos

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

Utilizado Por

SearchAccounts
SearchClientLinks
SearchCustomers
SearchUserInvitations

Partilhar via