共用方式為

UserListSelector

  • 發行項

包含在帳戶中篩選和排序使用者清單的方法。 如需選取器的相關資訊，請參閱 選取器。

方法

方法名稱 傳回類型 說明
get UserListIterator 取得用來逐一查看使用者清單清單的反覆運算器。
orderBy (字串 orderBy) UserListSelector 將指定的順序套用至選取的使用者清單。
withCondition (字串條件) UserListSelector 將篩選準則套用至使用者清單。
withIds (string[] ids) UserListSelector 取得具有指定識別碼的使用者清單。
withLimit (int 限制) UserListSelector 取得符合選取準則的前 n 個使用者清單。

獲取

取得用來逐一查看使用者清單清單的 反覆運算器 。

傳回

類型 說明
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 字串 要套用的順序。

傳回

類型 說明
UserListSelector 已套用排序的選取器。

withCondition (字串條件)

將篩選準則套用至使用者清單。

指定 「columnName 運算子值」 格式 的條件 參數，其中：

  • columnName 是其中一個 [支援的資料行] (#supported-user list-columns) 。
  • 運算子 是其中一個支援的 運算子。

運算子

您使用的運算子取決於資料行的類型。 運算子會區分大小寫。 例如，使用 STARTS_WITH 而非 starts_with。

包含整數和長值之資料行的運算子：

<
<=
>
>=
=
!=

包含雙精度浮點數之資料行的運算子：

<
>

包含字串值之資料行的運算子：

=
!=
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

支援用於使用者清單篩選的資料行。 資料行名稱會區分大小寫。

欄位 類型 範例
描述 字串 使用者清單的描述。

withCondition("Description = 'foo'")
MembershipLifeSpan int ) Microsoft Advertising 應該尋找符合此使用者清單定義的動作 (天數。

withCondition("MembershipLifeSpan > 10")
名稱 字串 使用者清單的名稱。

withCondition("Name = 'foo'")
SizeForAudienceNetwork long 使用者清單在物件網路中的大小。

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch long 使用者清單在物件網路中的大小。

withCondition("SizeForSearch > 1000")
類型 字串 使用者清單的衍生類型。 可能區分大小寫的值為：
  • 自 定義
  • CUSTOMER_LIST
  • IN_MARKET
  • 邏輯
  • 產品
  • RULE_BASED
  • 類似
此範例只會傳回客戶清單。

withCondition("Type = CUSTOMER_LIST")

引數

名稱 類型 說明
條件 字串 要新增至選取器的條件。

傳回

類型 說明
UserListSelector 已套用條件的選取器。

withIds (string[] ids)

取得具有指定識別碼的使用者清單。

您可以將一或多個條件套用至選取器。 條件鏈結會被視為 AND 作業。 例如，只有在條件 A 為 true 且條件 B 為 true 時，才會選取實體。 例如，下列呼叫只會選取使用者清單 33333。

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

引數

名稱 類型 說明
Id string[] 使用者清單識別碼的陣列。 如需限制，請參閱 腳本執行限制。

傳回

類型 說明
UserListSelector 已套用識別碼的選取器。

withLimit (int 限制)

取得符合選取準則的前 n 個使用者清單。

引數

名稱 類型 說明
限制 int 要傳回的使用者清單數目。 實際數目可能較少。

傳回

類型 說明
UserListSelector 已套用限制的選取器。

另請參閱