Partilhar via

UserListSelector

  • Artigo

Contém os métodos para filtrar e ordenar uma lista de listas de utilizadores na conta. Para obter informações sobre seletores, consulte Seletores.

Métodos

Nome do Método Tipo de Devolução Descrição
obter UserListIterator Obtém um iterador utilizado para iterar através da lista de listas de utilizadores.
orderBy(string orderBy) UserListSelector Aplica a ordenação especificada às listas de utilizadores selecionadas.
withCondition(condição de cadeia) UserListSelector Aplica critérios de filtro às listas de utilizadores.
withIds(string[] ids) UserListSelector Obtém listas de utilizadores com os IDs especificados.
withLimit(int limit) UserListSelector Obtém as principais n listas de utilizadores que correspondem aos critérios de seleção.

obter

Obtém um iterador utilizado para iterar através da lista de listas de utilizadores.

Devoluções

Tipo Descrição
UserListIterator Um iterador utilizado para iterar através das listas de utilizadores selecionadas.

orderBy(string orderBy)

Aplica a ordenação especificada às listas de utilizadores selecionadas.

Especifique o parâmetro orderBy no formulário "columnName orderDirection" em que:

  • columnName é uma das [colunas suportadas](#supported-user list-columns).
  • orderDirection é a ordem para ordenar os resultados. Defina como ASC para ordenar os resultados por ordem ascendente ou DESC para ordenar os resultados por ordem descendente. A predefinição é ASC.

Por exemplo, a chamada seguinte devolve resultados por ordem ascendente pelo nome da lista de utilizadores.

selector = selector.orderBy("Name");

Os seletores suportam a ordenação de entidades apenas por um campo. Não pode ordenar a lista de entidades por campo x e dentro de x por campo y, etc. Se especificar mais do que uma orderBy() chamada numa cadeia ou em chamadas de seletor separadas, os scripts ordenam a lista de entidades utilizando o campo especificado na última orderBy() chamada. 

Argumentos

Name Tipo Descrição
orderBy cadeia A ordenação a aplicar.

Devoluções

Tipo Descrição
UserListSelector Seletor com ordenação aplicada.

withCondition(Condição de cadeia)

Aplica critérios de filtro às listas de utilizadores.

Especifique o parâmetro condition no formulário "columnName operator value" em que:

  • columnName é uma das [colunas suportadas](#supported-user list-columns).
  • O operador é um dos operadores suportados.

Operadores

O operador que utilizar depende do tipo da coluna. Os operadores são sensíveis às maiúsculas e minúsculas. Por exemplo, utilize STARTS_WITH em vez de starts_with.

Operadores para colunas que contêm números inteiros e valores longos:

<
<=
>
>=
=
!=

Operadores para colunas que contêm valores duplos:

<
>

Operadores para colunas que contêm valores de cadeia:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operadores para colunas que contêm valores de enumeração:

=
!=
IN []
NOT_IN []

Operadores para colunas que contêm uma matriz de cadeias:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colunas suportadas para filtragem de listas de utilizadores. Os nomes das colunas são sensíveis às maiúsculas e minúsculas.

Coluna Tipo Exemplos:
Descrição cadeia Descrição da lista de utilizadores.

withCondition("Description = 'foo'")
MembershipLifeSpan int Até que ponto anterior no tempo (número de dias) o Microsoft Advertising deve procurar ações que correspondam a esta definição de lista de utilizadores.

withCondition("MembershipLifeSpan > 10")
Name cadeia O nome da lista de utilizadores.

withCondition("Name = 'foo'")
SizeForAudienceNetwork long O tamanho da lista de utilizadores na rede audiência.

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch long O tamanho da lista de utilizadores na rede audiência.

withCondition("SizeForSearch > 1000")
Tipo cadeia O tipo derivado da lista de utilizadores. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • PERSONALIZADO
  • CUSTOMER_LIST
  • IN_MARKET
  • LÓGICA
  • PRODUTO
  • RULE_BASED
  • SEMELHANTE
Este exemplo devolve apenas listas de clientes.

withCondition("Type = CUSTOMER_LIST")

Argumentos

Name Tipo Descrição
condição cadeia A condição a adicionar ao seletor.

Devoluções

Tipo Descrição
UserListSelector Seletor com a condição aplicada.

withIds(string[] ids)

Obtém listas de utilizadores com os IDs especificados.

Pode aplicar uma ou mais condições a um seletor. Uma cadeia de condições é considerada uma operação E. Por exemplo, a entidade só é selecionada se a condição A for verdadeira E a condição B for verdadeira. Por exemplo, a chamada seguinte seleciona apenas a lista de utilizadores 33333.

AdsApp.userLists()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumentos

Name Tipo Descrição
IDs cadeia[] Uma matriz de IDs de lista de utilizadores. Para obter limites, veja Limites de execução de scripts.

Devoluções

Tipo Descrição
UserListSelector Seletor com os IDs aplicados.

withLimit(int limit)

Obtém as principais n listas de utilizadores que correspondem aos critérios de seleção.

Argumentos

Name Tipo Descrição
limite int O número de listas de utilizadores a devolver. O número real pode ser menor.

Devoluções

Tipo Descrição
UserListSelector Seletor com limite aplicado.

Consulte também