ユーザーがアクセスできるアカウントのリストをフィルター処理し、並べ替えるためのメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。
使用例:
var accounts = AccountsApp.accounts()
.withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
.get();
while (accounts.hasNext()) {
var account = accounts.next();
}
メソッド
| メソッド名 | 戻り値の型 | 説明 |
|---|---|---|
| executeInParallel(string functionName, string optionalCallbackFunctionName) | void | セレクターが返す各アカウントについて関数を実行します。 |
| executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput) | void | セレクターが返す各アカウントについて関数を実行します。 |
| forDateRange(Object dateFrom, Object dateTo) | BingAdsAccountSelector | パフォーマンス メトリックを選択するために開始日と終了日を適用します。 |
| forDateRange(string dateRange) | BingAdsAccountSelector | パフォーマンス メトリックを選択するために定義済みの日付範囲を適用します。 |
| get | BingAdsAccountIterator | アカウントの一覧を反復処理するために使用される反復子を取得します。 |
| orderBy(string, orderBy) | BingAdsAccountSelector | 選択したアカウントに、指定された順序を適用します。 |
| withAccountNumbers(string[] accountNumbers) | BingAdsAccountSelector | 指定されたアカウント番号のアカウントを取得します。 |
| withCondition(string condition) | BingAdsAccountSelector | フィルター条件をアカウントに適用します。 |
| withIds(string[], ids) | BingAdsAccountSelector | 指定した ID のアカウントを取得します。 |
| withLimit(int limit) | BingAdsAccountSelector | 選択条件に一致する上位 n 個 のアカウントを取得します。 |
executeInParallel(string functionName, string optionalCallbackFunctionName)
セレクターが返す各アカウントについて関数を実行します。 選択したすべてのアカウントに対して関数が実行されると、スクリプトはオプションのコールバック関数を呼び出します。
注:
スクリプトは、スクリプトが実行されるたびに、最大 50 個のアカウントを並列で実行できます。 このメソッドは 1 回または複数回呼び出すことができますが、すべての呼び出しを処理するアカウントの総数が 50 を超えることはできません。 呼び出しがスクリプトの最大アカウント数である 50 を超えると、その呼び出しのいずれのアカウントも実行されません。 セレクターが返すアカウントの数を制限するには、 withLimit または withIds メソッドの使用を検討してください。
functionName 関数は、値を文字列として返すことができます。 複合オブジェクトを返すには、JSON.stringify メソッドを使用してオブジェクトを文字列に変換します。 その後、JSON.parse メソッドを使用して文字列をオブジェクトに変換し直すことができます。 関数が値を返す場合は、コールバック関数を指定して戻り値をキャプチャする必要があります。 次に、コールバック関数の署名を示します。 返される値は、 ExecutionResult オブジェクトの配列として渡されます。
function myCallback(ExecutionResult[] results)
次の例は、コールバック関数で返された値を処理する方法を示しています。
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
このメソッドは BingAdsAccountSelector オブジェクトを返さないので、このメソッドが呼び出しチェーンの最後のセレクター メソッドであることを確認してください。
例については、「 不承認の広告の検出」を参照してください。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| functionName | string | セレクターが返す各アカウントに対して実行する関数の名前。 currentAccount メソッドは、関数が処理しているアカウントを識別します。 |
| optionalCallbackFunctionName | string | 省略可能。 すべてのアカウントで functionName 関数の実行が終了した後に実行する関数の名前。 この関数は 1 回だけ実行されます。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput)
セレクターが返す各アカウントについて関数を実行します。 選択したすべてのアカウントで関数が実行された後、スクリプトはオプションのコールバック関数を呼び出します。
注:
スクリプトは、スクリプトが実行されるたびに、最大 50 個のアカウントを並列で実行できます。 このメソッドは 1 回または複数回呼び出すことができますが、すべての呼び出しを処理するアカウントの総数が 50 を超えることはできません。 呼び出しがスクリプトの最大アカウント数である 50 を超えると、その呼び出しのいずれのアカウントも実行されません。 セレクターが返すアカウントの数を制限するには、 withLimit または withIds メソッドの使用を検討してください。
functionName 関数は、値を文字列として返すことができます。 複合オブジェクトを返すには、JSON.stringify メソッドを使用してオブジェクトを文字列に変換します。 その後、JSON.parse メソッドを使用して文字列をオブジェクトに変換し直すことができます。 関数が値を返す場合は、コールバック関数を指定して戻り値をキャプチャする必要があります。 次に、コールバック関数の署名を示します。 返される値は、 ExecutionResult オブジェクトの配列として渡されます。
function myCallback(ExecutionResult[] results)
次の例は、コールバック関数で返された値を処理する方法を示しています。
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
省略可能な入力パラメーターを渡した場合、 functionName 関数のシグネチャを次のように示します。
function myFunction(string optionalInput)
このメソッドは BingAdsAccountSelector オブジェクトを返さないので、このメソッドが呼び出しチェーンの最後のセレクター メソッドであることを確認してください。
例については、「 不承認の広告の検出」を参照してください。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| functionName | string | セレクターが返す各アカウントに対して実行する関数の名前。 currentAccount メソッドは、関数が処理しているアカウントを識別します。 |
| optionalCallbackFunctionName | string | 省略可能。 すべてのアカウントで functionName 関数の実行が終了した後に実行する関数の名前。 この関数は 1 回だけ実行されます。 |
| optionalInput | string | 省略可能。 functionName 関数に渡す入力。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
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 | オブジェクト | セレクターに含めるパフォーマンス データを指定する日付範囲の終了日。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | 日付範囲が適用されたセレクター。 |
forDateRange(String dateRange)
パフォーマンス メトリックを選択するために定義済みの日付範囲を適用します。
サポートされている日付範囲の値:
- 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
以下の場合にのみ日付範囲を指定します。
- パフォーマンス メトリック フィールドを参照する条件または順序を適用します。
- 選択しているオブジェクトのパフォーマンス データを取得したい場合。 たとえば、
getStats()メソッドを呼び出す予定の場合などです。
複数の日付範囲を指定した場合は、最後の日付範囲のみが使用されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| dateRange | 文字列 | セレクターに含めるパフォーマンス データを指定する定義済みの日付範囲文字列。 定義済みの日付範囲の文字列では、大文字と小文字が区別されます。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | 日付範囲が適用されたセレクター。 |
get
アカウントの一覧を反復処理するために使用される 反復子 を取得します。
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccount | 選択したアカウントを反復処理するために使用される反復子。 |
orderBy(string, orderBy)
選択したアカウントに、指定された順序を適用します。
orderBy パラメーターを "columnName orderDirection" の形式で指定します。
- columnName は 、サポートされている列の 1 つです。
- orderDirection は、結果を並べ替える順序です。 結果を昇順で並べ替える場合は ASC に設定し、結果を降順で並べ替える場合は DESC に設定します。 既定値は ASC です。
たとえば、次の呼び出しはクリック数の昇順の結果を返します。
selector = selector.orderBy("Clicks");
セレクターは、1 つのフィールドによるエンティティの順序付けのみをサポートします。 エンティティのリストは、フィールド x で並べ替えることはできません。x 内ではフィールド y で並べ替えるというようにもできません。 チェーンまたは個別のセレクター呼び出しで複数の orderBy() 呼び出しを指定した場合、スクリプトは最後の orderBy() 呼び出しで指定されたフィールドを使用してエンティティのリストを並べ替えます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| orderBy | string | 適用する順序。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | 順序が適用されたセレクター。 |
withAccountNumbers(string[] accountNumbers)
指定されたアカウント番号のアカウントを取得します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| accountNumbers | string[] | アカウント番号の配列。 制限については、「 スクリプト実行制限」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | アカウント番号が適用されたセレクター。 |
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
アカウント フィルター処理でサポートされている列。 列名は大文字と小文字を区別します。
指定可能なパフォーマンス メトリック列を次に示します。
| 列 | 型 | 例 | Microsoft Advertising Web UI フィルター |
|---|---|---|---|
| ClickConversionRate | double | withCondition("ClickConversionRate > 0.25") |
コンバージョン率 |
| クリック数 | long | withCondition("Clicks >= 33") |
クリック数 |
| ConvertedClicks | long | withCondition("ConvertedClicks >= 10") |
Conv. |
| コスト | double | withCondition("Cost > 3.25")コストはアカウントの通貨で計算されます。 |
支出 |
| Ctr | double | withCondition("Ctr > 0.05")CTR は 0..1 の範囲なので、CTR が 5% の場合は 0.05 を使用します。 |
CTR |
| インプレッション | long | withCondition("Impressions > 10") |
Impr. |
指定できるアカウント プロパティを次に示します。
| 列 | 型 | 例 | Microsoft Advertising Web UI フィルター |
|---|---|---|---|
| CurrencyCode | string | アカウントで使用される通貨の通貨コード。 たとえば、米ドルは米国ドルです。withCondition("CurrencyCode = USD") |
|
| ManagerCustomerId | string | アカウントを管理しているユーザーの顧客 ID。withCondition("ManagerCustomerId = '123456789'") |
|
| 名前 | string | マネージド アカウントの名前。withCondition("Name CONTAINS_IGNORE_CASE 'foo'") |
引数
| 名前 | 型 | 説明 |
|---|---|---|
| condition | string | セレクターに追加する条件。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | 条件が適用されたセレクター。 |
withIds(string[], ids)
指定した ID のアカウントを取得します。
1 つのセレクターに 1 つ以上の条件を適用できます。 条件のチェーンは、AND 演算と見なされます。 たとえば、条件 A が True かつ条件 B が True の場合にのみエンティティが選択されます。 たとえば、次の呼び出しでは、アカウント 33333 のみが選択されます。
AccountsApp.accounts()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
.get();
引数
| 名前 | 型 | 説明 |
|---|---|---|
| ids | string[] | アカウント ID の配列。 制限については、「 スクリプト実行制限」を参照してください。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | ID が適用されたセレクター。 |
withLimit(int limit)
選択条件に一致する上位 n 個 のアカウントを取得します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| limit | int | 返すアカウントの数。 実際の数は少ない場合があります。 |
戻り値
| 型 | 説明 |
|---|---|
| BingAdsAccountSelector | 制限が適用されたセレクター。 |