CampaignSelector

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

使用例:

    var iterator = AdsApp.campaigns()
        .withCondition("ClickConversionRate > 0.3")
        .forDateRange("LAST_WEEK")
        .orderBy("Clicks DESC")
        .get();

    while (iterator.hasNext()) {
        var campaign = iterator.next();
        var metrics = campaign.getStats();
    }

メソッド

forDateRange(Object dateFrom, Object dateTo)

パフォーマンス メトリックを選択するために開始日と終了日を適用します。

以下の場合にのみ日付範囲を指定します。

• パフォーマンス メトリック フィールドを参照する条件または順序を適用します。
• 選択しているオブジェクトのパフォーマンス データを取得したい場合。 たとえば、 getStats() メソッドを呼び出す予定の場合などです。

日付パラメータは、文字列またはオブジェクトを使用して指定できます。 文字列を使用するには、YYYYMMDD というフォームで日付を指定します。 オブジェクトを使用する場合は、次のフィールドを持つオブジェクトを作成します。

• year
• month
• day

例:

var date = {year: 2018, month: 5, day: 13};

月は 1 ベースで、1 は 1 月、12 は 12 月です。

日付範囲は両端を含む。 複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。

引数

戻り値

forDateRange(string dateRange)

パフォーマンス メトリックを選択するために定義済みの日付範囲を適用します。

サポートされている日付範囲の値:

• TODAY
• 昨日
• LAST_WEEK
• LAST_BUSINESS_WEEK
• LAST_7_DAYS
• THIS_WEEK_SUN_TODAY
• LAST_14_DAYS
• LAST_30_DAYS
• LAST_WEEK_SUN_SAT
• THIS_MONTH
• LAST_MONTH
• ALL_TIME

以下の場合にのみ日付範囲を指定します。

• パフォーマンス メトリック フィールドを参照する条件または順序を適用します。
• 選択しているオブジェクトのパフォーマンス データを取得したい場合。 たとえば、 getStats() メソッドを呼び出す予定の場合などです。

複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。

引数

戻り値

get

キャンペーンの一覧を反復処理するために使用される 反復子 を取得します。

戻り値

orderBy(string, orderBy)

選択したキャンペーンに、指定された順序を適用します。

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

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

たとえば、次の呼び出しでは、AverageCPC の昇順でキャンペーンが返されます。

selector = selector.orderBy("AverageCpc");

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

引数

戻り値

withCondition(string condition)

キャンペーン キャンペーンのリストにフィルターを適用します。

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

• columnName は 、サポートされている列の 1 つです。 columName がパフォーマンス メトリックの列名に設定されている場合は、forDateRange(String dateRange) または forDateRange(Object dateFrom, Object dateTo) を使用して期間を指定する必要があります。
• 演算子 は、サポートされている 演算子の 1 つです。

演算子

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

キャンペーン フィルタリングでサポートされている列。 列名は大文字と小文字を区別します。

指定可能なパフォーマンス メトリック列を次に示します。

指定できるエンティティ プロパティを次に示します。

引数

戻り値

withIds(string[], ids)

指定した ID のキャンペーンを取得します。

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

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

引数

戻り値

withLimit(int limit)

選択条件に一致する上位 n 個のキャンペーンを取得します。

引数

戻り値

関連項目

• CampaignIterator
• Campaign