BingAdsAccountSelector

發行項
11/13/2024

包含篩選和排序使用者可存取之帳戶清單的方法。如需選取器的相關資訊，請參閱選取器。

範例使用方式：

    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 (字串 dateRange)	BingAdsAccountSelector	套用預先定義的日期範圍，以選取效能計量。
get	BingAdsAccountIterator	取得用來逐一查看帳戶清單的反覆運算器。
orderBy (字串 orderBy)	BingAdsAccountSelector	將指定的順序套用至選取的帳戶。
withAccountNumbers (string[] accountNumbers)	BingAdsAccountSelector	取得具有指定帳戶號碼的帳戶。
withCondition (字串條件)	BingAdsAccountSelector	將篩選準則套用至帳戶。
withIds (string[] ids)	BingAdsAccountSelector	取得具有指定識別碼的帳戶。
withLimit (int 限制)	BingAdsAccountSelector	取得符合選取準則的前 n 個帳戶。

executeInParallel (string functionName， string optionalCallbackFunctionName)

針對選取器傳回的每個帳戶執行函式。針對所有選取的帳戶執行函式之後，腳本會呼叫選擇性的回呼函式。

注意事項

每次執行腳本時，腳本最多可以平行執行 50 個帳戶。您可以呼叫此方法一次或多次，但所有呼叫進程的帳戶總數不得超過 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	字串	要針對選取器傳回的每個帳戶執行的函式名稱。 currentAccount方法會識別函式正在處理的帳戶。
optionalCallbackFunctionName	字串	選用。要在所有帳戶完成執行 functionName 函式之後執行的函式名稱。此函式只會執行一次。

傳回

類型	說明
void	會傳回 nothing。

executeInParallel (string functionName， string optionalCallbackFunctionName， string optionalInput)

針對選取器傳回的每個帳戶執行函式。針對所有選取的帳戶執行函式之後，腳本會呼叫選擇性的回呼函式。

注意事項

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 (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	字串	預先定義的日期範圍字串，指定要包含在選取器中的效能資料。預先定義的日期範圍字串會區分大小寫。

傳回

類型	說明
BingAdsAccountSelector	已套用日期範圍的選取器。

獲取

取得用來逐一查看帳戶清單的反覆運算器。

傳回

類型	說明
BingAdsAccount	用來逐一查看所選帳戶的反覆運算器。

orderBy (字串 orderBy)

將指定的順序套用至選取的帳戶。

以「columnName orderDirection」格式指定 orderBy 參數，其中：

columnName 是其中一個支援的資料行。
orderDirection 是排序結果的順序。設定為 ASC，以遞增順序排序結果或 DESC，以遞減順序排序結果。預設值為 ASC。

例如，下列呼叫會以 Clicks 的遞增順序傳回結果。

selector = selector.orderBy("Clicks");

選取器僅支援依一個欄位排序實體。您不能依欄位 x 排序實體清單，也無法依欄位 y 排序 x 中的實體清單，依此類推。如果您在鏈結或個別選取器呼叫中指定多個呼叫，則腳本會使用上 orderBy() 一個 orderBy() 呼叫中指定的欄位來排序實體清單。

引數

名稱	類型	說明
orderBy	字串	要套用的順序。

傳回

類型	說明
BingAdsAccountSelector	已套用排序的選取器。

withAccountNumbers (string[] accountNumbers)

取得具有指定帳戶號碼的帳戶。

引數

名稱	類型	說明
accountNumbers	string[]	帳戶號碼的陣列。如需限制，請參閱腳本執行限制。

傳回

類型	說明
BingAdsAccountSelector	已套用帳戶號碼的選取器。

withCondition (字串條件)

將篩選準則套用至帳戶。

指定「columnName 運算子值」格式 的條件 參數，其中：

columnName 是其中一個支援的資料行。如果 columName 設定為效能計量資料行名稱，您必須使用 forDateRange (String 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")`	Conv. Rate
點擊	long	`withCondition("Clicks >= 33")`	點擊
ConvertedClicks	long	`withCondition("ConvertedClicks >= 10")`	Conv。
成本	double	`withCondition("Cost > 3.25")` 成本是以帳戶的貨幣為單位。	花
點擊率	double	`withCondition("Ctr > 0.05")` CTR 的範圍為 0..1，因此使用 0.05 表示 5% CTR。	點擊率
閱聽	long	`withCondition("Impressions > 10")`	Impr。

以下是您可以指定的帳號屬性。

欄位	類型	範例
CurrencyCode	字串	帳戶所使用之貨幣的貨幣代碼。例如，美國美元。 `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();

引數

名稱	類型	說明
Id	string[]	帳戶識別碼的陣列。如需限制，請參閱腳本執行限制。

傳回

類型	說明
BingAdsAccountSelector	已套用識別碼的選取器。

withLimit (int 限制)

取得符合選取準則的前 n 個帳戶。

引數

名稱	類型	說明
限制	int	要傳回的帳戶數目。實際數目可能較少。

傳回

類型	說明
BingAdsAccountSelector	已套用限制的選取器。

共用方式為