AssetGroupSelector

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

使用例:

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

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

メソッド

メソッド名 戻り値の型 説明
get AssetGroupIterator アセット グループの一覧を反復処理するために使用される反復子を取得します。
orderBy(string, orderBy) AssetGroupSelector 選択した資産グループに、指定された順序を適用します。
withCondition(string condition) AssetGroupSelector アセット グループにフィルター条件を適用します。
withIds(string[], ids) AssetGroupSelector 指定した ID の資産グループを取得します。
withLimit(int limit) AssetGroupSelector 選択基準に一致する上位 n 個の資産グループを取得します。

get

アセット グループの一覧を反復処理するために使用される 反復子 を取得します。

戻り値

型 説明
AssetGroupIterator 選択したアセット グループを反復処理するために使用される反復子。

orderBy(String orderBy)

選択した資産グループに、指定された順序を適用します。

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

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

たとえば、次の呼び出しは、AverageCpc の昇順で資産グループを返します。

selector = selector.orderBy("AverageCpc");

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

引数

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

戻り値

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

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

サポートされている列

資産グループのフィルター処理でサポートされている列。 名前の大文字と小文字は区別されます。

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

列 型 例
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc double withCondition("AverageCpc < 2.75")
AverageCpm double withCondition("AverageCpm > 0.65")
ClickConversionRate double withCondition("ClickConversionRate > 0.25")
クリック数 long withCondition("Clicks >= 33")
ConvertedClicks long withCondition("ConvertedClicks >= 10")
コスト double withCondition("Cost > 3.25")

コストはアカウントの通貨で計算されます。
Ctr double withCondition("Ctr > 0.05")

CTR は 0..1 の範囲なので、CTR が 5% の場合は 0.05 を使用します。
インプレッション long withCondition("Impressions > 10")
TopImpressionRate double withCondition("TopImpressionRate > 0.25")

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

列 型 例
状態 列挙型 資産グループの状態。 大文字と小文字を区別できる値は次のとおりです。
  • 有効
  • 一時停止中
  • 削除済み
この例では、有効な資産グループのみが返されます。

withCondition("Status = ENABLED")
名前 string 資産グループの名前。

withCondition("Name CONTAINS_IGNORE_CASE 'sport'")
CampaignName string キャンペーン名。

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
KeywordMaxCpc double 資産グループの CPC 入札単価。 入札はアカウントの通貨で行われます。

withCondition("KeywordMaxCpc > 5.0")
CampaignStatus 列挙型 キャンペーンの状態。 大文字と小文字を区別できる値は次のとおりです。
  • 有効
  • 一時停止中
  • 削除済み
この例では、親キャンペーンが一時停止されている資産グループのみが返されます。

withCondition("CampaignStatus = PAUSED")
LabelNames 文字列セット 大文字と小文字が区別される 1 つ以上のラベル名の一覧。 名前付きラベルに関連付けられた資産グループを取得するために使用します。

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
CampaignType 列挙型 キャンペーンのタイプ。 大文字と小文字を区別できる値は次のとおりです。
  • SEARCH_AND_CONTENT
  • ショッピング
  • DYNAMIC_SEARCH_ADS
この例では、親キャンペーンがショッピングであるアセット グループのみが返されます。

withCondition("CampaignType = SHOPPING")

引数

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

戻り値

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

withIds(string[], ids)

指定した ID の資産グループを取得します。

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

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

引数

名前 型 説明
ids string[] 資産グループ ID の配列。 制限については、「 スクリプト実行制限」を参照してください。

戻り値

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

withLimit(int limit)

選択基準に一致する上位 n 個の資産グループを取得します。

引数

名前 型 説明
limit int 返す資産グループの数。 実際の数は少ない場合があります。

戻り値

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

関連項目

Campaign.assetGroups()

  • Last updated on