市场活动数据对象 - 市场活动管理

定义市场活动。

注意

不能再添加、更新或检索仅支持动态搜索广告的市场活动。 现有市场活动的市场活动类型已从“DynamicSearchAds”更新为“搜索”。 广告组现在被视为“动态”广告组,但没有任何结构性更改,即它们包含与以前相同的自动目标和动态搜索广告。

注意

自 2021 年 4 月起,手动 CPC 出价策略只能用于受众市场活动和住宿市场活动。 如果尝试为任何其他市场活动类型设置手动 CPC,请求将被忽略且不会出错,并且出价策略将设置为增强的 CPC。

自 2021 年 4 月起,无法为广告组或关键字设置任何出价策略。 只能在市场活动级别设置出价策略。 如果尝试为广告组或关键字设置出价策略,请求将被忽略,而不会出错。 广告组和关键字将继承其市场活动的出价策略。

语法

<xs:complexType name="Campaign" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AudienceAdsBidAdjustment" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="BiddingScheme" nillable="true" type="tns:BiddingScheme" />
    <xs:element minOccurs="0" name="BudgetType" nillable="true" type="tns:BudgetLimitType" />
    <xs:element minOccurs="0" name="DailyBudget" nillable="true" type="xs:double" />
    <xs:element xmlns:q9="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="DealIds" nillable="true" type="q9:ArrayOflong">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="ExperimentId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
    <xs:element xmlns:q10="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q10:ArrayOfKeyValuePairOfstringstring" />
    <xs:element xmlns:q11="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="GoalIds" nillable="true" type="q11:ArrayOflong">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="IsDealCampaign" nillable="true" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="MultimediaAdsBidAdjustment" nillable="true" type="xs:int">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:CampaignStatus" />
    <xs:element minOccurs="0" name="SubType" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TimeZone" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
    <xs:element minOccurs="0" name="CampaignType" nillable="true" type="tns:CampaignType" />
    <xs:element minOccurs="0" name="Settings" nillable="true" type="tns:ArrayOfSetting" />
    <xs:element minOccurs="0" name="BudgetId" nillable="true" type="xs:long" />
    <xs:element xmlns:q12="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Languages" nillable="true" type="q12:ArrayOfstring" />
    <xs:element minOccurs="0" name="AdScheduleUseSearcherTimeZone" nillable="true" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="BidStrategyId" nillable="true" type="xs:long">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>

元素

Campaign 对象具有以下元素:AdScheduleUseSearcherTimeZoneAudienceAdsBidAdjustmentBidSchemeBidStrategyIdBudgetIdBudgetTypeCampaignTypeDailyBudgetDealIdsExperimentIdFinalUrlSuffixForwardCompatibilityMapGoalIdsIdIsDealCampaignLanguagesMultimediaAdsBidAdjustmentNameSettingsStatusSubTypeTimeZoneTrackingUrlTemplateUrlCustomParameters

元素 说明 数据类型
AdScheduleUseSearcherTimeZone 确定是使用帐户时区还是搜索用户的时区(可在其中投放广告)。

如果希望广告显示在搜索用户的时区中,请将此属性设置为 true ,否则将其设置为 false

默认情况下不返回此元素。 若要获取此元素,请在调用 GetCampaignsByAccountId 和 GetCampaignsByIds 服务操作时,在 ReturnAdditionalFields 元素中包含 AdScheduleUseSearcherTimeZone 值。

加: 自选。 如果未指定此元素或将其留空,则将设置默认值 false ,并使用帐户时区。
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
boolean
AudienceAdsBidAdjustment 调整高于或低于基本广告组或关键字 (keyword) 出价的受众广告出价的百分比。

如果客户启用了Microsoft受众网络,则此属性在搜索市场活动中可用。 此属性不适用于 智能购物市场活动

支持的值为负 100 (-100) 到正 900 (900) 。 将出价调整设置为 -100 将阻止为此市场活动显示受众广告。

如果要使用基本广告组或关键字 (keyword) 出价,而不是为受众广告指定任何出价调整,请将此元素设置为零 (0) 。

最佳做法应始终指定出价调整值。 如果将此元素设置为 null,将使用系统默认出价调整。 系统默认出价调整目前为零 (0) ,随时可能更改。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
int
BiddingScheme 要如何管理出价的出价策略类型。

有关每个市场活动类型支持的出价策略的详细信息,请参阅 预算和出价策略

重要: 对于某些出价策略类型,将忽略你的出价和广告轮换设置,并且需要通过 通用事件 跟踪标记和转换目标) 转换跟踪 (。 有关详细信息(包括支持的位置),请参阅 让Microsoft广告使用出价策略管理出价

如果市场活动使用 MaxConversionValueBiddingSchemeTargetImpressionShareBiddingScheme 出价策略,则默认情况下,此元素将为零或空。 若要获取 MaxConversionValueBiddingSchemeTargetImpressionShareBiddingScheme 对象,请在调用 GetCampaignsByAccountIdGetCampaignsByIds 服务操作时,在 ReturnAdditionalFields 元素中包含相应的 MaxConversionValueBiddingSchemeTargetImpressionShareBiddingScheme 值。

加: 自选。 Search 和 DynamicSearchAds 市场活动的默认出价策略类型为 EnhancedCpcBiddingScheme。 大多数购物市场活动的默认出价策略类型为 EnhancedCpcBiddingScheme;但是, 智能购物市场活动 唯一支持的出价策略类型是 MaxConversionsBiddingSchemeMaxConversionValueBiddingScheme。 受众市场活动支持的出价策略类型是 EnhancedCpcBiddingSchemeManualCpcBiddingSchemeManualCpmBiddingSchemeTargetCpaBiddingScheme。 住宿活动支持的投标策略类型为 CommissionBiddingSchemeManualCpcBiddingSchemePercentCpcBiddingScheme。 性能最大市场活动支持的出价策略是具有可选 TCPA) 的 MaxConversionsBiddingScheme (和具有可选 TROAS) 的 MaxConversionValueBiddingScheme (。 新视频市场活动支持的出价策略是 ManualCpmBiddingSchemeManualCpvBiddingScheme注意: 从 2024 年 5 月起,你不能再对受众原生市场活动使用手动 CPC 出价策略。 只能对受众展示和视频市场活动以及住宿市场活动使用手动 CPC。 我们会自动将任何现有的手动 CPC 受众本机市场活动转换为增强的 CPC。 如果尝试为任何其他市场活动类型设置手动 CPC,请求将被忽略且不会出错,并且出价策略将设置为增强的 CPC。 自 2021 年 4 月起,无法为广告组或关键字设置任何出价策略。 只能在市场活动级别设置出价策略。 如果尝试为广告组或关键字设置出价策略,请求将被忽略,而不会出错。 广告组和关键字将继承其市场活动的出价策略。
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
BiddingScheme
BidStrategyId 此市场活动与帐户中的其他市场活动共享的 BidStrategy 的系统生成标识符。

如果字段为空,则市场活动未使用项目组合出价策略。 如果字段不为空且值大于零,则市场活动使用项目组合出价策略。 如果市场活动使用项目组合出价策略,并且你希望它使用自己的出价策略,请将此字段设置为“0” (零) 。

注意:智能购物市场活动或性能最高市场活动不支持项目组合出价策略。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
long
BudgetId 此市场活动与帐户中的其他市场活动共享 的预算 的唯一Microsoft广告标识符。

如果该值不为 null 且大于零,则市场活动使用的是共享预算。 如果值为 null,则市场活动不使用共享预算。 如果市场活动使用共享预算,并且你希望它使用自己的预算(例如 DailyBudget 金额),请将此元素设置为“0” (零) 并将 DailyBudget 设置为有效的预算金额。

注意:智能购物市场活动或性能最高市场活动不支持共享预算。 使用 智能购物市场活动时,必须设置 DailyBudget 金额。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
long
BudgetType 预算类型确定预算的支出方式。

可能的值为 DailyBudgetAccelerated 和 DailyBudgetStandard。 DailyBudgetAccelerated 预算类型仅适用于使用非共享市场活动级别预算的受众市场活动。

在共享预算的上下文中,预算类型是一个只读属性,无论市场活动是否使用共享预算,都会始终返回该属性。 若要确定市场活动是否使用共享预算,检查 BudgetId 元素的值,如上所述。

对于试验市场活动,不能设置 预算预算类型状态。 试验市场活动的预算和状态始终继承自基本市场活动设置。

加: 如果未设置 BudgetId ,则为必填项。 如果市场活动使用共享预算,则为只读。
更新: 如果未设置 BudgetId ,则为可选。 如果未为更新设置任何值,则不会更改此设置。 如果市场活动使用共享预算,则不允许。 如果尝试更新具有共享预算的活动的预算类型,该服务将返回 CampaignServiceCannotUpdateSharedBudget 错误代码。
BudgetLimitType
CampaignType 市场活动类型确定市场活动是受众、动态搜索广告、搜索、购物市场活动、酒店广告还是性能最大值。

加: 自选。 如果未指定,则使用 “搜索 ”的默认值。
更新: 不允许。
CampaignType
DailyBudget 每天在竞选活动上花费的金额。

如果未设置 BudgetId ,则必须设置每日预算金额。

你的预算是目标;实际支出可能更高或更低。 差异是由多种因素引起的,例如一周中不同日期的不同流量,或者自动检测和退款欺诈点击,这些点击可以在点击后的几个小时内将资金返还给市场活动。 Microsoft广告预计并自动补偿波动,并且通常将超支保持在比每日限制高出 100% 以下。

另请注意,Microsoft广告不需要市场活动预算高于广告组和关键字 (keyword) 出价。 换句话说,广告组和关键字 (keyword) 出价独立于市场活动预算进行验证。

在共享预算的上下文中,预算金额是始终返回的只读属性,无论市场活动是否使用共享预算。 将市场活动关联到共享预算时,返回的金额为共享预算的金额。 若要确定市场活动是否使用共享预算,检查 BudgetId 元素的值,如上所述。

对于试验市场活动,不能设置 预算预算类型状态。 试验市场活动的预算和状态始终继承自基本市场活动设置。

加: 如果未设置 BudgetId ,则为必填项。 如果市场活动使用共享预算,则为只读。
更新: 如果未设置 BudgetId ,则为可选。 如果未为更新设置任何值,则不会更改此设置。 如果市场活动使用共享预算,则不允许。 如果尝试更新具有共享预算的活动的预算金额,该服务将返回 CampaignServiceCannotUpdateSharedBudget 错误代码。
DealIds 与已添加的交易对应的唯一系统标识符列表。

标识符列表直接对应于请求中的交易列表。 列表的项可能返回为 null。 对于未添加交易的每个列表索引,相应的元素将为 null。
long 数组
ExperimentId 试验的系统生成的标识符。

此元素仅针对试验市场活动(即为基于另一个搜索市场活动为 A/B 测试创建的市场活动)设置。

基础市场活动将不包含试验 ID。 同样,在将试验 毕业 为独立市场活动后,即使该活动以前是试验活动,此元素也将是空的。

对于试验市场活动,不能设置 预算预算类型状态。 试验市场活动的预算和状态始终继承自基本市场活动设置。 如果要更改试验的预算,则需要更改基本市场活动的预算。 然后,将根据试验 TrafficSplitPercent 设置拆分值更改。

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

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为空字符串 ( ”) ,则会删除以前的设置。
string
ForwardCompatibilityMap 用于向前兼容性的键和值字符串列表,以避免在当前 API 版本中添加新元素时发生重大更改。

将来的版本中将在此处记录向前兼容性更改。 此对象当前没有向前兼容性更改。
KeyValuePairOfstringstring 数组
GoalIds 目标 ID 列表。 long 数组
ID 市场活动的唯一Microsoft广告标识符。

加: 只读
更新: 必填
long
IsDealCampaign 如果 属实,该市场活动是交易活动。 boolean
语言 广告语言设置决定了在撰写广告时将使用的语言,并且应是客户的语言。

重要: 如果在广告组和市场活动级别都设置了语言,则广告组级别语言将替代市场活动级别语言。

可以在列表中单独指定多种语言,或者如果想要面向所有语言,则只能包含一个设置为“全部”的列表项。

搜索和购物活动支持的语言字符串包括:阿尔巴尼亚语、保加利亚语、克罗地亚语、捷克语、丹麦语、荷兰语、英语、爱沙尼亚语、芬兰语、法语、德语、希腊语、匈牙利语、意大利语、日语、拉脱维亚语、立陶宛语、马耳他语、挪威语、葡萄牙语、罗马尼亚语、斯洛伐克语、斯洛文尼亚语、西班牙语、瑞典语和繁体中文。

注意: 以下语言尚未可供所有人使用:保加利亚语、克罗地亚语、捷克语、爱沙尼亚语、希腊语、匈牙利语、日语、拉脱维亚语、立陶宛语、马耳他语、波兰语、罗马尼亚语、斯洛伐克语、斯洛文尼亚语。

对于受众市场活动,必须包含所有语言,即将此元素设置为“全部”。

对于动态搜索广告市场活动,市场活动和广告组级别语言设置将被忽略,转而使用网站 域语言。 应将市场活动语言设置为“全部”,并将广告组级别 语言 留空。

加: 受众市场活动是必需的,否则此元素是可选的。 如果未设置市场活动语言,则需要市场活动内每个广告组的语言。
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 设置市场活动语言后,无法删除所有这些语言。 更新期间指定的语言列表将替换以前的设置,即不会追加到现有语言集。
字符串 数组
MultimediaAdsBidAdjustment 调整高于或低于基本广告组或关键字 (keyword) 出价的多媒体广告出价的百分比 int
名称 市场活动的名称。 该名称在帐户内的所有活动或已暂停的活动中必须是唯一的。 该名称最多可包含 128 个字符。

该服务在将名称与现有市场活动名称进行比较时,会执行不区分大小写的比较。

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
string
设置 受支持设置,这些设置因市场活动类型而异。

注意VerifiedTrackingSetting 当前不可用。

在设置列表中,每个设置类型最多可以包含一个对象,例如,一个 TargetSetting

如果 CampaignType 设置为 “搜索 ”并且未设置 ExperimentId 元素,则此列表可以选择包含 DynamicSearchAdsSetting 对象。 试验市场活动和试验基础市场活动不能包含动态搜索广告设置。 如果打算将此市场活动用于试验,请不要包含动态搜索广告设置。 如果现有试验已基于此市场活动,则无法更新市场活动以包含动态搜索广告设置。

如果 CampaignType 设置为 Shopping,则此列表必须包含 ShoppingSetting 对象。

如果 CampaignType 设置为 “受众”,则此列表可能包含或不包含 ShoppingSetting 对象,具体取决于受众市场活动是否支持产品广告。

如果 CampaignType 设置为 DynamicSearchAds,则此列表必须包含 DynamicSearchAdsSetting 对象。

如果 CampaignType 设置为 Hotel,则此列表必须包含 HotelSetting 对象。

如果 CampaignType 设置为 PerformanceMax,则此列表必须包含 PerformanceMaxSetting 对象。 如果“性能最大”市场活动关联到某个商店,则它还支持 ShoppingSetting

TargetSetting 可用于除 Performace Max 以外的任何市场活动类型,并确定与此市场活动关联的受众条件是使用“目标和出价”选项还是“仅出价”目标选项。 在 TargetSetting 中 ,可以有一个 TargetSettingDetail 对象,即每个受支持的 CriterionTypeGroup 一个对象。 市场活动级别目标设置当前支持的唯一条件类型值是“受众”。 默认情况下,不返回 TargetSetting 对象。 若要获取此对象,请在调用 GetCampaignsByAccountIdGetCampaignsByIds 服务操作时,在 ReturnAdditionalFields 元素中包含 TargetSetting 值。

加: 如果 CampaignType 设置为 DynamicSearchAdsShopping,则是必需的,否则此元素是可选的。 如果此元素不包括 TargetSetting 对象,则所有条件类型组的默认出价选项实际上是“仅出价”。
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 更新期间无法删除 DynamicSearchAdsSettingShoppingSetting 对象。
设置 数组
状态 市场活动的状态。

可能的值为 ActivePaused

如果预算耗尽,该服务将自动暂停市场活动。

使用试验市场活动时,不能设置 预算预算类型状态 试验市场活动的预算和状态始终继承自基本市场活动设置。

加: 自选。 默认值为 Paused
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。
CampaignStatus
SubType 市场活动子类型。

如果未设置子类型,则会根据市场活动类型创建市场活动。

如果子类型设置为 AudienceVideoAds ,并且市场活动类型为 Audience,则市场活动是视频受众市场活动。

如果子类型设置为 ShoppingSmartAds,则市场活动是Microsoft智能购物市场活动。

如果子类型设置为 ShoppingSponsoredProductAd,则市场活动是 品牌Microsoft购物市场活动

加: 可选,不适用于大多数市场活动类型。 对于Microsoft 智能购物市场活动 ,必须将子类型设置为 ShoppingSmartAds。 对于Microsoft 品牌的购物市场活动 ,必须将子类型设置为 ShoppingSponsoredProductAd
更新: 只读
string
TimeZone 此列已弃用。

市场活动活动的时区。

时区用于报告和应用广告组的开始和结束日期。

有关可能的值,请参阅 时区

使用试验市场活动时,无法设置 BudgetBudgetTypeStatusTimeZone。 试验市场活动的预算、状态和时区始终继承自基本市场活动设置。

加: 必填
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果市场活动包含或曾经包含处于 “活动 ”或“ 已暂停 ”状态的广告组,则不能更新时区。
string
TrackingUrlTemplate 要用作市场活动中所有 URL 的默认值的跟踪模板。

以下验证规则适用于跟踪模板。 有关支持的模板和参数的更多详细信息,请参阅Microsoft广告帮助文章 可以使用哪些跟踪或 URL 参数?
- 为较低级别的实体(例如广告)定义的跟踪模板将覆盖为较高级别的实体(例如市场活动)设置的模板。 有关详细信息,请参阅 实体限制
- 跟踪模板的长度限制为 2,048 个字符。 HTTP 或 HTTPS 协议字符串计入 2,048 个字符限制。
- 跟踪模板必须是格式正确的 URL,以下列项之一开头: http://https://{lpurl}{unescapedlpurl}
- Microsoft广告不验证自定义参数是否存在。 如果在跟踪模板中使用自定义参数,并且这些参数不存在,则登陆页 URL 将包含自定义参数的键和值占位符,而不进行替换。 例如,如果您的跟踪模板为 https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} ,并且未在市场活动、广告组、条件、关键字 (keyword) 或广告级别定义 {_season}{_promocode},则登陆页 URL 将相同。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 如果将此元素设置为空字符串 ( ”) ,则会删除以前的设置。
string
UrlCustomParameters 用于 URL 跟踪的键和值参数的自定义集合。

Microsoft Advertising 将接受在 CustomParameters 对象中包含的前 8 个 CustomParameter 对象 ,如果包含 8 个以上的自定义参数,则会返回错误。 每个 CustomParameter 都包含 元素。

加: 自选
更新: 自选。 如果未为更新设置任何值,则不会更改此设置。 将 UrlCustomParameters 元素设置为 null 或空,以保留任何现有自定义参数。 若要删除所有自定义参数,请将 CustomParameters 对象的 Parameters 元素设置为 null 或空。 若要删除自定义参数的子集,请指定要保留在 CustomParameters 对象的 Parameters 元素中的自定义参数。
CustomParameters

要求

服务: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

使用者

AddCampaigns
GetCampaignsByAccountId
GetCampaignsByIds
UpdateCampaigns