製品グループの一覧をフィルター処理および並べ替えるためのメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。
使用例:
var iterator = AdsApp.productGroups()
.withCondition("ClickConversionRate > 0.3")
.forDateRange("LAST_WEEK")
.orderBy("Clicks DESC")
.get();
while (iterator.hasNext()) {
var productGroup = iterator.next();
var metrics = productGroup.getStats();
}
メソッド
| メソッド名 | 戻り値の型 | 説明 |
|---|---|---|
| forDateRange(Object dateFrom, Object dateTo) | ProductGroupSelector | パフォーマンス メトリックを選択するために開始日と終了日を適用します。 |
| forDateRange(string dateRange) | ProductGroupSelector | パフォーマンス メトリックを選択するために定義済みの日付範囲を適用します。 |
| get | ProductGroupIterator | 製品グループの一覧を反復処理するために使用される反復子を取得します。 |
| orderBy(string, orderBy) | ProductGroupSelector | 選択した製品グループに、指定した順序を適用します。 |
| withCondition(string condition) | ProductGroupSelector | フィルター条件を商品グループに適用します。 |
| withIds(string[], ids) | ProductGroupSelector | 指定した ID の商品グループを取得します。 |
| withLimit(int limit) | ProductGroupSelector | 選択基準に一致する上位 n 個の製品グループを取得します。 |
forDateRange(Object dateFrom, Object dateTo)
パフォーマンス メトリックを選択するために開始日と終了日を適用します。
以下の場合にのみ日付範囲を指定します。
- パフォーマンス メトリック フィールドを参照する条件または順序を適用します。
- 選択しているオブジェクトのパフォーマンス データを取得したい場合。 たとえば、
getStats()メソッドを呼び出す予定の場合などです。
日付パラメータは、文字列またはオブジェクトを使用して指定できます。 文字列を使用するには、YYYYMMDD というフォームで日付を指定します。 オブジェクトを使用する場合は、次のフィールドを持つオブジェクトを作成します。
- year
- month
- day
例:
var date = {year: 2018, month: 5, day: 13};
月は 1 ベースで、1 は 1 月、12 は 12 月です。
日付範囲は両端を含む。 複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| dateFrom | オブジェクト | セレクターに含めるパフォーマンス データを指定する日付範囲の開始日。 |
| dateTo | オブジェクト | セレクターに含めるパフォーマンス データを指定する日付範囲の終了日。 |
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupSelector | 日付範囲が適用されたセレクター。 |
forDateRange(String dateRange)
パフォーマンス メトリックを選択するために定義済みの日付範囲を適用します。
以下の場合にのみ日付範囲を指定します。
- パフォーマンス メトリック フィールドを参照する条件または順序を適用します。
- 選択しているオブジェクトのパフォーマンス データを取得したい場合。 たとえば、
getStats()メソッドを呼び出す予定の場合などです。
複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。
サポートされている日付範囲の値:
- 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
引数
| 名前 | 型 | 説明 |
|---|---|---|
| dateRange | 文字列 | セレクターに含めるパフォーマンス データを指定する定義済みの日付範囲文字列。 定義済みの日付範囲文字列では、大文字と小文字が区別されます。 |
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupSelector | 日付範囲が適用されたセレクター。 |
get
製品グループの一覧を反復処理するために使用される 反復子 を取得します。
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupIterator | 選択した製品グループを反復処理するために使用される反復子。 |
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 | 適用する順序。 |
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupSelector | 順序が適用されたセレクター。 |
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
サポートされている列
商品グループのフィルター処理でサポートされている列。 名前の大文字と小文字は区別されます。
指定可能なパフォーマンス メトリック列を次に示します。
| 列 | 型 | 例 |
|---|---|---|
| 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") |
指定できるエンティティ プロパティを次に示します。
| 列 | 型 | 例 |
|---|---|---|
| ProductGroup | string | 商品グループの値。 たとえば、パスが "All products > Sporting Goods > Winter Sports > Skiing > Skis > Downhill Skis > New" の場合は、オペランドを Skis に設定できます。withCondition("ProductGroup = Skis")セレクターには、スキー製品グループとその "それ以外のケース" 製品グループ (存在する場合) が含まれます。 オペランドとして 'OtherCase' を指定できないことに注意してください。 |
| Bid | double | 入札金額。 入札条件に一致するすべての商品グループを返します。withCondition("Bid < 2.75")'<' を使用すると、CPC 入札額が指定された金額未満か、null に設定されているグループが返されます。 セレクターに大文字と小文字が null 文字が含まれないようにするには、たとえば .withCondition("Bid < 2.75").withCondition("Bid > 0.0") を使用します。 |
引数
| 名前 | 型 | 説明 |
|---|---|---|
| condition | string | セレクターに適用する条件。 |
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupSelector | 条件が適用されたセレクター。 |
withIds(string[], ids)
指定した ID の商品グループを取得します。
1 つのセレクターに 1 つ以上の条件を適用できます。 条件のチェーンは、AND 演算と見なされます。 たとえば、条件 A が True かつ条件 B が True の場合にのみエンティティが選択されます。 たとえば、次の呼び出しでは、製品グループ 33333 のみが選択されます。
var selector = AdsApp.productGroups()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
引数
| 名前 | 型 | 説明 |
|---|---|---|
| ids | string[] | 製品グループ ID の配列。 制限については、「 スクリプト実行制限」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupSelector | ID が適用されたセレクター。 |
withLimit(int limit)
選択基準に一致する上位 n 個の製品グループを取得します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| limit | int | 返す製品グループの数。 実際の数は少ない場合があります。 |
戻り値
| 型 | 説明 |
|---|---|
| ProductGroupSelector | 制限が適用されたセレクター。 |