Compartir a través de

UserListSelector

  • Artículo

Contiene los métodos para filtrar y ordenar una lista de listas de usuarios en la cuenta. Para obtener información sobre los selectores, vea Selectores.

Métodos

Nombre del método Tipo de valor devuelto Descripción
get UserListIterator Obtiene un iterador usado para recorrer en iteración la lista de listas de usuarios.
orderBy(string orderBy) UserListSelector Aplica el orden especificado a las listas de usuarios seleccionadas.
withCondition(string condition) UserListSelector Aplica criterios de filtro a las listas de usuarios.
withIds(string[] ids) UserListSelector Obtiene listas de usuarios con los identificadores especificados.
withLimit(int limit) UserListSelector Obtiene las n listas de usuarios principales que coinciden con los criterios de selección.

Obtener

Obtiene un iterador usado para recorrer en iteración la lista de listas de usuarios.

Valores devueltos

Tipo Descripción
UserListIterator Iterador usado para recorrer en iteración las listas de usuarios seleccionadas.

orderBy(string orderBy)

Aplica el orden especificado a las listas de usuarios seleccionadas.

Especifique el parámetro orderBy en el formulario "columnName orderDirection" donde:

  • columnName es una de las [columnas admitidas](#supported-user list-columns).
  • orderDirection es el orden en el que se ordenan los resultados. Establezca en ASC para ordenar los resultados en orden ascendente o DESC para ordenar los resultados en orden descendente. El valor predeterminado es ASC.

Por ejemplo, la siguiente llamada devuelve resultados en orden ascendente por el nombre de la lista de usuarios.

selector = selector.orderBy("Name");

Los selectores admiten la ordenación de entidades solo por un campo. No puede ordenar la lista de entidades por campo x, y dentro de x por campo y, etc. Si especifica más de una orderBy() llamada en una cadena o en llamadas de selector independientes, Scripts ordena la lista de entidades mediante el campo especificado en la última orderBy() llamada. 

Argumentos

Nombre Tipo Descripción
Orderby string Orden que se va a aplicar.

Valores devueltos

Tipo Descripción
UserListSelector Selector con orden aplicado.

withCondition(String condition)

Aplica criterios de filtro a las listas de usuarios.

Especifique el parámetro de condición en el formulario "columnName operator value" donde:

  • columnName es una de las [columnas admitidas](#supported-user list-columns).
  • operator es uno de los operadores admitidos.

Operadores

El operador que use depende del tipo de columna. Los operadores distinguen mayúsculas de minúsculas. Por ejemplo, use STARTS_WITH en lugar de starts_with.

Operadores para columnas que contienen enteros y valores largos:

<
<=
>
>=
=
!=

Operadores para columnas que contienen valores dobles:

<
>

Operadores para columnas que contienen valores de cadena:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operadores para columnas que contienen valores de enumeración:

=
!=
IN []
NOT_IN []

Operadores para columnas que contienen una matriz de cadenas:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Columnas admitidas para el filtrado de listas de usuarios. Los nombres de columna distinguen mayúsculas de minúsculas.

Column Tipo Ejemplo
Descripción string Descripción de la lista de usuarios.

withCondition("Description = 'foo'")
MembershipLifeSpan Entero Cuánto tiempo atrás (número de días) Microsoft Advertising debe buscar acciones que coincidan con esta definición de lista de usuarios.

withCondition("MembershipLifeSpan > 10")
Nombre string Nombre de la lista de usuarios.

withCondition("Name = 'foo'")
SizeForAudienceNetwork largo Tamaño de la lista de usuarios en la red audience.

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch largo Tamaño de la lista de usuarios en la red audience.

withCondition("SizeForSearch > 1000")
Tipo string Tipo derivado de la lista de usuarios. Los posibles valores que distinguen mayúsculas de minúsculas son:
  • PERSONALIZADO
  • CUSTOMER_LIST
  • IN_MARKET
  • LÓGICA
  • PRODUCTO
  • RULE_BASED
  • SIMILAR
En este ejemplo solo se devuelven listas de clientes.

withCondition("Type = CUSTOMER_LIST")

Argumentos

Nombre Tipo Descripción
Condición string Condición que se va a agregar al selector.

Valores devueltos

Tipo Descripción
UserListSelector Selector con la condición aplicada.

withIds(string[] ids)

Obtiene listas de usuarios con los identificadores especificados.

Puede aplicar una o varias condiciones a un selector. Una cadena de condiciones se considera una operación AND. Por ejemplo, la entidad solo se selecciona si la condición A es true Y la condición B es true. Por ejemplo, la llamada siguiente selecciona solo la lista de usuarios 33333.

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

Argumentos

Nombre Tipo Descripción
ids string[] Matriz de identificadores de lista de usuarios. Para conocer los límites, consulte Límites de ejecución de scripts.

Valores devueltos

Tipo Descripción
UserListSelector Selector con los identificadores aplicados.

withLimit(int limit)

Obtiene las n listas de usuarios principales que coinciden con los criterios de selección.

Argumentos

Nombre Tipo Descripción
límite Entero Número de listas de usuarios que se van a devolver. El número real puede ser menor.

Valores devueltos

Tipo Descripción
UserListSelector Selector con límite aplicado.

Consulte también