BingAdsAccountSelector

包含用于筛选和排序用户有权访问的帐户列表的方法。 有关选择器的信息，请参阅 选择器。

示例用法：

    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 (字符串 functionName、字符串 optionalCallbackFunctionName、字符串 optionalInput) void 为选择器返回的每个帐户执行该函数。
forDateRange (对象 dateFrom， 对象 dateTo) BingAdsAccountSelector 应用开始日期和结束日期来选择性能指标。
forDateRange (字符串 dateRange) BingAdsAccountSelector 应用预定义的日期范围来选择性能指标。
get BingAdsAccountIterator 获取用于循环访问帐户列表的迭代器。
orderBy (字符串 orderBy) BingAdsAccountSelector 将指定的顺序应用于所选帐户。
withAccountNumbers (string[] accountNumbers) BingAdsAccountSelector 获取具有指定帐号的帐户。
withCondition (字符串条件) BingAdsAccountSelector 将筛选条件应用于帐户。
withIds (string[] ids) BingAdsAccountSelector 获取具有指定 ID 的帐户。
withLimit (int limit) BingAdsAccountSelector 获取与选择条件匹配的前 n 个帐户。

executeInParallel (字符串 functionName， string 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 string 要为选择器返回的每个帐户执行的函数名称。 currentAccount 方法标识函数正在处理的帐户。
optionalCallbackFunctionName string 可选。 所有帐户执行完 functionName 函数后要执行的函数的名称。 此函数仅执行一次。

返回

类型 说明
void 不返回任何内容。

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 string 要为选择器返回的每个帐户执行的函数名称。 currentAccount 方法标识函数正在处理的帐户。
optionalCallbackFunctionName string 可选。 所有帐户执行完 functionName 函数后要执行的函数的名称。 此函数仅执行一次。
optionalInput string 可选。 要传递到 functionName 函数的输入。

返回

类型 说明
void 不返回任何内容。

forDateRange (对象 dateFrom， 对象 dateTo)

应用开始日期和结束日期来选择性能指标。

仅在以下情况下指定日期范围：

  • 应用引用性能指标字段的条件或顺序。
  • 你希望获取所选对象的性能数据。 例如，如果计划调用该 getStats() 方法。

可以使用字符串或对象指定日期参数。 若要使用字符串，请以 YYYYMMDD 格式指定日期。 如果使用对象，请使用以下字段创建对象：

  • year
  • month
  • day

例如：

var date = {year: 2018, month: 5, day: 13};

月份为基础，其中 1 为 1 月，12 为 12 月。

日期范围为包含。 如果指定多个日期范围，则仅使用最后一个日期范围。

参数

名称 类型 说明
dateFrom Object 日期范围的开始日期，该日期范围指定要包含在选择器中的性能数据。
dateTo Object 日期范围的结束日期，该日期范围指定要包含在选择器中的性能数据。

返回

类型 说明
BingAdsAccountSelector 应用日期范围的选择器。

forDateRange (字符串 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 String 预定义的日期范围字符串，用于指定要包含在选择器中的性能数据。 预定义的日期范围字符串区分大小写。

返回

类型 说明
BingAdsAccountSelector 应用日期范围的选择器。

get

获取用于循环访问帐户列表的 迭代器 。

返回

类型 说明
BingAdsAccount 用于循环访问所选帐户的迭代器。

orderBy (字符串 orderBy)

将指定的顺序应用于所选帐户。

在“columnName orderDirection”格式中指定 orderBy 参数，其中：

  • columnName 是 受支持的列之一。
  • orderDirection 是对结果排序所依据的顺序。 设置为 ASC 以按升序对结果进行排序，设置为 DESC 以按降序对结果进行排序。 默认值为 ASC。

例如，以下调用按点击次数升序返回结果。

selector = selector.orderBy("Clicks");

选择器仅支持按一个字段对实体进行排序。 您不能按字段 x 排序实体列表，按字段 y 排序 x 内的实体列表，等等。 如果在链或单独的选择器调用中指定多个 orderBy() 调用，脚本将使用上次 orderBy() 调用中指定的字段对实体列表进行排序。 

参数

名称 类型 说明
orderBy string 要应用的顺序。

返回

类型 说明
BingAdsAccountSelector 应用了排序的选择器。

withAccountNumbers (string[] accountNumbers)

获取具有指定帐号的帐户。

参数

名称 类型 说明
accountNumbers string[] 帐号数组。 有关限制，请参阅 脚本执行限制。

返回

类型 说明
BingAdsAccountSelector 应用帐号的选择器。

withCondition (字符串条件)

将筛选条件应用于帐户。

在“columnName operator value”格式中指定 条件 参数，其中：

运算符

使用的运算符取决于列的类型。 运算符区分大小写。 例如，使用 STARTS_WITH 而不是 starts_with。

包含整数和长值的列的运算符：

<
<=
>
>=
=
!=

包含 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")

成本以帐户货币为单位。		 支出
中心 double withCondition("Ctr > 0.05")

CTR 在 0..1 范围内，因此对于 5% 的 CTR 使用 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'")

参数

名称 类型 说明
条件 string 要添加到选择器的条件。

返回

类型 说明
BingAdsAccountSelector 应用了条件的选择器。

withIds (string[] ids)

获取具有指定 ID 的帐户。

可以对选择器应用一个或多个条件。 条件链被视为 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 应用了限制的选择器。

另请参阅

  • Last updated on