UpdateCampaigns Service Operation - Campaign Management
Updates specified campaigns in a specified account.
Request Elements
The UpdateCampaignsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AccountId | The identifier of the account that contains the campaign to update. | long |
| Campaigns | An array that can contain a maximum of 100 Campaign objects to update. | Campaign array |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The UpdateCampaignsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Action mustUnderstand="1">UpdateCampaigns</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<UpdateCampaignsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<Campaigns i:nil="false">
<Campaign>
<AudienceAdsBidAdjustment i:nil="false">ValueHere</AudienceAdsBidAdjustment>
<BiddingScheme i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
<Type i:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to MaxClicksBiddingScheme-->
<MaxCpc i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</MaxCpc>
<!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
<MaxCpc i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetCpa i:nil="false">ValueHere</TargetCpa>
<!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
<MaxCpc i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetCpa i:nil="false">ValueHere</TargetCpa>
<!--No additional fields are applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to EnhancedCpcBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
<!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
<InheritedBidStrategyType i:nil="false">ValueHere</InheritedBidStrategyType>
<!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
<MaxCpc i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetRoas i:nil="false">ValueHere</TargetRoas>
<!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
<MaxCpc i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</MaxCpc>
<!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
<TargetRoas i:nil="false">ValueHere</TargetRoas>
<!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
<MaxCpc i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetAdPosition i:nil="false">ValueHere</TargetAdPosition>
<TargetImpressionShare i:nil="false">ValueHere</TargetImpressionShare>
<!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
<MaxPercentCpc i:nil="false">ValueHere</MaxPercentCpc>
<!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
<CommissionRate i:nil="false">ValueHere</CommissionRate>
<!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
<ManualCpi i:nil="false">ValueHere</ManualCpi>
<!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
<TargetCostPerSale i:nil="false">ValueHere</TargetCostPerSale>
</BiddingScheme>
<BudgetType i:nil="false">ValueHere</BudgetType>
<DailyBudget i:nil="false">ValueHere</DailyBudget>
<DealIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</DealIds>
<ExperimentId i:nil="false">ValueHere</ExperimentId>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<ForwardCompatibilityMap xmlns:e419="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e419:KeyValuePairOfstringstring>
<e419:key i:nil="false">ValueHere</e419:key>
<e419:value i:nil="false">ValueHere</e419:value>
</e419:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<GoalIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</GoalIds>
<Id i:nil="false">ValueHere</Id>
<IsDealCampaign i:nil="false">ValueHere</IsDealCampaign>
<MultimediaAdsBidAdjustment i:nil="false">ValueHere</MultimediaAdsBidAdjustment>
<Name i:nil="false">ValueHere</Name>
<Status i:nil="false">ValueHere</Status>
<SubType i:nil="false">ValueHere</SubType>
<TimeZone i:nil="false">ValueHere</TimeZone>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<CampaignType i:nil="false">ValueHere</CampaignType>
<Settings i:nil="false">
<Setting i:type="-- derived type specified here with the appropriate prefix --">
<Type i:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to VerifiedTrackingSetting-->
<Details xmlns:e420="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e420:ArrayOfKeyValuePairOfstringstring>
<e420:KeyValuePairOfstringstring>
<e420:key i:nil="false">ValueHere</e420:key>
<e420:value i:nil="false">ValueHere</e420:value>
</e420:KeyValuePairOfstringstring>
</e420:ArrayOfKeyValuePairOfstringstring>
</Details>
<!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
<FeedLabel i:nil="false">ValueHere</FeedLabel>
<LocalInventoryAdsEnabled i:nil="false">ValueHere</LocalInventoryAdsEnabled>
<Priority i:nil="false">ValueHere</Priority>
<SalesCountryCode i:nil="false">ValueHere</SalesCountryCode>
<ShoppableAdsEnabled i:nil="false">ValueHere</ShoppableAdsEnabled>
<StoreId i:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
<FeedId i:nil="false">ValueHere</FeedId>
<!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
<DomainName i:nil="false">ValueHere</DomainName>
<DynamicDescriptionEnabled i:nil="false">ValueHere</DynamicDescriptionEnabled>
<Language i:nil="false">ValueHere</Language>
<PageFeedIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<Source i:nil="false">ValueHere</Source>
<!--This field is applicable if the derived type attribute is set to TargetSetting-->
<Details i:nil="false">
<TargetSettingDetail>
<CriterionTypeGroup>ValueHere</CriterionTypeGroup>
<TargetAndBid>ValueHere</TargetAndBid>
</TargetSettingDetail>
</Details>
<!--These fields are applicable if the derived type attribute is set to CoOpSetting-->
<BidBoostValue i:nil="false">ValueHere</BidBoostValue>
<BidMaxValue i:nil="false">ValueHere</BidMaxValue>
<BidOption i:nil="false">ValueHere</BidOption>
<!--This field is applicable if the derived type attribute is set to DisclaimerSetting-->
<DisclaimerAdsEnabled>ValueHere</DisclaimerAdsEnabled>
<!--This field is applicable if the derived type attribute is set to HotelSetting-->
<HotelAdGroupType>ValueHere</HotelAdGroupType>
<!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsSetting-->
<AutoGeneratedAssetsEnabled i:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
<!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
<AutoGeneratedImageOptOut i:nil="false">ValueHere</AutoGeneratedImageOptOut>
<AutoGeneratedTextOptOut i:nil="false">ValueHere</AutoGeneratedTextOptOut>
<CostPerSaleOptOut i:nil="false">ValueHere</CostPerSaleOptOut>
<FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
<PageFeedIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<!--These fields are applicable if the derived type attribute is set to CallToActionSetting-->
<AutomatedCallToActionOptOut i:nil="false">ValueHere</AutomatedCallToActionOptOut>
<CallToActionOptOut i:nil="false">ValueHere</CallToActionOptOut>
<!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
<DisplayUrlMode i:nil="false">ValueHere</DisplayUrlMode>
<WebsiteDescription i:nil="false">ValueHere</WebsiteDescription>
<!--These fields are applicable if the derived type attribute is set to AppSetting-->
<AppId i:nil="false">ValueHere</AppId>
<AppStore>ValueHere</AppStore>
<!--This field is applicable if the derived type attribute is set to ThirdPartyMeasurementSetting-->
<Details xmlns:e421="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e421:ArrayOfKeyValuePairOfstringstring>
<e421:KeyValuePairOfstringstring>
<e421:key i:nil="false">ValueHere</e421:key>
<e421:value i:nil="false">ValueHere</e421:value>
</e421:KeyValuePairOfstringstring>
</e421:ArrayOfKeyValuePairOfstringstring>
</Details>
</Setting>
</Settings>
<BudgetId i:nil="false">ValueHere</BudgetId>
<Languages i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Languages>
<AdScheduleUseSearcherTimeZone i:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
<BidStrategyId i:nil="false">ValueHere</BidStrategyId>
</Campaign>
</Campaigns>
</UpdateCampaignsRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<UpdateCampaignsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e422="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e422:KeyValuePairOfstringstring>
<e422:key d4p1:nil="false">ValueHere</e422:key>
<e422:value d4p1:nil="false">ValueHere</e422:value>
</e422:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</UpdateCampaignsResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<UpdateCampaignsResponse> UpdateCampaignsAsync(
long accountId,
IList<Campaign> campaigns)
{
var request = new UpdateCampaignsRequest
{
AccountId = accountId,
Campaigns = campaigns
};
return (await CampaignManagementService.CallAsync((s, r) => s.UpdateCampaignsAsync(r), request));
}
static UpdateCampaignsResponse updateCampaigns(
java.lang.Long accountId,
ArrayOfCampaign campaigns) throws RemoteException, Exception
{
UpdateCampaignsRequest request = new UpdateCampaignsRequest();
request.setAccountId(accountId);
request.setCampaigns(campaigns);
return CampaignManagementService.getService().updateCampaigns(request);
}
static function UpdateCampaigns(
$accountId,
$campaigns)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new UpdateCampaignsRequest();
$request->AccountId = $accountId;
$request->Campaigns = $campaigns;
return $GLOBALS['CampaignManagementProxy']->GetService()->UpdateCampaigns($request);
}
response=campaignmanagement_service.UpdateCampaigns(
AccountId=AccountId,
Campaigns=Campaigns)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Campaigns
Request Elements
The UpdateCampaignsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AccountId | The identifier of the account that contains the campaign to update. | long |
| Campaigns | An array that can contain a maximum of 100 Campaign objects to update. | Campaign array |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The UpdateCampaignsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
Below is an example that is applicable if the type of BiddingScheme is CommissionBiddingScheme, Setting is AppSetting.
{
"AccountId": "LongValueHere",
"Campaigns": [
{
"AdScheduleUseSearcherTimeZone": "ValueHere",
"AudienceAdsBidAdjustment": IntValueHere,
"BiddingScheme": {
"Type": "CommissionBiddingScheme",
"CommissionRate": DoubleValueHere
},
"BidStrategyId": "LongValueHere",
"BudgetId": "LongValueHere",
"BudgetType": "ValueHere",
"CampaignType": "ValueHere",
"DailyBudget": DoubleValueHere,
"DealIds": [
"LongValueHere"
],
"ExperimentId": "LongValueHere",
"FinalUrlSuffix": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"GoalIds": [
"LongValueHere"
],
"Id": "LongValueHere",
"IsDealCampaign": "ValueHere",
"Languages": [
"ValueHere"
],
"MultimediaAdsBidAdjustment": IntValueHere,
"Name": "ValueHere",
"Settings": [
{
"Type": "AppSetting",
"AppId": "ValueHere",
"AppStore": "ValueHere"
}
],
"Status": "ValueHere",
"SubType": "ValueHere",
"TimeZone": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "ValueHere"
}
]
}
}
]
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of BatchError is EditorialError.
{
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<UpdateCampaignsResponse> UpdateCampaignsAsync(
long accountId,
IList<Campaign> campaigns)
{
var request = new UpdateCampaignsRequest
{
AccountId = accountId,
Campaigns = campaigns
};
return (await CampaignManagementService.CallAsync((s, r) => s.UpdateCampaignsAsync(r), request));
}
static UpdateCampaignsResponse updateCampaigns(
java.lang.Long accountId,
ArrayOfCampaign campaigns) throws RemoteException, Exception
{
UpdateCampaignsRequest request = new UpdateCampaignsRequest();
request.setAccountId(accountId);
request.setCampaigns(campaigns);
return CampaignManagementService.getService().updateCampaigns(request);
}
static function UpdateCampaigns(
$accountId,
$campaigns)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new UpdateCampaignsRequest();
$request->AccountId = $accountId;
$request->Campaigns = $campaigns;
return $GLOBALS['CampaignManagementProxy']->GetService()->UpdateCampaigns($request);
}
response=campaignmanagement_service.UpdateCampaigns(
AccountId=AccountId,
Campaigns=Campaigns)