BudgetSelector

共有予算の一覧をフィルター処理および並べ替えするためのメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。

使用例:

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

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

メソッド

forDateRange(Object dateFrom, Object dateTo)

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

日付範囲は、次の場合にのみ指定します。

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

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

• year
• month
• 日

例:

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

月は 1 から始まります。1 は 1 月、12 日は 12 月です。

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

引数

戻り値

forDateRange(String dateRange)

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

日付範囲は、次の場合にのみ指定します。

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

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

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

• 本日は
• 昨日
• 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

引数

戻り値

取得

共有予算の一覧を反復処理するために使用される 反復子 を取得します。

戻り値

orderBy(String orderBy)

選択した共有予算に指定した順序を適用します。

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

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

たとえば、次の呼び出しでは、AverageCpc の昇順で共有予算が返されます。

selector = selector.orderBy("AverageCpc");

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

引数

戻り値

withCondition(String condition)

共有予算にフィルター条件を適用します。

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

• columnName は、 サポートされている列の 1 つです。 columName がパフォーマンス メトリック列名に設定されている場合は、forDateRange(String dateRange) または forDateRange(Object dateFrom, Object dateTo) を使用して日付範囲を指定する必要があります。
• 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

サポートされる列

共有予算フィルター処理でサポートされている列。 名前では大文字と小文字が区別されます。

指定できるパフォーマンス メトリック列を次に示します。

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

引数

戻り値

withIds(string[] ids)

指定した ID を持つ共有予算を取得します。

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

var selector = AdsApp.budgets()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

引数

戻り値

withLimit(int limit)

選択条件に一致する上位 n 個の共有予算を取得します。

引数

戻り値

関連項目

AdsApp.budgets()