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 個の負のキーワード リストを取得します。 |
取得
反復子を使用して、負のキーワード リストの一覧を反復処理します。
戻り値
型 | 説明 |
---|---|
NegativeKeywordListIterator | 負のキーワード リストを反復処理するために使用される反復子。 |
orderBy(string orderBy)
選択した負のキーワード リストに指定した順序を適用します。
"columnName orderDirection" という形式で orderBy パラメーターを指定します。
- columnName は、サポートされている列の 1 つです
- orderDirection は、結果を並べ替える順序です。 結果を昇順に並べ替える場合は ASC に、結果を降順に並べ替える場合は DESC に設定します。 既定値は ASC です。
たとえば、次の呼び出しでは、負のキーワード リストが MemberCount の昇順で返されます。
selector = selector.orderBy("MemberCount");
セレクターでは、1 つのフィールドによるエンティティの並べ替えのみがサポートされます。 フィールド x、x 内のエンティティの一覧をフィールド y ごとに並べ替えすることはできません。 チェーンまたは個別のセレクター呼び出しで複数 orderBy()
の呼び出しを指定した場合、スクリプトは最後 orderBy()
の呼び出しで指定されたフィールドを使用してエンティティの一覧を並べ替えます。
引数
名前 | 型 | 説明 |
---|---|---|
Orderby | 文字列 | 適用する順序。 |
戻り値
型 | 説明 |
---|---|
NegativeKeywordListSelector | 順序付けが適用されたセレクター。 |
withCondition(string condition)
除外キーワード リストにフィルター条件を適用します。
"columnName 演算子値" という形式で condition パラメーターを指定します。
- columnName は、 サポートされている列の 1 つです。
- operator は、サポートされている演算子の 1 つです。
演算子
使用する演算子は、列の型によって異なります。 演算子では大文字と小文字が区別されます。 たとえば、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 | 型 | 例 |
---|---|---|
MemberCount | int | リスト内の負のキーワードの数。withCondition("MemberCount > 10") |
名前 | string | 負のキーワード リストの名前。withCondition("Name = 'LIST NAME GOES HERE'") |
ReferenceCount | int | リストが関連付けられているキャンペーンの数。withCondition("ReferenceCount > 10") |
SharedSetId | double | 負のキーワード リストの ID。 単に等価比較にこれを使用する場合は、代わりに メソッドを withIds 使用することを検討してください。withCondition("SharedSetId = 123456789") |
引数
名前 | 型 | 説明 |
---|---|---|
condition | 文字列 | セレクターに追加する条件。 |
戻り値
型 | 説明 |
---|---|
NegativeKeywordListSelector | 条件が適用されたセレクター。 |
withIds(string[] ids)
指定した ID を持つ負のキーワード リストを取得します。
セレクターに 1 つ以上の条件を適用できます。 条件のチェーンは AND 演算と見なされます。 たとえば、条件 A が true の場合にのみエンティティが選択され、条件 B が true です。 たとえば、次の呼び出しでは、除外キーワード リスト 33333 のみが選択されます。
AdsApp.negativeKeywordLists()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
引数
名前 | 型 | 説明 |
---|---|---|
ids | string[] | 負のキーワード リスト ID の配列。 制限については、「スクリプトの 実行制限」を参照してください。 |
戻り値
型 | 説明 |
---|---|
NegativeKeywordListSelector | ID が適用されたセレクター。 |
withLimit(int limit)
選択条件に一致する上位 n 個の負のキーワード リストを取得します。
引数
名前 | 型 | 説明 |
---|---|---|
limit | int | 返す負のキーワード リストの数。 実際の数値が小さい場合があります。 |
戻り値
型 | 説明 |
---|---|
NegativeKeywordListSelector | 制限が適用されたセレクター。 |