Microsoft Advertising 脚本发行说明

有关每个版本中包含的更改的信息,请参阅以下部分。

2021 年 3 月 31 日

Microsoft Advertising 中不再提供平均职位。

将从 Stats 对象中删除 getAveragePosition 方法。

将“AveragePosition”列作为条件删除,并具有以下选择器。

2021 年 3 月 5 日

添加了对绝对最高印象率和最高印象率的支持,占总展示次数的百分比。

Stats 对象添加了以下方法。

添加了 AbsoluteTopImpressionRateTopImpressionRate 作为可能的列,可以使用以下选择器指定。

2021 年 2 月 23 日

添加了对响应式搜索广告的支持。

  • 添加了 ResponsiveSearchAd 对象,该对象定义响应式搜索广告。

  • 添加了 ResponsiveSearchAdBuilder 对象,用于将展开的文本广告添加到广告组。

  • responsiveSearchAdBuilderAdBuilderSpace 对象添加了 方法。 如果要生成响应式搜索广告,请调用 responsiveSearchAdBuilder 方法来获取 ResponsiveSearchAdBuilder 对象。

  • 添加了 AdTextAsset 对象,该对象包含响应式搜索广告说明和标题的属性。

  • responsiveSearchAdAdTypeSpace 对象添加了 方法,该对象包含用于测试广告是否为指定类型的方法。 例如,测试广告是否是响应式搜索广告。

  • responsiveSearchAdAdViewSpace 对象添加了 方法,该对象用于将广告强制转换为特定类型。 例如,将基础广告对象强制转换为响应式搜索广告。

2021 年 1 月 21 日

添加了对目标受众和排除受众的支持。

此更改添加了以下对象:

2020 年 12 月 10 日

添加了对目标位置和排除位置的支持。

此更改添加了以下对象:

添加了 ExcludedLocationOperation 对象,用于确定脚本是否成功添加了排除的位置。

添加了 TargetedLocationOperation 对象,用于确定脚本是否成功添加了目标位置。

2020 年 3 月 31 日

添加了派生自 ProductGroup 的以下对象:

ProductGroup 添加了以下方法:

  • asChannel()
  • asChannelExclusivity()

从一些脚本示例中删除了对 Logger.Log () 的调用。 由于日志记录在性能方面是一项昂贵的调用,因此指导是谨慎使用日志记录,除了提供问题通知外,可能不会在高音量循环中使用日志记录。 此外,使用单个调用并包含换行符 ('\n') ,而不是使用多个 Log() 调用来写入多行。

2020 年 1 月 16 日

添加了对产品组的支持。 支持仅限于枚举产品组和更新其出价。 有关示例,请参阅 脚本示例

此更改添加了以下对象:

添加了派生自 ProductGroup 的以下对象:

AdsApp 添加了以下方法:

AdGroup 添加了以下方法:

Cammpaign 添加了以下方法:

AdGroupSelector 对象的 withCondition 方法添加了 CampaignType 作为可能的列。

CampaignSelector 对象的 withCondition 方法添加了 Type 作为可能的列。

2019 年 10 月 18 日

IdAdSelectorKeywordSelector 对象的 方法添加了 列withCondition()。 可以使用此列为 ID 大于指定 ID 的广告或关键字检查 (,例如 withCondition('Id > 1234') ,) 。

添加了“检查广告和关键字 (keyword) URL”脚本解决方案,可用于检查帐户中的广告或关键字是否包含断开的 URL。

2019 年 10 月 7 日

添加 CombinedApprovalStatus 为在选择关键字时可以指定的可能列。 例如,可以使用 列来选择因编辑原因而取消批准的关键字。 请参阅 KeywordSelector.withCondition

2019 年 9 月 13 日

添加了 ExecutionInfo 对象,该对象包含有关当前正在执行脚本的环境的信息。 例如,如果脚本以预览模式运行,或者允许脚本继续执行的时间。

getExecutionInfoAdsApp 对象添加了 方法。 使用此方法获取 ExecutionInfo 对象。

getRemainingDailyQuotaUrlFetchApp 对象添加了 方法。 使用此方法可获取用户目前可以发出的剩余调用数 fetch()

2019 年 8 月 20 日

以下是仅限文档的更改。

  • 阐明了脚本将帐户的时区与 Microsoft Advertising 中的其他位置一样使用。 例如,如果使用选择器的 .forDateRange () 方法,则脚本将使用帐户的时区来确定要返回的数据。 阅读更多
  • 阐明了脚本中的数据延迟与 Microsoft Advertising 中的其他位置相同。 阅读更多

以下是支持标签的非中断性 API 更改。

  • AdsApp 对象添加了以下方法。
    • createLabel - 创建标签
    • 标签 - 获取用于筛选此帐户中的标签列表选择器
  • 添加了以下与标签相关的对象。
  • Keyword 对象添加了以下方法。
    • applyLabel - 将标签应用于关键字 (keyword)
    • 标签 - 获取一个选择器,用于筛选应用于此关键字 (keyword) 的标签列表
    • removeLabel - 从此关键字 (keyword) 中删除标签
  • 向 KeywordSelector 对象的 withCondition 方法添加了 LabelNames 列。
  • AdExpandedTextAd 对象添加了以下方法。
    • applyLabel - 将标签应用于广告
    • 标签 - 获取一个选择器,用于筛选应用于此广告的标签列表
    • removeLabel - 从此广告中删除标签
  • 向 AdSelector 对象的 withCondition 方法添加了 LabelNames 列。
  • AdGroup 对象添加了以下方法。
    • applyLabel - 将标签应用于广告组
    • 标签 - 获取一个选择器,用于筛选应用于此广告组的标签列表
    • removeLabel - 从此广告组中删除标签
  • 向 AdGroupSelector 对象的 withCondition 方法添加了 LabelNames 列。
  • Campaign 对象添加了以下方法。
    • applyLabel - 将标签应用于市场活动
    • 标签 - 获取一个选择器,用于筛选应用于此活动的标签列表
    • removeLabel - 从此市场活动中删除标签
  • 向 CampaignSelector 对象的 withCondition 方法添加了 LabelNames 列。

2019 年 4 月 30 日

以下是仅限文档的更改。

  • 必应广告现在是 Microsoft Advertising。 我们的新名称反映了我们如何发展广告解决方案,以帮助你吸引更多客户。 文档中对必应广告平台的所有引用都已更改为 Microsoft Advertising。

以下是支持品牌更新的非中断性 API 更改。

  • 添加了 AdsApp 对象。 脚本将继续支持 BingAdsApp 对象以实现向后兼容性;但是,建议你尽早更新脚本以使用新对象。

2019 年 3 月 25 日

以下是仅限文档的更改。

2019 年 2 月 11 日

BingAdsAccountStats 对象添加了以下方法。

注意

如果使用 getClickConversionRate () 和 getConvertedClicks () 方法,则应更新脚本以改用 getConversionRate () 和 getConversions () 方法。

Stats 对象添加了以下方法。

注意

如果使用 getClickConversionRate () 和 getConvertedClicks () 方法,则应更新脚本以改用 getConversionRate () 和 getConversions () 方法。

2018 年 11 月 27 日

以下是仅限文档的更改。

2018 年 11 月 7 日

以下是仅限文档的更改。

  • 更改了预览说明,以指示脚本现在处于开放 beta 阶段,可供所有 Microsoft Advertising 用户使用。

2018 年 10 月 4 日

这是脚本的 Beta 版本。 有关参与该计划的信息,请联系你的客户经理。 脚本类和文档可能会更改。

添加了以下对象以支持 URL 提取。

  • 添加了 UrlFetchApp 对象,该对象是用于从 Web 提取资源的顶级对象。

  • 添加了 HTTPResponse,其中包含用于访问已提取资源内容的方法。

  • 添加了 UrlFetch 限制 主题,其中列出了从 Web 提取资源的限制。

添加以下主题:

2018 年 10 月 2 日

添加了以下对象和方法以支持多帐户。

  • currentAccountBingAdsApp 添加了 方法。 使用此方法获取 Account 对象,其中包含有关脚本当前正在处理的帐户的信息。

  • 添加了 AccountsApp 对象。 这是你在为其他人管理帐户时使用的顶级对象。 使用它可以获取有权访问的帐户列表,并选择要管理的帐户。

  • 添加了 BingAdsAccount 对象。 使用它获取托管帐户的帐户信息,例如名称、客户 ID 和帐户级性能数据。

  • 添加了 BingAdsAccountIterator 对象。 使用它循环访问所选的托管帐户列表。

  • 添加了 BingAdsAccountSelector 对象。 使用它选择要获取的托管帐户列表。

  • 添加了 BingAdsAccountStats 对象。 使用它访问托管帐户的性能数据。

  • 添加了 ExecutionResult 对象。 使用它获取在选择器方法中指定的 executeInParallel 函数的结果和返回值 (请参阅 BingAdsAccountSelector) 。

Budget 对象添加了以下字段以支持共享预算。

  • campaigns - 获取一个选择器,该选择器返回共享此预算的所有市场活动。
  • getEntityType - 获取对象的类型。
  • getId - 获取唯一标识共享预算的 ID。
  • getName - 获取共享预算的名称。
  • getStats - 获取共享此预算的营销活动的性能数据。
  • getType - 获取预算类型 (例如 DAILY) 。
  • isExplicitlyShared - 获取一个布尔值,该值指示此预算是否为共享预算。

getIdgetNamegetStats 方法仅返回共享预算的数据;getId对于未共享 (单个市场活动) 预算,和 getName 方法返回 null。

BingAdsApp 对象添加了以下字段。

  • 预算 - 获取帐户中的所有共享预算。 使用选择器筛选共享预算列表。

添加了以下对象,用于筛选和循环访问共享预算列表。

  • BudgetSelector - 包含用于筛选和排序共享预算列表的方法。

  • BudgetIterator - 包含用于循环访问共享预算列表的方法。 选择器的 get 方法返回迭代器。

选择器仅返回共享预算,不包括未共享 (单个市场活动) 预算。 若要确定市场活动是否使用单个预算,请通过调用市场活动的 getBudget 方法获取预算。 然后,调用预算的 isExplicitlyShared 方法来确定是否共享预算。 如果 isExplicitlyShared 返回 true,则共享预算。

2018 年 10 月 1 日

Keyword 对象添加了以下方法。

  • getQualityScore - 获取关键字 (keyword) 的质量分数。 分数在 1 到 10 (最高) 。 分数通过衡量关键字和登陆页面与客户搜索词的相关性来显示广告在市场中具有的竞争力。

2018 年 9 月 12 日

添加了以下方法,用于获取实体的父实体和子实体。

2018 年 9 月 9 日

添加了对广告的支持。

  • newAdAdGroup 添加了 方法。 方法返回 一个 AdBuilderSpace 对象,用于获取广告生成器。

  • 添加了 AdBuilderSpace 对象。 对象包含用于获取广告生成器的方法。 例如,如果要生成展开的文本广告,则调用 对象的 expandedTextAdBuilder 方法以获取 ExpandedTextAdBuilder 对象。

  • 添加了 ExpandedTextAdBuilder 对象,用于将展开的文本广告添加到广告组。

  • 添加了 AdOperation 对象,用于确定脚本是否成功添加了广告。

  • 添加了 AdViewSpace 对象,该对象包含用于将广告强制转换为特定类型的方法。 例如,将基础广告对象强制转换为展开的文本广告。

  • 添加了 AdTypeSpace 对象,该对象包含用于测试广告是否为指定类型的方法。 例如,测试广告是否为扩展文本广告。

  • 添加了 Ad 对象,该对象是基本广告类型。 它还定义文本广告。

  • 添加了 AdUrls 对象,该对象包含用于获取广告 URL、跟踪模板和自定义参数的方法。

  • 添加了 ExpandedTextAd 对象,该对象定义展开的文本广告。

  • 添加了 AdSelector 对象,用于指定用于选择广告的筛选条件。

  • 添加了 AdIterator 对象,用于循环访问经过筛选的广告列表。

  • adsBingAdsApp 添加了 方法。 方法返回 AdSelector 对象,用于指定用于在帐户中选择广告的筛选条件。

  • adsAdGroup 添加了 方法。 方法返回 AdSelector 对象,用于指定用于在广告组中选择广告的筛选条件。

  • adsCampaign 添加了 方法。 方法返回 AdSelector 对象,用于指定在市场活动中选择广告的筛选条件。

2018 年 6 月 15 日

关闭 beta 版本。 此版本的 Microsoft 广告脚本仅适用于选择的参与者。 有关参与预览版计划的信息,请联系你的客户经理。 脚本类和文档可能会更改。

此初始版本包括以下功能:

  • 核心市场活动管理 (市场活动、广告组、关键字)
  • 实体级别 (市场活动、广告组、关键字) 的性能数据
  • 共享的否定关键字列表