LabelSelector

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

方法

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

取得

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

傳回

類型 描述
LabelIterator 用來逐一查看所選標籤的反覆運算器。

orderBy (字串 orderBy)

將指定的順序套用至選取的標籤。

在 “columnName orderDirection” 表單中指定 orderBy 參數，其中：

  • columnName 是支援的其中一個 欄位。
  • orderDirection 是要針對結果排序的順序。 設定為 ASC 以遞增順序排序結果，或設定為 DESC 以遞減順序排序結果。 預設值為 ASC。

例如，下列呼叫會依標籤名稱遞增順序傳回結果。

selector = selector.orderBy("Name");

如果您指定計數資料行，例如 KeywordCount，選取器會依計數排序，然後依名稱遞增排序。

選取器僅支援依一個欄位來排序實體。 您不得依欄位 x、在 x 內依欄位 y 排序實體清單，依此類推。 如果您在鏈結或單獨的選擇器呼叫中指定多個 orderBy() 呼叫，則指令碼會使用上次 orderBy() 呼叫中指定的欄位對實體清單進行排序。 

引數

名稱 類型 描述
orderBy 字串 要申請的順序。

傳回

類型 描述
LabelSelector 已套用排序的選擇器。

withCondition (字串條件)

將篩選條件套用至標籤。

在「columnName operator value」表單中指定 條件 參數，其中：

  • columnName 是支援的其中一個 欄位。
  • 運算子 是支援的 運算子之一。

運算子

您使用的運算子取決於資料欄位的類型。 運算子會區分大小寫。 例如，使用 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("Name = 'foo'")
KeywordCount 字串 與標籤相關聯的關鍵字數目。

withCondition("KeywordCount > 5")
AdCount 字串 與標籤相關聯的廣告數目。

withCondition("AdCount > 5")
AdGroupCount 字串 與標籤相關聯的廣告群組數目。

withCondition("AdGroupCount > 5")
CampaignCount 字串 與標籤相關聯的廣告活動數目。

withCondition("CampaignCount > 5")

引數

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

傳回

類型 描述
LabelSelector 具有套用條件的選擇器。

withIds (string[] ids)

取得具有指定識別碼的標籤。

您可以將一或多個條件套用至選取器。 條件鏈會被視為 AND 運算。 例如，只有在條件 A 為 True 且條件 B 為 True 時，才會選取實體。 例如，下列呼叫只會選取標籤 33333。

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

引數

名稱 類型 描述
IDS string[] 標籤識別碼的陣列。 如需限制，請參閱 指令碼執行限制。

傳回

類型 描述
LabelSelector 具有套用識別碼的選擇器。

withLimit (int limit)

取得符合選取準則的前 n 個標籤。

引數

名稱 類型 描述
限制 int 要傳回的標籤數目。 實際數字可能會更少。

傳回

類型 描述
LabelSelector 已套用限制的選取器。

另請參閱

  • Last updated on