UserListSelector

包含用于筛选和排序帐户中的用户列表的方法。 有关选择器的信息，请参阅 选择器。

方法

方法名称 返回类型 说明
get UserListIterator 获取用于循环访问用户列表的迭代器。
orderBy (字符串 orderBy) UserListSelector 将指定的顺序应用于所选用户列表。
withCondition (字符串条件) UserListSelector 将筛选条件应用于用户列表。
withIds (string[] ids) UserListSelector 获取具有指定 ID 的用户列表。
withLimit (int limit) UserListSelector 获取与选择条件匹配的前 n 个 用户列表。

get

获取用于循环访问用户列表的 迭代器 。

返回

类型 说明
UserListIterator 用于循环访问所选用户列表的迭代器。

orderBy (字符串 orderBy)

将指定的顺序应用于所选用户列表。

在“columnName orderDirection”格式中指定 orderBy 参数，其中：

  • columnName 是 [支持的列] (#supported-user list-columns) 之一。
  • orderDirection 是对结果排序所依据的顺序。 设置为 ASC 以按升序对结果进行排序，设置为 DESC 以按降序对结果进行排序。 默认值为 ASC。

例如，以下调用按用户列表名称升序返回结果。

selector = selector.orderBy("Name");

选择器仅支持按一个字段对实体进行排序。 您不能按字段 x 排序实体列表，按字段 y 排序 x 内的实体列表，等等。 如果在链或单独的选择器调用中指定多个 orderBy() 调用，脚本将使用上次 orderBy() 调用中指定的字段对实体列表进行排序。 

参数

名称 类型 说明
orderBy string 要应用的顺序。

返回

类型 说明
UserListSelector 应用了排序的选择器。

withCondition (字符串条件)

将筛选条件应用于用户列表。

在“columnName operator value”格式中指定 条件 参数，其中：

  • columnName 是 [支持的列] (#supported-user list-columns) 之一。
  • 运算符 是支持的 运算符之一。

运算符

使用的运算符取决于列的类型。 运算符区分大小写。 例如，使用 STARTS_WITH 而不是 starts_with。

包含整数和长值的列的运算符：

<
<=
>
>=
=
!=

包含 double 值的列的运算符：

<
>

包含字符串值的列的运算符：

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

包含枚举值的列的运算符：

=
!=
IN []
NOT_IN []

包含字符串数组的列的运算符：

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

支持用于用户列表筛选的列。 列名称需区分大小写。

列 类型 示例
说明 string 用户列表的说明。

withCondition("Description = 'foo'")
MembershipLifeSpan int Microsoft Advertising 应查找与此用户列表定义匹配的操作) 时间 (天数。

withCondition("MembershipLifeSpan > 10")
名称 string 用户列表的名称。

withCondition("Name = 'foo'")
SizeForAudienceNetwork long 用户列表在受众网络中的大小。

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch long 用户列表在受众网络中的大小。

withCondition("SizeForSearch > 1000")
类型 string 用户列表的派生类型。 可能的区分大小写的值为：
  • 自定义
  • CUSTOMER_LIST
  • IN_MARKET
  • 逻辑
  • PRODUCT
  • RULE_BASED
  • 类似
此示例仅返回客户列表。

withCondition("Type = CUSTOMER_LIST")

参数

名称 类型 说明
条件 string 要添加到选择器的条件。

返回

类型 说明
UserListSelector 应用了条件的选择器。

withIds (string[] ids)

获取具有指定 ID 的用户列表。

可以对选择器应用一个或多个条件。 条件链被视为 AND 操作。 例如，仅当条件 A 为 True 且条件 B 为 true 时，才会选择实体。 例如，以下调用仅选择用户列表 33333。

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

参数

名称 类型 说明
ids string[] 用户列表 ID 的数组。 有关限制，请参阅 脚本执行限制。

返回

类型 说明
UserListSelector 应用了 ID 的选择器。

withLimit (int limit)

获取与选择条件匹配的前 n 个 用户列表。

参数

名称 类型 说明
limit int 要返回的用户列表数。 实际数字可能更少。

返回

类型 说明
UserListSelector 应用了限制的选择器。

另请参阅

  • Last updated on