TargetedLocationSelector
対象となる場所の一覧をフィルター処理および順序付けするためのメソッドが含まれます。 セレクターの詳細については、「 セレクター」を参照してください。
使用例:
var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();
var iterator = shoppingCampaign.targeting().targetedLocations()
.withLimit(10)
.withIds("123456789")
.get();
while (iterator.hasNext()) {
var targetedLocation = iterator.next();
}
メソッド
| メソッド名 | 戻り値の型 | 説明 |
|---|---|---|
| forDateRange(Object dateFrom, Object dateTo) | TargetedLocationSelector | パフォーマンス メトリックを選択するための開始日と終了日を適用します。 |
| forDateRange(string dateRange) | TargetedLocationSelector | パフォーマンス メトリックを選択するための定義済みの日付範囲を適用します。 |
| get | TargetedLocationIterator | 対象となる場所の一覧を反復処理するために使用される反復子を取得します。 |
| orderBy(string orderBy) | TargetedLocationSelector | 選択した対象の場所に指定した順序を適用します。 |
| withCondition(string condition) | TargetedLocationSelector | 対象となる場所にフィルター条件を適用します。 |
| withIds(string[] ids) | TargetedLocationSelector | 指定した ID を持つターゲットの場所を取得します。 |
| withLimit(int limit) | TargetedLocationSelector | 選択条件に一致する上位 n 個のターゲットの場所を取得します。 |
forDateRange(Object dateFrom, Object dateTo)
パフォーマンス メトリックを選択するための開始日と終了日を適用します。
日付範囲は、次の場合にのみ指定します。
- パフォーマンス メトリック フィールドを参照する条件または順序を適用します。
- 選択しているオブジェクトのパフォーマンス データを取得する必要があります。 たとえば、 メソッドを呼び出す予定の
getStats()場合です。
日付パラメーターは、文字列またはオブジェクトを使用して指定できます。 文字列を使用するには、YYYYMMDD という形式で日付を指定します。 オブジェクトを使用する場合は、次のフィールドを含むオブジェクトを作成します。
- year
- month
- 日
例:
var date = {year: 2018, month: 5, day: 13};
月は 1 から始まります。1 は 1 月、12 日は 12 月です。
日付範囲は包括的です。 複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| dateFrom | オブジェクト | セレクターに含めるパフォーマンス データを指定する日付範囲の開始日。 |
| dateTo | オブジェクト | セレクターに含めるパフォーマンス データを指定する日付範囲の終了日。 |
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationSelector | 日付範囲が適用されたセレクター。 |
forDateRange(String dateRange)
パフォーマンス メトリックを選択するための定義済みの日付範囲を適用します。
サポートされている日付範囲の値:
- 本日は
- 昨日
- 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()場合です。
複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| dateRange | String | セレクターに含めるパフォーマンス データを指定する定義済みの日付範囲文字列。 定義済みの日付範囲文字列では、大文字と小文字が区別されます。 |
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationSelector | 日付範囲が適用されたセレクター。 |
取得
対象となる場所の一覧を反復処理するために使用される 反復子 を取得します。
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationIterator | 選択した対象の場所を反復処理するために使用される反復子。 |
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 | 適用する順序。 |
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationSelector | 順序付けが適用されたセレクター。 |
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
ターゲットの場所のフィルター処理でサポートされている列。 列名は大文字と小文字を区別します。
指定できるパフォーマンス メトリック列を次に示します。
| Column | 型 | 例 | Microsoft Advertising Web UI フィルター |
|---|---|---|---|
| AbsoluteTopImpressionRate | double | withCondition("AbsoluteTopImpressionRate > 0.25") |
Abs. Top Impr. Rate |
| AverageCpc | double | withCondition("AverageCpc < 2.75") |
平均クリック単価 |
| AverageCpm | double | withCondition("AverageCpm > 0.65") |
平均 CPM |
| ClickConversionRate | double | withCondition("ClickConversionRate > 0.25") |
Conv. Rate |
| クリック | 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 を使用します。 |
Ctr |
| インプレッション | long | withCondition("Impressions > 10") |
Impr。 |
| TopImpressionRate | double | withCondition("TopImpressionRate > 0.25") |
トップ インパー。 Rate |
引数
| 名前 | 型 | 説明 |
|---|---|---|
| condition | 文字列 | セレクターに追加する条件。 |
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationSelector | 条件が適用されたセレクター。 |
withIds(string[] ids)
指定した ID を持つターゲットの場所を取得します。
セレクターに 1 つ以上の条件を適用できます。 条件のチェーンは AND 演算と見なされます。 たとえば、条件 A が true の場合にのみエンティティが選択され、条件 B が true です。 たとえば、次の呼び出しでは、対象となる場所 72 のみが選択されます。
var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();
var iterator = shoppingCampaign.targeting().targetedLocations()
.withIds(["32", "72"])
.withIds(["72", "190"]);
引数
| 名前 | 型 | 説明 |
|---|---|---|
| ids | string[] | ターゲットの場所 ID の配列。 制限については、「スクリプトの 実行制限」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationSelector | ID が適用されたセレクター。 |
withLimit(int limit)
選択条件に一致する上位 n 個のターゲットの場所を取得します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| limit | int | 返す対象の場所の数。 実際の数値が小さい場合があります。 |
戻り値
| 型 | 説明 |
|---|---|
| TargetedLocationSelector | 制限が適用されたセレクター。 |