LabelSelector

アカウント内のラベルのリストをフィルター処理し、並べ替えるためのメソッドが含まれます。 セレクターの詳細については、「 セレクター」を参照してください。

メソッド

メソッド名 戻り値の型 説明
get LabelIterator ラベルのリストを反復処理するために使用される反復子を取得します。
orderBy(string, orderBy) LabelSelector 選択したラベルに指定された順序を適用します。
withCondition(string condition) LabelSelector フィルター条件をラベルに適用します。
withIds(string[], ids) LabelSelector 指定した ID のラベルを取得します。
withLimit(int limit) LabelSelector 選択条件に一致する上位 n 個のラベルを取得します。

get

ラベルのリストを反復処理するために使用される 反復子 を取得します。

戻り値

型 説明
LabelIterator 選択したラベルを反復処理するために使用される反復子。

orderBy(string, orderBy)

選択したラベルに指定された順序を適用します。

orderBy パラメーターを "columnName orderDirection" の形式で指定します。

  • columnName は 、サポートされている列の 1 つです。
  • orderDirection は、結果を並べ替える順序です。 結果を昇順で並べ替える場合は ASC に設定し、結果を降順で並べ替える場合は DESC に設定します。 既定値は ASC です。

たとえば、次の呼び出しは、ラベルの名前の昇順で結果を返します。

selector = selector.orderBy("Name");

KeywordCount などの個数列を指定した場合、セレクターは個数で並べ替え、次に名前で昇順で並べ替えます。

セレクターは、1 つのフィールドによるエンティティの順序付けのみをサポートします。 エンティティのリストは、フィールド x で並べ替えることはできません。x 内ではフィールド y で並べ替えるというようにもできません。 チェーンまたは個別のセレクター呼び出しで複数の orderBy() 呼び出しを指定した場合、スクリプトは最後の orderBy() 呼び出しで指定されたフィールドを使用してエンティティのリストを並べ替えます。 

引数

名前 型 説明
orderBy string 適用する順序。

戻り値

型 説明
LabelSelector 順序が適用されたセレクター。

withCondition(String condition)

フィルター条件をラベルに適用します。

条件パラメーターを "columnName operator value" の形式で指定します。

演算子

使用する演算子は、列の型によって異なります。 演算子では大文字と小文字が区別されます。 たとえば、starts_with の代わりに STARTS_WITH を使用します。

整数値と long 値を含む列の演算子:

<
<=
>
>=
=
!=

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("Name = 'foo'")
KeywordCount string ラベルに関連付けられているキーワードの数。

withCondition("KeywordCount > 5")
AdCount string ラベルに関連付けられている広告の数。

withCondition("AdCount > 5")
AdGroupCount string ラベルに関連付けられている広告グループの数。

withCondition("AdGroupCount > 5")
CampaignCount string ラベルに関連付けられているキャンペーンの数。

withCondition("CampaignCount > 5")

引数

名前 型 説明
condition string セレクターに追加する条件。

戻り値

型 説明
LabelSelector 条件が適用されたセレクター。

withIds(string[], ids)

指定した ID のラベルを取得します。

1 つのセレクターに 1 つ以上の条件を適用できます。 条件のチェーンは、AND 演算と見なされます。 たとえば、条件 A が True かつ条件 B が True の場合にのみエンティティが選択されます。 たとえば、次の呼び出しでは、ラベル 33333 のみが選択されます。

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

引数

名前 型 説明
ids string[] ラベル ID の配列。 制限については、「 スクリプト実行制限」を参照してください。

戻り値

型 説明
LabelSelector ID が適用されたセレクター。

withLimit(int limit)

選択条件に一致する上位 n 個のラベルを取得します。

引数

名前 型 説明
limit int 返されるラベルの数。 実際の数は少ない場合があります。

戻り値

型 説明
LabelSelector 制限が適用されたセレクター。

関連項目

  • Last updated on