Freigeben über

UserListSelector

  • Artikel

Enthält die Methoden zum Filtern und Sortieren einer Liste von Benutzerlisten im Konto. Informationen zu Selektoren finden Sie unter Selektoren.

Methoden

Methodenname Rückgabetyp Beschreibung
get UserListIterator Ruft einen Iterator ab, der zum Durchlaufen der Liste der Benutzerlisten verwendet wird.
orderBy(string orderBy) UserListSelector Wendet die angegebene Reihenfolge auf die ausgewählten Benutzerlisten an.
withCondition(string condition) UserListSelector Wendet Filterkriterien auf die Benutzerlisten an.
withIds(string[] ids) UserListSelector Ruft Benutzerlisten mit den angegebenen IDs ab.
withLimit(int limit) UserListSelector Ruft die obersten n Benutzerlisten ab, die den Auswahlkriterien entsprechen.

Erhalten

Ruft einen Iterator ab, der zum Durchlaufen der Liste der Benutzerlisten verwendet wird.

Rückgabewerte

Typ Beschreibung
UserListIterator Ein Iterator, der zum Durchlaufen der ausgewählten Benutzerlisten verwendet wird.

orderBy(string orderBy)

Wendet die angegebene Reihenfolge auf die ausgewählten Benutzerlisten an.

Geben Sie den orderBy-Parameter im Format "columnName orderDirection" an, wobei:

  • columnName ist eine der [unterstützten Spalten](#supported-user list-columns).
  • orderDirection ist die Reihenfolge, in der die Ergebnisse sortiert werden. Legen Sie auf ASC fest, um die Ergebnisse in aufsteigender Reihenfolge zu sortieren, oder AUF DESC, um die Ergebnisse in absteigender Reihenfolge zu sortieren. Der Standardwert ist ASC.

Der folgende Aufruf gibt z. B. Ergebnisse in aufsteigender Reihenfolge nach dem Namen der Benutzerliste zurück.

selector = selector.orderBy("Name");

Selektoren unterstützen das Sortieren von Entitäten nur nach einem Feld. Sie dürfen die Liste der Entitäten nicht nach Feld x und innerhalb von x nach Feld y usw. sortieren. Wenn Sie mehr als einen orderBy() Aufruf in einer Kette oder in separaten Selektoraufrufen angeben, sortiert Scripts die Liste der Entitäten mithilfe des im letzten orderBy() Aufruf angegebenen Felds. 

Argumente

Name Typ Beschreibung
Orderby string Die anzuwendende Reihenfolge.

Rückgabewerte

Typ Beschreibung
UserListSelector Selektor mit angewendeter Reihenfolge.

withCondition(String condition)

Wendet Filterkriterien auf die Benutzerlisten an.

Geben Sie den Bedingungsparameter im Format "columnName-Operatorwert" an, wobei:

  • columnName ist eine der [unterstützten Spalten](#supported-user list-columns).
  • operator ist einer der unterstützten Operatoren.

Operatoren

Der operator, den Sie verwenden, hängt vom Typ der Spalte ab. Bei Operatoren wird die Groß-/Kleinschreibung beachtet. Verwenden Sie beispielsweise STARTS_WITH anstelle von starts_with.

Operatoren für Spalten, die ganze Zahlen und lange Werte enthalten:

<
<=
>
>=
=
!=

Operatoren für Spalten, die doppelte Werte enthalten:

<
>

Operatoren für Spalten, die Zeichenfolgenwerte enthalten:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operatoren für Spalten, die Enumerationswerte enthalten:

=
!=
IN []
NOT_IN []

Operatoren für Spalten, die ein Array von Zeichenfolgen enthalten:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Unterstützte Spalten für die Filterung von Benutzerlisten. Bei Spaltennamen wird die Groß-/Kleinschreibung beachtet.

Spalte Typ Beispiel
Beschreibung string Die Beschreibung der Benutzerliste.

withCondition("Description = 'foo'")
MembershipLifeSpan int Wie weit zurück in der Zeit (Anzahl der Tage) Microsoft Advertising nach Aktionen suchen sollte, die dieser Benutzerlistendefinition entsprechen.

withCondition("MembershipLifeSpan > 10")
Name string Der Name der Benutzerliste.

withCondition("Name = 'foo'")
SizeForAudienceNetwork long Die Größe der Benutzerliste im Zielgruppennetzwerk.

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch long Die Größe der Benutzerliste im Zielgruppennetzwerk.

withCondition("SizeForSearch > 1000")
Typ string Der abgeleitete Typ der Benutzerliste. Mögliche Werte, bei denen die Groß-/Kleinschreibung beachtet wird, sind:
  • BENUTZERDEFINIERTE
  • CUSTOMER_LIST
  • IN_MARKET
  • LOGISCHE
  • PRODUKT
  • RULE_BASED
  • ÄHNLICHE
In diesem Beispiel werden nur Kundenlisten zurückgegeben.

withCondition("Type = CUSTOMER_LIST")

Argumente

Name Typ Beschreibung
Zustand string Die Bedingung, die dem Selektor hinzugefügt werden soll.

Rückgabewerte

Typ Beschreibung
UserListSelector Selektor mit angewendeter Bedingung.

withIds(string[] ids)

Ruft Benutzerlisten mit den angegebenen IDs ab.

Sie können eine oder mehrere Bedingungen auf einen Selektor anwenden. Eine Kette von Bedingungen wird als AND-Vorgang betrachtet. Beispielsweise wird die Entität nur ausgewählt, wenn Bedingung A true ist UND Bedingung B wahr ist. Der folgende Aufruf wählt beispielsweise nur die Benutzerliste 33333 aus.

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

Argumente

Name Typ Beschreibung
ids string[] Ein Array von Benutzerlisten-IDs. Informationen zu Grenzwerten finden Sie unter Skriptausführungslimits.

Rückgabewerte

Typ Beschreibung
UserListSelector Selektor mit den angewendeten IDs.

withLimit(int limit)

Ruft die obersten n Benutzerlisten ab, die den Auswahlkriterien entsprechen.

Argumente

Name Typ Beschreibung
Begrenzung int Die Anzahl der zurückzugebenden Benutzerlisten. Die tatsächliche Zahl kann kleiner sein.

Rückgabewerte

Typ Beschreibung
UserListSelector Selektor mit angewendetem Limit.

Siehe auch