Partager via

UserListSelector

  • Article

Contient les méthodes de filtrage et de classement d’une liste de listes d’utilisateurs dans le compte. Pour plus d’informations sur les sélecteurs, consultez Sélecteurs.

Méthodes

Nom de la méthode Type renvoyé Description
get UserListIterator Obtient un itérateur utilisé pour itérer dans la liste des listes d’utilisateurs.
orderBy(string orderBy) UserListSelector Applique le classement spécifié aux listes d’utilisateurs sélectionnées.
withCondition(string condition) UserListSelector Applique des critères de filtre aux listes d’utilisateurs.
withIds(string[] ids) UserListSelector Obtient les listes d’utilisateurs avec les ID spécifiés.
withLimit(int limit) UserListSelector Obtient les n premières listes d’utilisateurs qui correspondent aux critères de sélection.

Avoir

Obtient un itérateur utilisé pour itérer dans la liste des listes d’utilisateurs.

Retourne

Type Description
UserListIterator Itérateur utilisé pour itérer dans les listes d’utilisateurs sélectionnées.

orderBy(string orderBy)

Applique le classement spécifié aux listes d’utilisateurs sélectionnées.

Spécifiez le paramètre orderBy sous la forme « columnName orderDirection » où :

  • columnName est l’une des [colonnes prises en charge](#supported-user list-columns).
  • orderDirection est l’ordre dans lequel trier les résultats. Définissez sur ASC pour classer les résultats dans l’ordre croissant ou sur DESC pour classer les résultats dans l’ordre décroissant. La valeur par défaut est ASC.

Par exemple, l’appel suivant retourne les résultats dans l’ordre croissant en fonction du nom de la liste d’utilisateurs.

selector = selector.orderBy("Name");

Les sélecteurs prennent en charge le classement des entités par un seul champ. Vous ne pouvez pas classer la liste des entités par champ x, et dans x par champ y, et ainsi de suite. Si vous spécifiez plusieurs orderBy() appels dans une chaîne ou dans des appels de sélecteur distincts, les scripts commandent la liste des entités à l’aide du champ spécifié dans le dernier orderBy() appel. 

Arguments

Nom Type Description
Orderby string Ordre à appliquer.

Retourne

Type Description
UserListSelector Sélecteur avec classement appliqué.

withCondition(String condition)

Applique des critères de filtre aux listes d’utilisateurs.

Spécifiez le paramètre de condition sous la forme « columnName operator value » où :

  • columnName est l’une des [colonnes prises en charge](#supported-user list-columns).
  • est l’un des opérateurs pris en charge.

Opérateurs

L’opérateur que vous utilisez dépend du type de la colonne. Les opérateurs respectent la casse. Par exemple, utilisez STARTS_WITH au lieu de starts_with.

Opérateurs pour les colonnes qui contiennent des entiers et des valeurs longues :

<
<=
>
>=
=
!=

Opérateurs pour les colonnes qui contiennent des valeurs doubles :

<
>

Opérateurs pour les colonnes qui contiennent des valeurs de chaîne :

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Opérateurs pour les colonnes qui contiennent des valeurs d’énumération :

=
!=
IN []
NOT_IN []

Opérateurs pour les colonnes qui contiennent un tableau de chaînes :

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colonnes prises en charge pour le filtrage des listes d’utilisateurs. Les noms des colonnes sont sensibles à la casse.

Column Type Exemple
Description string Description de la liste des utilisateurs.

withCondition("Description = 'foo'")
MembershipLifeSpan int Dans quelle mesure Microsoft Advertising doit rechercher des actions qui correspondent à cette définition de liste d’utilisateurs (nombre de jours).

withCondition("MembershipLifeSpan > 10")
Nom string Nom de la liste d’utilisateurs.

withCondition("Name = 'foo'")
SizeForAudienceNetwork long Taille de la liste d’utilisateurs dans le réseau Audience.

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch long Taille de la liste d’utilisateurs dans le réseau Audience.

withCondition("SizeForSearch > 1000")
Type chaîne Type dérivé de la liste d’utilisateurs. Les valeurs possibles respectant la casse sont les suivantes :
  • PERSONNALISÉ
  • CUSTOMER_LIST
  • IN_MARKET
  • LOGIQUE
  • PRODUIT
  • RULE_BASED
  • SIMILAIRE
Cet exemple retourne uniquement des listes de clients.

withCondition("Type = CUSTOMER_LIST")

Arguments

Nom Type Description
Condition string Condition à ajouter au sélecteur.

Retourne

Type Description
UserListSelector Sélecteur avec la condition appliquée.

withIds(string[] ids)

Obtient les listes d’utilisateurs avec les ID spécifiés.

Vous pouvez appliquer une ou plusieurs conditions à un sélecteur. Une chaîne de conditions est considérée comme une opération AND. Par exemple, l’entité est sélectionnée uniquement si la condition A a la valeur true ET si la condition B a la valeur true. Par exemple, l’appel suivant sélectionne uniquement la liste d’utilisateurs 33333.

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

Arguments

Nom Type Description
Ids string[] Tableau d’ID de liste d’utilisateurs. Pour connaître les limites, consultez Limites d’exécution de script.

Retourne

Type Description
UserListSelector Sélecteur avec les ID appliqués.

withLimit(int limit)

Obtient les n premières listes d’utilisateurs qui correspondent aux critères de sélection.

Arguments

Nom Type Description
limit int Nombre de listes d’utilisateurs à retourner. Le nombre réel peut être inférieur.

Retourne

Type Description
UserListSelector Sélecteur avec limite appliquée.

Voir aussi