Campaign
Ad
AppInstallGoal
Bid
ConversionGoal
ConversionGoalRevenue
DurationGoal
EventGoal
PagesViewedPerVisitGoal
UetTag
UrlGoal
TOC
Collapse the table of content
Expand the table of content

Campaign Data Object

 

Defines a campaign.

<xs:complexType name="Campaign">
  <xs:sequence>
    <xs:element xmlns:q6="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" minOccurs="0" name="BiddingScheme" nillable="true" type="q6:BiddingScheme">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="BudgetId" nillable="true" type="xs:long" />
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="BudgetType" nillable="true" type="tns:BudgetLimitType" />
    <xs:element minOccurs="0" name="DailyBudget" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="DaylightSaving" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
    <xs:element xmlns:q7="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q7:ArrayOfKeyValuePairOfstringstring"/>
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="MonthlyBudget" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="NativeBidAdjustment" nillable="true" type="xs:int"/>
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:CampaignStatus" />
    <xs:element minOccurs="0" name="TimeZone" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string"/>
    <xs:element xmlns:q8="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" minOccurs="0" name="UrlCustomParameters" nillable="true" type="q8:CustomParameters"/>
    <xs:element minOccurs="0" name="CampaignType" nillable="true" type="tns:CampaignType"/>
    <xs:element minOccurs="0" name="Settings" nillable="true" type="tns:ArrayOfSetting"/>
  </xs:sequence>
</xs:complexType>

ElementDescriptionData TypeAddUpdate
BiddingSchemeThe bid strategy type for how you want to manage your bids. For campaigns you can use either of the EnhancedCpcBiddingScheme or ManualCpcBiddingScheme objects. If you do not set this element, then ManualCpcBiddingScheme is used by default.

Note: Not everyone has this feature yet. If you don’t, don’t worry. It’s coming soon.

Note: This element is not supported for campaigns of type Shopping.

Note: This element is not returned in the Campaign object by default. You must include BiddingScheme in the optional ReturnAdditionalFields flags when calling GetCampaignsByAccountId and GetCampaignsByIds.

Tip: You can set your campaign’s bid strategy to Enhanced CPC (EnhancedCpcBiddingScheme) and then, at any time, set an individual ad group’s or keyword’s bid strategy to Manual CPC (ManualCpcBiddingScheme).
BiddingSchemeOptionalOptional
BudgetIdThe unique Bing Ads identifier of the Budget that this campaign shares with other campaigns in the account.

Note: Not everyone has this feature yet. If you don’t, don’t worry. It’s coming soon. Shared budgets are coming to Bing Ads in the third quarter of calendar year 2016.

If the value is not null and greater than zero, then the campaign is using a shared budget. If the value is null, then the campaign is not using a shared budget. If the campaign is using a shared budget, and you prefer that it use its own budget e.g. DailyBudget amount, set this element to '0' (zero) and set DailyBudget to a valid budget amount.

Note: This element is not returned in the Campaign object by default. You must include BudgetId in the optional ReturnAdditionalFields flags when calling GetCampaignsByAccountId and GetCampaignsByIds.
longRead-onlyRequired
BudgetTypeThe budget type determines whether the campaign uses a daily budget or a monthly budget, and how the budget is spent.

Depending on the type of budget that you specify, you must set the DailyBudget or MonthlyBudget element.

Note: Shared budgets are coming to Bing Ads in the third quarter of calendar year 2016. The MonthlyBudget value is not supported if you use a shared budget.
BudgetLimitTypeRequiredOptional
CampaignTypeThe campaign type determines whether the campaign is a Bing Shopping campaign or a Search & Content campaign.CampaignTypeOptionalOptional
DailyBudgetThe amount to spend daily on the campaign. You must set the daily budget amount if BudgetType is set to DailyBudgetAccelerated or DailyBudgetStandard.

Note: If the campaign budget is set to MonthlyBudgetSpendUntilDepleted, then the returned daily budget is returned as a zero value.

Note: Shared budgets are coming to Bing Ads in the third quarter of calendar year 2016. In the context of shared budgets, the budget amount is a read-only property that is always returned regardless of whether or not the campaign uses a shared budget. When a campaign is associated to a shared budget the amount returned is that of the shared budget. If you try to update the budget amount of a campaign that has a shared budget, the service will return the CampaignServiceCannotUpdateSharedBudget error code. You can continue to set this property for unshared budgets, and you can make other updates to the campaign regardless of whether the budget is shared. To determine whether the campaign uses a shared budget, check the value of the BudgetId element as described above.
doubleRequiredOptional
DaylightSavingDetermines whether daylight-saving time is enabled.

If you set this element to true and if your campaign time zone observes Daylight Savings Time, Bing Ads will adjust the StartDate and EndDate of each AdGroup in this campaign accordingly.

If you set this element to false, Bing Ads will make no time adjustments to the StartDate and EndDate of your ad group, even if your campaign time zone observes Daylight Savings Time.

Note: If you set this element to true for a campaign that has a time zone where Daylight Savings Time is not observed, Bing Ads does not provide any feedback or throw an error.
booleanRequiredOptional
DescriptionThe description of the campaign. The description can contain a maximum of 1,000 characters.stringRequiredOptional
ForwardCompatibilityMapThe list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

Note: Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the Campaign object.
KeyValuePairOfstringstring arrayOptionalOptional
IdThe unique Bing Ads identifier of the campaign.longRead-onlyRequired
MonthlyBudgetThe monthly budget of the campaign. You must specify a monthly budget only if BudgetType is set to MonthlyBudgetSpendUntilDepleted.

Note: Shared budgets are coming to Bing Ads in the third quarter of calendar year 2016. In the context of shared budgets, the budget amount is a read-only property that is always returned regardless of whether or not the campaign uses a shared budget. If you try to update the budget amount of a campaign that has a shared budget, the service will return the CampaignServiceCannotUpdateSharedBudget error code. You can continue to set this property for unshared budgets, and you can make other updates to the campaign regardless of whether the budget is shared. To determine whether the campaign uses a shared budget, check the value of the BudgetId element as described above.

Important: Monthly budgets are deprecated and there will be a forced migration to daily budgets in calendar year 2017. Shared budgets do not support the monthly budget type, so this is only applicable to unshared budgets. During the migration all campaign level unshared budgets will be rationalized as daily. Moving campaign monthly budget to daily budget is encouraged before monthly budgets are migrated. The formula that will be used to convert monthly to daily budgets is: Monthly budget amount / 30.4. If the result of division falls below the minimum campaign budget, the budget will be set to the minimum depending on the currency of your account.
doubleRequiredOptional
NameThe name of the campaign. The name must be unique among all active or paused campaigns within the account. The name can contain a maximum of 128 characters.

The service performs a case-insensitive comparison when it compares the name to existing campaign names.
stringRequiredOptional
NativeBidAdjustmentThe percent amount by which to adjust your bid for native ads above or below the base ad group or keyword bid.

Supported values are negative one hundred (-100) through positive nine hundred (900). Setting the bid adjustment to -100 will prevent native ads from showing for this campaign.

Set this element to zero (0) if you want to use the base ad group or keyword bid instead of specifying any bid adjustment for native ads.

As a best practice you should always specify a bid adjustment value. If you set this element to null the system default bid adjustment will be used. The system default bid adjustment is currently zero (0), and is subject to change.
intOptionalOptional
SettingsThe setting will vary by campaign type. For example if the CampaignType element is Shopping, then one of the objects in this element's list is a ShoppingSetting.Setting arrayOptionalOptional
StatusThe status of the campaign.

The service will automatically pause the campaign if the budget is depleted.
CampaignStatusOptionalOptional
TimeZoneThe time zone where the campaign operates. For possible values, see Common Market Values.

The time zone is used for reporting, targeting, and applying the StartDate and EndDate of an ad group.

You may not update the time zone if the campaign contains or has ever contained ad groups in the Active or Paused state.
stringRequiredOptional
TrackingUrlTemplateThe tracking template to use as a default for all URLs in your campaign.

The following validation rules apply to tracking templates.

  • Tracking templates defined for lower level entities e.g. keyword override those set for higher level entities e.g. campaign. For more information, see Entity Hierarchy and Limits.

  • The length of the tracking template is limited to 2,048 characters.

    Note: The HTTP or HTTPS protocol string does count towards the 2,048 character limit.

  • The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}.

  • You can use any dynamic parameter supported by Bing Ads. For a list of supported parameters, see the Available parameters sections within the Bing Ads help article Set up a tracking template.

  • Bing Ads does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the final URL will include the key and value placeholders of your custom parameters without substitution. For example if your tracking template is for example http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}, and neither {_season} or {_promocode} are defined at the campaign, ad group, keyword, or ad level, then the final URL will be the same.

stringOptionalOptional
UrlCustomParametersYour custom collection of key and value parameters for URL tracking.

You may include up to 3 individual CustomParameter objects within the CustomParameters object. Each CustomParameter contains a Key and Value element.

On update, set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.
CustomParametersOptionalOptional

CampaignManagementService.svc v10

Namespace: https://bingads.microsoft.com/CampaignManagement/v10

AddCampaignsGetCampaignsByAccountIdGetCampaignsByIdsUpdateCampaignsSettingShoppingSettingCampaignType

Community Additions

ADD
Show:
© 2016 Microsoft