操作广告扩展记录 - 批量

定义可在批量文件中下载和上传的操作广告扩展。

可以将操作广告扩展与帐户或帐户中的市场活动及广告组相关联。 每个实体 (帐户、市场活动或广告组) 最多可以与 20 个操作广告扩展相关联。 使用 帐户操作广告扩展、 广告组操作广告扩展和 市场活动操作广告扩展 记录来管理操作广告扩展插件关联。

通过在 DownloadCampaignsByAccountIds 或 DownloadCampaignsByCampaignIds 服务请求中包含 ActionAdExtensions 的 DownloadEntity 值，可以下载帐户中的所有 Action Ad 扩展记录。 此外，下载请求必须包括 EntityData 范围。 有关批量服务的更多详细信息（包括最佳做法），请参阅 批量下载和上传。

以下批量 CSV 示例会将新的 Action Ad Extension 添加到帐户的共享库。

Type,Status,Id,Parent Id,ClientId,Language,Start Date,End Date,Name,Ad Schedule,Use Searcher Time Zone,Action Type,Action Text,Final Url,Mobile Final Url,Tracking Template,Final Url Suffix,Custom Parameter
Format Version,,,,,,,,6.0,,,,,,,,,
Action Ad Extension,Active,-10,0,ClientIdGoesHere,English,,12/31/2020,,(Monday[09:00-21:00]);(Tuesday[09:00-21:00]);(Wednesday[09:00-21:00]);(Thursday[09:00-21:00]);(Friday[09:00-21:00]),false,ActNow,,https://www.contoso.com/womenshoesale,https://mobile.contoso.com/womenshoesale,,,{_promoCode}=PROMO1; {_season}=summer

如果使用用于 .NET、Java 或 Python 的必应广告 SDK ，则可以使用 BulkServiceManager 来节省时间来上传和下载 BulkActionAdExtension 对象，而无需直接调用服务操作和编写自定义代码来分析批量文件中的每个字段。

var uploadEntities = new List<BulkEntity>();

// Map properties in the Bulk file to the BulkActionAdExtension
var bulkActionAdExtension = new BulkActionAdExtension
{
    // 'Parent Id' column header in the Bulk file
    AccountId = 0,
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",
                
    // Map properties in the Bulk file to the 
    // ActionAdExtension object of the Campaign Management service.
    ActionAdExtension = new ActionAdExtension
    {
        // 'Id' column header in the Bulk file
        Id = actionAdExtensionIdKey,
        // 'Action Type' column header in the Bulk file
        ActionType = ActionAdExtensionActionType.ActNow,
        // 'Mobile Final Url' column header in the Bulk file
        FinalMobileUrls = new string[]
        {
            "https://mobile.contoso.com/womenshoesale"
        },
        // 'Final Url' column header in the Bulk file
        FinalUrls = new string[]
        {
            "https://www.contoso.com/womenshoesale"
        },
        // 'Language' column header in the Bulk file
        Language = "English",
        // 'Tracking Template' column header in the Bulk file
        TrackingUrlTemplate = null,
        // 'Custom Parameter' column header in the Bulk file
        UrlCustomParameters = new CustomParameters
        {
            // Each custom parameter is delimited by a semicolon (;) in the Bulk file
            Parameters = new[] {
                new CustomParameter(){
                    Key = "promoCode",
                    Value = "PROMO1"
                },
                new CustomParameter(){
                    Key = "season",
                    Value = "summer"
                },
            }
        },
        // 'Ad Schedule' column header in the Bulk file
        Scheduling = new Schedule
        {
            // Each day and time range is delimited by a semicolon (;) in the Bulk file
            DayTimeRanges = new[]
            {
                // Within each day and time range the format is Day[StartHour:StartMinue-EndHour:EndMinute].
                new DayTime
                {
                    Day = Day.Monday,
                    StartHour = 9,
                    StartMinute = Minute.Zero,
                    EndHour = 21,
                    EndMinute = Minute.Zero,
                },
            },
            // 'End Date' column header in the Bulk file
            EndDate = new Microsoft.BingAds.V13.CampaignManagement.Date
            {
                Month = 12,
                Day = 31,
                Year = DateTime.UtcNow.Year + 1
            },
            // 'Start Date' column header in the Bulk file
            StartDate = null,
            // 'Use Searcher Time Zone' column header in the Bulk file
            UseSearcherTimeZone = false,
        },
        // 'Status' column header in the Bulk file
        Status = AdExtensionStatus.Active,
    },
};

uploadEntities.Add(bulkActionAdExtension);

var entityUploadParameters = new EntityUploadParameters
{
    Entities = uploadEntities,
    ResponseMode = ResponseMode.ErrorsAndResults,
    ResultFileDirectory = FileDirectory,
    ResultFileName = DownloadFileName,
    OverwriteResultFile = true,
};

var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();

对于 Action Ad Extension 记录，批量 文件架构中提供了以下属性字段。

• 操作文本
• 操作类型
• 广告计划
• 客户端 ID
• 自定义参数
• 编辑位置
• 编辑原因代码
• 编辑状态
• 编辑术语
• "结束日期"
• 最终 URL
• 最终 URL 后缀
• Id
• 语言
• 移动最终 URL
• 修改时间
• 父 ID
• 发布者国家/地区
• "开始日期"
• 状态
• 跟踪模板
• 使用搜索器时区
• 版本

操作文本

此本地化文本显示在行动号召按钮上。

显示的操作文本将因您设置的操作类型和语言而异。 例如，如果 操作类型 为“ActNow”且 语言 为“英语”，则显示的操作文本为“Act Now”。 有关每种语言的本地化操作文本的详细信息，请参阅 Action Ad Extensions 的操作文本。

添加： 只读
更新： 只读
删除： 只读

操作类型

你在此处选择的操作类型以及你设置 的“语言” 决定了“行动号召”按钮上显示的“操作 文本 ”。

此字段的可能值包括：ActNow、ApplyNow、BetNow、BidNow、BookACar、BookHotel、BookNow、BuyNow、ChatNow、Compare、ContactUs、优惠券、Directions、Donate、Download、EmailNow、EnrollNow、FileNow、FindJob、 FindStore、FreePlay、FreeQuote、FreeTrial、GetDeals、GetOffer、GetQuote、JoinNow、LearnMore、ListenNow、LogIn、OrderNow、PlayGame、PlayNow、PlayNow、PostJob、Register、RenewNow、RentACar、RentNow、Reorder、Reserve、Sale、SaveNow、Schedule、SeeMenu、SeeOffer、SellNow、ShopNow、Showtimes SignIn、SignUp、StartNow、Subscribe、SwitchNow、TestDrive、TryNow、ViewCars、ViewPlans、VisitStore、VoteNow、Watch、WatchMore、WatchNow。

Microsoft Advertising 不支持所有语言的所有操作类型。 如果尝试使用不受支持的操作类型和语言组合，将返回错误。 有关详细信息，请参阅 Action Ad Extensions 的操作文本。

添加： 必填
更新： 必填
删除： 只读

广告计划

希望广告扩展插件随广告一起显示的日期和时间范围列表。 每天和时间范围包括计划的星期几、开始/结束小时和开始/结束分钟。 每天和时间范围都用左括号和右括号括起来，并用分号 (;) 分隔符分隔其他日期和时间范围。 在每天和时间范围内，格式为 Day[StartHour：StartMinue-EndHour：EndMinute]。

StartHour 的可能值范围为 00 到 23，其中 00 相当于 12：00AM，12 等于中午 12：00。

EndHour 的可能值范围为 00 到 24，其中 00 相当于凌晨 12：00,12 等于中午 12：00。

StartMinute 和 EndMinute 的可能值范围为 00 到 60。

以下示例演示工作日从上午 9：00 到晚上 9：00 的日期和时间范围： (Monday[09：00-21：00]) ; (Tuesday[09：00-21：00]) ; (星期三[09：00-21：00]) ; (星期四[09：00-21：00]) ; (星期五[09：00-21：00])

添加： 选。 如果未设置此字段，广告扩展插件将有资格在日历 开始 和 结束 日期期间随时进行计划。
更新： 选。 无法更新单个日期和时间范围。 可以通过发送应替换上一组的新集来有效地更新日期和时间范围。 “广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖，并一起更新。 如果在更新期间将所有这些字段留空，则不会更新这些字段。 如果包含其中任何字段的值，则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置，请将其中每个字段设置为 delete_value。
删除： 只读

客户端 ID

用于将批量上传文件中的记录与结果文件中的记录相关联。 服务器不使用或存储此字段的值;它只是从上传的记录复制到相应的结果记录。 它可以是长度最大为 100 的任何有效字符串。

添加： 选
更新： 选
删除： 只读

自定义参数

用于 URL 跟踪的键和值参数的自定义集合。

在批量文件中，自定义参数列表的格式如下所示。

• 将每个自定义参数对的格式设置为 Key=Value，例如 {_promoCode}=PROMO1。

• Microsoft Advertising 将接受你包括的前 3 个自定义参数键和值对，并且将忽略任何其他自定义参数。 对于自定义参数限制增加阶段 3 试点 (GetCustomerPilotFeatures 返回 635) 的客户，Microsoft Advertising 将接受你包含的前 8 个自定义参数键和值对，如果包含的自定义参数超过 8 个，将返回错误。

• 每个键值对由分号和空格 (“分隔;“) ，例如 {_promoCode}=PROMO1;{_season}=summer。

• 键不能包含分号。 如果 Value 包含分号，则必须将其转义为“\;”。 此外，如果 Value 包含反斜杠，则还必须将其转义为“\”。

• 键不能超过 16 个 UTF-8 字节，值不能超过 200 UTF-8 字节。 对于自定义参数限制增加阶段 3 试点的客户 (GetCustomerPilotFeatures 返回 635) ，值限制增加到 250 UTF-8 字节。 密钥是必需的，值是可选的。 键的最大大小不包括大括号和下划线，即“{”、“_”和“}”。

  注意

  使用批量服务时，必须使用周围的大括号和前导下划线设置密钥的格式，例如，如果密钥是 promoCode，则必须将其格式设置为 {_promoCode}。 使用市场活动管理服务时，不能指定周围的大括号和下划线。

添加： 选
更新： 选。 如果未为更新设置任何值，则会删除以前的设置。
删除： 只读

编辑位置

编辑评审失败的广告扩展插件的组件或属性。

添加： 只读
更新： 只读
删除： 只读

编辑原因代码

标识失败原因的代码。 有关可能的原因代码列表，请参阅 编辑原因代码。

添加： 只读
更新： 只读
删除： 只读

编辑状态

广告扩展的编辑状态。

下表介绍了可能的值。

值	说明
活动	广告扩展已通过编辑评审。
ActiveLimited	广告扩展在一个或多个市场通过了编辑评审，广告扩展的一个或多个元素正在另一个市场进行编辑评审。 例如，广告扩展已通过加拿大的编辑评审，仍在美国中等待评审。
反对	广告扩展未通过编辑评审。
非活动	广告扩展的一个或多个元素正在接受编辑评审。

添加： 只读
更新： 只读
删除： 只读

编辑术语

编辑评审失败的术语。

如果术语组合导致失败，或者失败基于策略冲突，则不会设置此字段。

添加： 只读
更新： 只读
删除： 只读

End Date

格式化为 MM/DD/YYYY 的广告扩展计划结束日期字符串。

结束日期是包含的。 例如，如果将此字段设置为 2020 年 12 月 31 日，广告扩展将在 2020 年 12 月 31 日晚上 11：59 停止显示。

添加： 选。 如果未指定结束日期，除非暂停关联的市场活动、广告组或广告，否则广告扩展将继续交付。
更新： 选。 只要开始日期为 null 或出现在新的结束日期之前，就可以缩短或延长结束日期。 如果将此字段设置为 delete_value 字符串，则实际上删除了结束日期。 “广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖，并一起更新。 如果在更新期间将所有这些字段留空，则不会更新这些字段。 如果包含其中任何字段的值，则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置，请将其中每个字段设置为 delete_value。
删除： 只读

最终 URL

这是指向与操作文本对应的特定网页或表单的链接。

如果未提供广告扩展插件的最终 URL，将使用广告的最终 URL。

URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。

添加： 选
更新： 选。 如果未为更新设置任何值，则会删除以前的设置。
删除： 只读

最终 URL 后缀

最终 URL 后缀可以包括跟踪参数，这些参数将追加到登陆页 URL 的末尾。 建议将登陆页面所需的跟踪参数放在最终 URL 后缀中，以便始终将客户发送到登陆页面。 有关更多详细信息和验证规则，请参阅技术指南中的 最终 URL 后缀 。

注意

此功能仅适用于最终 URL 后缀阶段 3 试点 (GetCustomerPilotFeatures 返回 636) 的客户。 如果你不在试点中，则将忽略此属性，并且不会返回任何错误。

添加： 选
更新： 选。 如果未为更新设置任何值，则会删除以前的设置。
删除： 只读

Id

广告扩展的系统生成的标识符。

添加： 选。 必须将此字段留空，或指定负标识符。 然后，可以在相关记录类型的 Id 字段中引用为广告扩展设置的负标识符，例如 广告组操作广告扩展 和 市场活动操作广告扩展。 如果要在同一批量文件中添加新广告扩展和新的依赖记录，则建议这样做。 有关详细信息，请参阅 批量文件架构引用密钥。
更新： 只读和必需
删除： 只读和必需

语言

广告扩展将使用的语言。

无论市场活动或广告组的语言设置如何，扩展都将始终以此语言提供。

支持的语言字符串为：丹麦语、荷兰语、英语、芬兰语、法语、德语、意大利语、挪威语、葡萄牙语、西班牙语、瑞典语和繁体中文。

Microsoft Advertising 不支持所有语言的所有操作类型。 如果尝试使用不受支持的操作类型和语言组合，将返回错误。 有关详细信息，请参阅 Action Ad Extensions 的操作文本。

添加： 必填
更新： 必填
删除： 只读

移动最终 URL

在移动设备上提供操作扩展时，这是一个适合移动设备的登陆页 URL。

如果指定移动最终 URL，还必须指定 最终 URL。

URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。

添加： 选
更新： 选。 如果未为更新设置任何值，则会删除以前的设置。
删除： 只读

修改时间

上次更新实体的日期和时间。 该值以协调世界时 (UTC) 表示。

注意

日期和时间值反映服务器的日期和时间，而不是客户端。 有关日期和时间格式的信息，请参阅 基元 XML 数据类型中的 dateTime 条目。

添加： 只读
更新： 只读
删除： 只读

父 ID

包含广告扩展的帐户的系统生成的标识符。

此批量字段映射到帐户记录的 ID 字段。

添加： 只读
更新： 只读
删除： 只读

发布者国家/地区

编辑指南不允许指定 术语的发布者国家或地区的列表。

在批量文件中，发布者国家或地区的列表用分号 (;) 分隔。

添加： 只读
更新： 只读
删除： 只读

开始日期

格式化为 MM/DD/YYYY 的广告扩展计划开始日期字符串。

开始日期是包含的。 例如，如果将 StartDate 设置为 5/5/2020，广告扩展将在 2020 年 5 月 5 日凌晨 12：00 开始显示。

添加： 选。 如果未指定开始日期，广告扩展将立即符合 计划条件。
更新： 选。 只要结束日期为 null 或发生在新的开始日期之后，就可以缩短或延长开始日期。 如果将此字段设置为 delete_value 字符串，则实际上将删除开始日期，并且广告扩展将立即符合 计划条件。 “广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖，并一起更新。 如果在更新期间将所有这些字段留空，则不会更新这些字段。 如果包含其中任何字段的值，则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置，请将其中每个字段设置为 delete_value。
删除： 只读

状态

广告扩展的状态。

可能的值为 Active 或 Deleted。

添加： 选。 默认值为 Active。
更新： 选。 如果未为更新设置任何值，则不会更改此设置。
删除： 必填。 “状态”必须设置为 “已删除”。

跟踪模板

要用于操作 URL 的跟踪模板。

以下验证规则适用于跟踪模板。 有关支持的模板和参数的更多详细信息，请参阅 Microsoft Advertising 帮助文章 我可以使用哪些跟踪或 URL 参数？

• 为较低级别的实体（例如广告）定义的跟踪模板将覆盖为较高级别的实体（例如市场活动）设置的模板。 有关详细信息，请参阅 实体限制。

• 跟踪模板的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。

• 跟踪模板必须是格式正确的 URL，从以下项之一开始： http://、 https://、 {lpurl}或 {unescapedlpurl}。

• Microsoft Advertising 不会验证自定义参数是否存在。 如果在跟踪模板中使用自定义参数，并且这些参数不存在，则登陆页 URL 将包含自定义参数的键和值占位符，而不进行替换。 例如，如果跟踪模板为 https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}，并且未在市场活动、广告组、条件、关键字 (keyword) 或广告级别定义 {_season} 或 {_promocode}，则登陆页 URL 将相同。

添加： 选
更新： 选。 如果未为更新设置任何值，则会删除以前的设置。
删除： 只读

使用搜索器时区

确定是使用帐户时区还是搜索用户的时区（可在其中投放广告）。

如果希望广告扩展显示在搜索用户的时区中，则将此属性设置为 TRUE ，否则将其设置为 FALSE。

添加： 选。 如果未指定此字段或将其留空，则将设置默认值 FALSE ，并使用帐户时区。
更新： 选。 如果将此字段设置为 delete_value 字符串，则实际上将重置为默认值 FALSE。 “广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖，并一起更新。 如果在更新期间将所有这些字段留空，则不会更新这些字段。 如果包含其中任何字段的值，则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置，请将其中每个字段设置为 delete_value。
删除： 只读

版本

广告扩展内容已更新的次数。 添加扩展时，版本设置为 1，每次修改时都会递增。

添加： 只读
更新： 只读
删除： 只读