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 個の資産グループを取得します。 |
取得
資産グループの一覧を反復処理するために使用される 反復子 を取得します。
戻り値
型 | 説明 |
---|---|
AssetGroupIterator | 選択した資産グループを反復処理するために使用される反復子。 |
orderBy(String orderBy)
選択した資産グループに指定した順序を適用します。
"columnName orderDirection" という形式で orderBy パラメーターを指定します。
- columnName は、 サポートされている列の 1 つです。
- orderDirection は、結果を並べ替える順序です。 結果を昇順に並べ替える場合は ASC に、結果を降順に並べ替える場合は DESC に設定します。 既定値は ASC です。
たとえば、次の呼び出しでは、AverageCpc によって資産グループが昇順で返されます。
selector = selector.orderBy("AverageCpc");
セレクターでは、1 つのフィールドによるエンティティの並べ替えのみがサポートされます。 フィールド x、x 内のエンティティの一覧をフィールド y ごとに並べ替えすることはできません。 チェーンまたは個別のセレクター呼び出しで複数の orderBy()
呼び出しを指定した場合、スクリプトは最後の orderBy()
呼び出しで指定されたフィールドを使用してエンティティの一覧を並べ替えます。
引数
名前 | 型 | 説明 |
---|---|---|
orderBy | string | 適用する順序。 |
戻り値
型 | 説明 |
---|---|
AssetGroupSelector | 順序付けが適用されたセレクター。 |
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
サポートされる列
資産グループのフィルター処理でサポートされている列。 名前では大文字と小文字が区別されます。
指定できるパフォーマンス メトリック列を次に示します。
列 | 型 | 例 |
---|---|---|
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 であるため、5% の CTR には 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 | 資産グループのクリック単価。 入札はアカウントの通貨で行われます。withCondition("KeywordMaxCpc > 5.0") |
CampaignStatus | 列挙 | キャンペーンの状態。 大文字と小文字を区別する値は次のとおりです。
withCondition("CampaignStatus = PAUSED") |
LabelNames | 文字列セット | 1 つ以上の大文字と小文字を区別するラベル名の一覧。 を使用して、名前付きラベルに関連付けられた資産グループを取得します。withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']") |
CampaignType | 列挙 | キャンペーンの種類。 大文字と小文字を区別する値は次のとおりです。
withCondition("CampaignType = SHOPPING") |
引数
名前 | 型 | 説明 |
---|---|---|
condition | string | セレクターに適用する条件。 |
戻り値
型 | 説明 |
---|---|
AssetGroupSelector | 条件が適用されたセレクター。 |
withIds(string[] ids)
指定した ID を持つ資産グループを取得します。
セレクターに 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 | 制限が適用されたセレクター。 |