次の方法で共有


LabelSelector

アカウント内のラベルの一覧をフィルター処理および順序付けするためのメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。

メソッド

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

取得

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

戻り値

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

orderBy(string orderBy)

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

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

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

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

selector = selector.orderBy("Name");

KeywordCount などの count 列を指定すると、セレクターは count 順に並べ替え、名前は昇順で並べ替えられます。

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

引数

名前 説明
Orderby 文字列 適用する順序。

戻り値

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

withCondition(String condition)

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

"columnName 演算子値" という形式で condition パラメーターを指定します。

演算子

使用する演算子は、列の型によって異なります。 演算子では大文字と小文字が区別されます。 たとえば、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

ラベル フィルター処理でサポートされている列。 列名は大文字と小文字を区別します。

Column
名前 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 文字列 セレクターに追加する条件。

戻り値

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

withIds(string[] ids)

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

セレクターに 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 制限が適用されたセレクター。

関連項目