NegativeKeywordListSelector

除外キーワード リストをフィルタリングして並べ替えるメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。

使用例:

    var iterator = AdsApp.negativeKeywordLists()
        .withCondition("MemberCount > 10")
        .orderBy("Name")
        .get();

    while (iterator.hasNext()) {
        var nkwList = iterator.next();
    }

メソッド

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

get

除外キーワード リストのリストを反復処理するために使用する 反復子 を取得します。

戻り値

型 説明
NegativeKeywordListIterator 除外キーワード リストを反復処理するために使用される反復子。

orderBy(string, orderBy)

選択した除外キーワード リストに、指定された順序を適用します。

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

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

たとえば、次の呼び出しは、MemberCount の昇順で除外キーワード リストを返します。

selector = selector.orderBy("MemberCount");

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

引数

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

戻り値

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

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

サポートされる列。 列名は大文字と小文字を区別します。

列 型 例
MemberCount int リスト内の除外キーワードの数。

withCondition("MemberCount > 10")
名前 string 除外キーワード (keyword) リストの名前。

withCondition("Name = 'LIST NAME GOES HERE'")
ReferenceCount int リストが関連付けられているキャンペーンの数。

withCondition("ReferenceCount > 10")
SharedSetId double 除外キーワード (keyword) リストの ID。 これを単に等価比較に使用する場合は、代わりに withIds メソッドの使用を検討してください。

withCondition("SharedSetId = 123456789")

引数

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

戻り値

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

withIds(string[], ids)

指定された ID の除外キーワード リストを取得します。

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

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

引数

名前 型 説明
ids string[] 負のキーワード (keyword) リスト ID の配列。 制限については、「 スクリプト実行制限」を参照してください。

戻り値

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

withLimit(int limit)

選択条件に一致する上位 n 個の除外キーワード リストを取得します。

引数

名前 型 説明
limit int 返す除外キーワード リストの数。 実際の数は少ない場合があります。

戻り値

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

関連項目

  • Last updated on