包含篩選和排序使用者有權存取的帳戶清單的方法。 如需選取器的相關資訊,請參閱 選取器。
使用範例:
var accounts = AccountsApp.accounts()
.withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
.get();
while (accounts.hasNext()) {
var account = accounts.next();
}
方法
| 方法名稱 | 傳回類型 | 描述 |
|---|---|---|
| executeInParallel (字串 functionName, 字串 optionalCallbackFunctionName) | void | 針對選取器傳回的每個帳戶執行函數。 |
| executeInParallel (字串 functionName, 字串 optionalCallbackFunctionName, 字串 optionalInput) | void | 針對選取器傳回的每個帳戶執行函數。 |
| forDateRange (Object dateFrom, Object dateTo) | BingAdsAccountSelector | 套用選取效能指標的開始日期和結束日期。 |
| forDateRange (字串 dateRange) | BingAdsAccountSelector | 套用預先定義的日期範圍以選取效能指標。 |
| get | BingAdsAccountIterator | 取得用來逐一查看帳戶清單的反覆運算器。 |
| orderBy (字串 orderBy) | BingAdsAccountSelector | 將指定的排序套用至選取的帳戶。 |
| withAccountNumbers (string[] accountNumbers) | BingAdsAccountSelector | 取得具有指定帳號的帳戶。 |
| withCondition (字串條件) | BingAdsAccountSelector | 將篩選條件套用至帳戶。 |
| withIds (string[] ids) | BingAdsAccountSelector | 取得具有指定識別碼的帳戶。 |
| withLimit (int limit) | BingAdsAccountSelector | 取得符合選取準則的前 n 個 帳戶。 |
executeInParallel (字串 functionName, 字串 optionalCallbackFunctionName)
針對選取器傳回的每個帳戶執行函數。 為所有選取的帳戶執行函式之後,指令碼會呼叫選用的回呼函式。
注意事項
每次指令碼執行時,指令碼最多可以同時執行 50 個帳戶。 您可以呼叫此方法一次或多次,但所有呼叫處理的帳戶總數不得超過 50 個。 如果呼叫超過指令碼的 50 個帳戶上限,則呼叫中的任何帳戶都不會執行。 若要限制選取器傳回的帳戶數目,請考慮使用 withLimit OR 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 | 字串 | 選取器傳回的每個帳戶要執行的函式名稱。 currentAccount 方法會識別函數正在處理的帳戶。 |
| optionalCallbackFunctionName | 字串 | 選用。 所有帳戶都執行完 functionName 函數之後,要執行的函式名稱。 此函數只會執行一次。 |
傳回
| 類型 | 描述 |
|---|---|
| void | 會傳回 nothing。 |
executeInParallel (字串 functionName, 字串 optionalCallbackFunctionName, 字串 optionalInput)
針對選取器傳回的每個帳戶執行函數。 為所有選取的帳戶執行函式之後,指令碼會呼叫選用的回呼函式。
注意事項
每次指令碼執行時,指令碼最多可以同時執行 50 個帳戶。 您可以呼叫此方法一次或多次,但所有呼叫處理的帳戶總數不得超過 50 個。 如果呼叫超過指令碼的 50 個帳戶上限,則呼叫中的任何帳戶都不會執行。 若要限制選取器傳回的帳戶數目,請考慮使用 withLimit OR 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 | 字串 | 選取器傳回的每個帳戶要執行的函式名稱。 currentAccount 方法會識別函數正在處理的帳戶。 |
| optionalCallbackFunctionName | 字串 | 選用。 所有帳戶都執行完 functionName 函數之後,要執行的函式名稱。 此函數只會執行一次。 |
| optionalInput | 字串 | 選用。 要傳遞給 functionName 函數的輸入。 |
傳回
| 類型 | 描述 |
|---|---|
| void | 會傳回 nothing。 |
forDateRange (Object dateFrom, Object dateTo)
套用選取效能指標的開始日期和結束日期。
只有在下列情況下才指定日期範圍:
- 您套用參照效能計量欄位的條件或排序。
- 您想要取得所選取物件的效能資料。 例如,如果您打算呼叫
getStats()方法。
您可以使用字串或物件指定日期參數。 若要使用字串,請以 YYYYMMDD 的形式指定日期。 如果您使用物件,請建立具有下列欄位的物件:
- 年
- 月
- 天
例如:
var date = {year: 2018, month: 5, day: 13};
月份為以一為基礎,其中 1 是 1 月,12 為 12 月。
日期範圍包括周邊。 如果您指定多個日期範圍,則只會使用最後一個日期範圍。
引數
| 名稱 | 類型 | 描述 |
|---|---|---|
| dateFrom | 物件 | 指定要包含在選取器中的廣告成效資料的日期範圍的開始日期。 |
| dateTo | 物件 | 指定要包含在選取器中的廣告成效資料之日期範圍的結束日期。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 已套用日期範圍的選取器。 |
forDateRange (字串 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 | 字串 | 預先定義的日期範圍字串,指定要包含在選取器中的廣告成效資料。 預先定義的日期範圍字串會區分大小寫。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 已套用日期範圍的選取器。 |
取得
取得用來逐一查看帳戶清單的 反覆運算器 。
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccount | 用來逐一查看所選帳戶的反覆運算器。 |
orderBy (字串 orderBy)
將指定的排序套用至選取的帳戶。
在 “columnName orderDirection” 表單中指定 orderBy 參數,其中:
- columnName 是支援的其中一個 欄位。
- orderDirection 是要針對結果排序的順序。 設定為 ASC 以遞增順序排序結果,或設定為 DESC 以遞減順序排序結果。 預設值為 ASC。
例如,下列呼叫會以 [點選次數] 遞增順序傳回結果。
selector = selector.orderBy("Clicks");
選取器僅支援依一個欄位來排序實體。 您不得依欄位 x、在 x 內依欄位 y 排序實體清單,依此類推。 如果您在鏈結或單獨的選擇器呼叫中指定多個 orderBy() 呼叫,則指令碼會使用上次 orderBy() 呼叫中指定的欄位對實體清單進行排序。
引數
| 名稱 | 類型 | 描述 |
|---|---|---|
| orderBy | 字串 | 要申請的順序。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 已套用排序的選擇器。 |
withAccountNumbers (string[] accountNumbers)
取得具有指定帳號的帳戶。
引數
| 名稱 | 類型 | 描述 |
|---|---|---|
| accountNumbers | string[] | 帳號陣列。 如需限制,請參閱 指令碼執行限制。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 已套用帳戶號碼的選取器。 |
withCondition (字串條件)
將篩選條件套用至帳戶。
在「columnName operator value」表單中指定 條件 參數,其中:
- columnName 是支援的其中一個 欄位。 如果 columName 設定為效能計量資料行名稱,您必須使用 forDateRange (字串 dateRange) 或 forDateRange (Object dateFrom, Object dateTo) 指定日期範圍。
- 運算子 是支援的 運算子之一。
運算子
您使用的運算子取決於資料欄位的類型。 運算子會區分大小寫。 例如,使用 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
以下是您可以指定的效能計量資料欄位。
| 欄位 | 類型 | 範例 | Microsoft Advertising Web UI 篩選條件 |
|---|---|---|---|
| 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")點選率在 0..1 的範圍內,因此使用 0.05 表示 5% 的點選率。 |
點選率 |
| 閱聽 | long | withCondition("Impressions > 10") |
IMPR. |
以下是您可以指定的帳戶屬性。
| 欄位 | 類型 | 範例 | Microsoft Advertising Web UI 篩選條件 |
|---|---|---|---|
| CurrencyCode | 字串 | 帳戶所用貨幣的貨幣代碼。 例如,USD 代表美國元。withCondition("CurrencyCode = USD") |
|
| ManagerCustomerId | 字串 | 管理帳戶之使用者的客戶識別碼。withCondition("ManagerCustomerId = '123456789'") |
|
| 名稱 | 字串 | 受管理帳戶的名稱。withCondition("Name CONTAINS_IGNORE_CASE 'foo'") |
引數
| 名稱 | 類型 | 描述 |
|---|---|---|
| 條件 | 字串 | 要新增至選取器的條件。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 具有套用條件的選擇器。 |
withIds (string[] ids)
取得具有指定識別碼的帳戶。
您可以將一或多個條件套用至選取器。 條件鏈會被視為 AND 運算。 例如,只有在條件 A 為 True 且條件 B 為 True 時,才會選取實體。 例如,下列呼叫只會選取帳戶 33333。
AccountsApp.accounts()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
.get();
引數
| 名稱 | 類型 | 描述 |
|---|---|---|
| IDS | string[] | 帳戶識別碼的陣列。 如需限制,請參閱 指令碼執行限制。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 具有套用識別碼的選擇器。 |
withLimit (int limit)
取得符合選取準則的前 n 個 帳戶。
引數
| 名稱 | 類型 | 描述 |
|---|---|---|
| 限制 | int | 要返回的帳戶數目。 實際數字可能會更少。 |
傳回
| 類型 | 描述 |
|---|---|
| BingAdsAccountSelector | 已套用限制的選取器。 |