免责声明记录 - 批量
定义可在批量文件中下载和上传的免责声明。
可以将免责声明与帐户中的市场活动相关联。 使用 市场活动免责声明 记录管理免责声明关联。
通过在 DownloadCampaignsByAccountIds 或 DownloadCampaignsByCampaignIds 服务请求中包含 DisclaimerAdExtensions 的 DownloadEntity 值,可以下载帐户中的所有免责声明广告扩展记录。 此外,下载请求必须包括 EntityData 范围。 有关批量服务的更多详细信息(包括最佳做法),请参阅 批量下载和上传。
以下批量 CSV 示例会将新的免责声明添加到帐户的共享库。
Type,Status,Id,Parent Id,Campaign,Client Id,Modified Time,Start Date,End Date,Ad Schedule,Use Searcher Time Zone,Disclaimer Layout,Name,Popup Text,Title,Final Url,Mobile Final Url
Format Version,,,,,,,,,,,6.0,,,,,,
Disclaimer Ad Extension,Active,-18,0,,,ClientIdGoesHere,,,12/31/2020,English,,(Monday[09:00-21:00]),FALSE,Amenities,ValueOne;ValueTwo;ValueThree,https://www.contoso.com/one; https://www.contoso.com/two; https://www.contoso.com/three,https://mobile.contoso.com/one; https://mobile.contoso.com/two; https://mobile.contoso.com/three
如果使用用于 .NET、Java 或 Python 的必应广告 SDK ,则可以使用 BulkServiceManager 来节省时间来上传和下载 BulkDisclaimerAdExtension 对象,而无需直接调用服务操作并编写自定义代码来分析批量文件中的每个字段。
var uploadEntities = new List<BulkEntity>();
// Map properties in the Bulk file to the BulkDisclaimerAdExtension
var bulkDisclaimerAdExtension = new BulkDisclaimerAdExtension
{
// '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
// DisclaimerAdExtension object of the Campaign Management service.
DisclaimerAdExtension = new DisclaimerAdExtension
{
// 'DisclaimerLayout' column header in the Bulk file
DisclaimerLayout = "additionalLine",
// 'Id' column header in the Bulk file
Id = disclaimerAdExtensionIdKey,
// 'Final Url' column header in the Bulk file
FinalUrls = new[] {
// Each Url is delimited by a semicolon (;) in the Bulk file
"https://www.contoso.com/one",
"https://www.contoso.com/two",
"https://www.contoso.com/three"
},
// 'Mobile Final Url' column header in the Bulk file
FinalMobileUrls = new[] {
// Each Url is delimited by a semicolon (;) in the Bulk file
"https://mobile.contoso.com/one",
"https://mobile.contoso.com/two",
"https://mobile.contoso.com/three"
},
// 'Name' column header in the Bulk file
Name = "DisclaimerName",
// 'PopupText' column header in the Bulk file
PopupText = "DisclaimerPopupText",
// 'Title' column header in the Bulk file
Title = "Disclaimer info",
// '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(bulkDisclaimerAdExtension);
var entityUploadParameters = new EntityUploadParameters
{
Entities = uploadEntities,
ResponseMode = ResponseMode.ErrorsAndResults,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true,
};
var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();
对于 免责声明 记录, 批量文件架构中提供了以下属性字段。
- 广告计划
- 客户端 ID
- 免责声明布局
- 编辑位置
- 编辑原因代码
- 编辑状态
- 编辑术语
- "结束日期"
- 最终 URL
- Id
- 移动最终 URL
- 修改时间
- 名称
- 父 ID
- 弹出文本
- 发布者国家/地区
- "开始日期"
- Status
- Title
- 使用搜索器时区
- 版本
广告计划
希望记录随广告一起显示的日期和时间范围列表。 每天和时间范围包括计划的星期几、开始/结束小时和开始/结束分钟。 每天和时间范围都用左括号和右括号括起来,并用分号 (;) 分隔符分隔其他日期和时间范围。 在每天和时间范围内,格式为 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 的任何有效字符串。
添加: 选
更新: 选
删除: 只读
免责声明布局
免责声明的布局。 可以是 additionalLine 或 popup。
编辑位置
编辑评审失败的记录的组件或属性。
添加: 只读
更新: 只读
删除: 只读
编辑原因代码
标识失败原因的代码。 有关可能的原因代码列表,请参阅 编辑原因代码。
添加: 只读
更新: 只读
删除: 只读
编辑状态
记录的编辑状态。
下表介绍了可能的值。
值 | 说明 |
---|---|
活动 | 记录通过了编辑评审。 |
ActiveLimited | 记录在一个或多个市场通过了编辑评审,记录的一个或多个元素正在另一个市场进行编辑评审。 例如,该记录通过了加拿大的编辑评审,并且仍在美国中等待评审。 |
反对 | 记录未通过编辑评审。 |
非活动 | 记录的一个或多个元素正在接受编辑评审。 |
添加: 只读
更新: 只读
删除: 只读
编辑术语
编辑评审失败的术语。
如果术语组合导致失败,或者失败基于策略冲突,则不会设置此字段。
添加: 只读
更新: 只读
删除: 只读
End Date
格式为 MM/DD/YYYY 的记录计划结束日期字符串。
结束日期是包含的。 例如,如果将此字段设置为 2020 年 12 月 31 日,记录将在 2020 年 12 月 31 日晚上 11:59 停止显示。
添加: 选。 如果未指定结束日期,除非暂停关联的市场活动、广告组或广告,否则将继续传递记录。
更新: 选。 只要开始日期为 null 或出现在新的结束日期之前,就可以缩短或延长结束日期。 如果将此字段设置为 delete_value 字符串,则实际上删除了结束日期。
“广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖,并一起更新。 如果在更新期间将所有这些字段留空,则不会更新这些字段。 如果包含其中任何字段的值,则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置,请将其中每个字段设置为 delete_value。
删除: 只读
最终 URL
登陆页 URL。
以下验证规则适用于最终 URL 和最终移动 URL。
- URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 最多可为 最终 URL 和 移动最终 URL 指定 10 个列表项;但是,每个列表中的第一项仅用于传递。 该服务最多允许 10 个列表项,以便实现潜在的向前兼容性。
- 每个 URL 由分号和空格 (“分隔;“) 。
- 仅允许使用“{”和“}”来描述标记,例如 {lpurl}。
- 最终 URL 必须是格式正确的 URL,以 http:// 或 https:// 开头。
- 如果指定 移动最终 URL,还必须指定 最终 URL。
添加: 必填
更新: 选。 如果未为更新设置任何值,则不会更改此设置。
删除: 只读
Id
记录的系统生成的标识符。
添加: 选。 必须将此字段留空,或指定负标识符。 然后,可以在相关记录类型的 “ID” 字段中引用为记录设置的负标识符,例如 和 Campaign 免责声明。 如果要在同一大容量文件中添加新记录和新的依赖记录,则建议这样做。 有关详细信息,请参阅 批量文件架构引用密钥。
更新: 只读和必需
删除: 只读和必需
移动最终 URL
移动设备的登陆页 URL。
以下验证规则适用于最终 URL 和最终移动 URL。
- URL 的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 最多可为 最终 URL 和 移动最终 URL 指定 10 个列表项;但是,每个列表中的第一项仅用于传递。 该服务最多允许 10 个列表项,以便实现潜在的向前兼容性。
- 每个 URL 由分号和空格 (“分隔;“) 。
- 仅允许使用“{”和“}”来描述标记,例如 {lpurl}。
- 最终 URL 必须是格式正确的 URL,以 http:// 或 https:// 开头。
- 如果指定 移动最终 URL,还必须指定 最终 URL。
添加: 选
更新: 选。 如果未为更新设置任何值,则不会更改此设置。 如果将此字段设置为 delete_value 字符串,则会删除以前的设置。
删除: 只读
修改时间
上次更新实体的日期和时间。 该值以协调世界时 (UTC) 表示。
注意
日期和时间值反映服务器的日期和时间,而不是客户端。 有关日期和时间格式的信息,请参阅 基元 XML 数据类型中的 dateTime 条目。
添加: 只读
更新: 只读
删除: 只读
名称
免责声明的名称。 这仅用于报告以帮助识别记录。
最大 长度:35 个字符。
父 ID
包含记录的帐户的系统生成的标识符。
此批量字段映射到帐户记录的 ID 字段。
添加: 只读
更新: 只读
删除: 只读
弹出文本
如果免责声明处于 弹出 布局中,则为必需文本。
最大 长度:500 个字符。
发布者国家/地区
编辑指南不允许指定 术语的发布者国家或地区的列表。
在批量文件中,发布者国家或地区的列表用分号 (;) 分隔。
添加: 只读
更新: 只读
删除: 只读
开始日期
格式化为 MM/DD/YYYY 的记录计划开始日期字符串。
开始日期是包含的。 例如,如果将 StartDate 设置为 5/5/2020,记录将在 2020 年 5 月 5 日凌晨 12:00 开始显示。
添加: 选。 如果未指定开始日期,则记录将立即符合 计划条件。
更新: 选。 只要结束日期为 null 或发生在新的开始日期之后,就可以缩短或延长开始日期。 如果将此字段设置为 delete_value 字符串,则实际上将删除开始日期,并且该记录将立即符合 计划条件。
“广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖,并一起更新。 如果在更新期间将所有这些字段留空,则不会更新这些字段。 如果包含其中任何字段的值,则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置,请将其中每个字段设置为 delete_value。
删除: 只读
状态
记录的状态。
可能的值为 Active 或 Deleted。
添加: 选。 默认值为 Active。
更新: 选。 如果未为更新设置任何值,则不会更改此设置。
删除: 必填。 “状态”必须设置为 “已删除”。
标题
弹出窗口布局中的弹出窗口的标题。
最大 长度:75 个字符。
使用搜索器时区
确定是使用帐户时区还是搜索用户的时区(可在其中投放广告)。
如果希望记录显示在搜索用户的时区中,则将此属性设置为 TRUE ,否则将其设置为 FALSE。
添加: 选。 如果未指定此字段或将其留空,则将设置默认值 FALSE ,并使用帐户时区。
更新: 选。 如果将此字段设置为 delete_value 字符串,则实际上将重置为默认值 FALSE。
“广告计划”、“结束日期”、“开始日期”和“使用搜索器时区”字段相互依赖,并一起更新。 如果在更新期间将所有这些字段留空,则不会更新这些字段。 如果包含其中任何字段的值,则会删除或替换所有这些字段的先前值。 若要删除以前的所有计划设置,请将其中每个字段设置为 delete_value。
删除: 只读
版本
记录内容的更新次数。 添加记录时,版本设置为 1,每次修改记录时都会递增。
添加: 只读
更新: 只读
删除: 只读