Export (0) Print
Expand All
Ad
Bid
Expand Minimize

Campaign Data Object

Defines a campaign.

<xs:complexType name="Campaign">
  <xs:sequence>
    <xs:element minOccurs="0" name="BudgetType" nillable="true" type="tns:BudgetLimitType" />
    <xs:element minOccurs="0" name="ConversionTrackingEnabled" nillable="true" type="xs:boolean" />
    <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 minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q1:ArrayOfKeyValuePairOfstringstring" xmlns:q1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
    <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="Status" nillable="true" type="tns:CampaignStatus" />
    <xs:element minOccurs="0" name="TimeZone" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

Rules

BudgetType

The budget type determines whether the campaign uses a daily budget or a monthly budget, and how the budget is spent. For possible values, see BudgetLimitType.

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

BudgetLimitType

Required

Optional

None

ConversionTrackingEnabled

Conversion tracking is no longer supported at the campaign level. If you set this element, the value is ignored.

If your website uses a campaign-level conversion tracking script, the script will continue to work and reporting will continue to report conversion data.

To capture conversion tracking data, enable account analytics in the Bing Ads web application.

boolean

Optional

Optional

None

DailyBudget

The amount to spend daily on the campaign. You must set the daily budget amount if BudgetType is set to DailyBudgetAccelerated or DailyBudgetStandard.

System_CLiX_noteNote

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

double

Required

Optional

Budget Rules

DaylightSaving

Determines 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.

System_CLiX_noteNote

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.

boolean

Required

Optional

None

Description

The description of the campaign. The description can contain a maximum of 1,000 characters.

string

Required

Optional

None

ForwardCompatibilityMap

The following list of key and value strings are available for forward compatibility.

Key

Value

Description

KeywordVariantMatchEnabled

System_CLiX_noteNote

Available only in the United States.

The possible values are True or False.

If not specified, the default value is True.

For accounts in the United States which have English language ad groups, Bing Ads automatically includes close variations of your exact match keywords, such as plural forms. For example, if your keyword is “motorcycle,” close variations would include “motorcycles".

If you don’t want your ads to show for close variations of your exact match keywords, then set the value to False.

System_CLiX_noteNote

If you set the value to False, then you are effectively opting out of all current and future close keyword variant match enhancements.

Set the value to True to use close variations of your exact match type keywords such as plural forms.

KeyValuePairOfstringstring array

Optional

Optional

None

Id

The system-generated identifier of the campaign.

long

Read-only

Required

None

MonthlyBudget

The monthly budget of the campaign. You must specify a monthly budget only if BudgetType is set to MonthlyBudgetSpendUntilDepleted.

double

Required

Optional

Budget Rules

Name

The 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.

string

Required

Optional

None

Status

The status of the campaign.

The service will automatically pause the campaign if the budget is depleted.

CampaignStatus

Optional

Optional

None

TimeZone

The time zone where the campaign operates. For possible values, see Time Zones.

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.

string

Required

Optional

None

Business Rules

Budget Rules

The following are the budget rules:

  • The monthly budget amount must be within the allowed range for the currency.

    For more information about minimum and maximum budgets allowed, see Currencies.

  • If the daily budget amount or monthly budget amount is depleted, the campaign is paused automatically.

  • If the BudgetType is set to MonthlyBudgetSpendUntilDepleted and you update the budget to a value that is less than what is currently spent for the month, the service pauses the campaign. However, the same is not true for campaigns that specify a daily budget.

If you create a campaign and specify a daily budget, the service calculates the monthly budget limit by multiplying the daily budget by the number of days in the month. The service calculates the new monthly budget at midnight (in the campaign’s time zone) on the first day of each month.

If you update a campaign that specifies a daily budget on the first day of the month, the service also calculates the monthly budget limit by multiplying the daily budget by the number of days in the month. However, if you update the daily budget after the first day of the month, the service uses the following formula to calculate the monthly budget.

Monthly budget = month-to-date spend + daily budget * (days remaining in the month, including today)

For example, if you change the daily budget to $10 on July 15th, and you have spent $250 of the $400 budget, the new budget will be $420, which is calculated as $250 + $10(17).

The service will use the new monthly budget for the remainder of the current month, but for subsequent months, it will calculate the monthly budget by multiplying the daily budget amount by the number of days in the month.

The service will update the monthly budget of an existing campaign by using the new formula only if you update the campaign’s budget; otherwise, the monthly budget remains unchanged and is enforced.

Requirements

CampaignManagementService.svc v9

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

Community Additions

ADD
Show:
© 2014 Microsoft