BatchError Data Object - Campaign Management
Defines a Campaign Management batch error object that identifies the item within the batch of items in the request message that caused the operation to fail, and describes the reason for the failure.
Syntax
<xs:complexType name="BatchError" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="Code" type="xs:int" />
<xs:element minOccurs="0" name="Details" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FieldPath" nillable="true" type="xs:string" />
<xs:element xmlns:q14="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q14:ArrayOfKeyValuePairOfstringstring" />
<xs:element minOccurs="0" name="Index" type="xs:int" />
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
Elements
The BatchError object has the following elements: Code, Details, ErrorCode, FieldPath, ForwardCompatibilityMap, Index, Message, Type.
| Element | Description | Data Type |
|---|---|---|
| Code | A numeric error code that identifies the error. | int |
| Details | A message that provides additional details about the batch error. This string can be empty. | string |
| ErrorCode | A symbolic string constant that identifies the error. For example, UserIsNotAuthorized. | string |
| FieldPath | The name of the data object's element where the error occurred. For example if the TrackingUrlTemplate of a Campaign contains invalid text, the value of this FieldPath element is TrackingUrlTemplate. This value is subject to change, so you should not take a dependency on the current string format. This element is not supported for all errors. The field path is supported for errors related to FinalMobileUrls, FinalUrls, TrackingUrlTemplate, and UrlCustomParameters elements of the respective Campaign, AdGroup, TextAd, ProductAd, BiddableAdGroupCriterion, and Keyword objects. It is also supported for errors related to all fields of the CalloutAdExtension and ReviewAdExtension objects. |
string |
| ForwardCompatibilityMap | The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object. |
KeyValuePairOfstringstring array |
| Index | The zero-based index of the item in the batch of items in the request message that failed. | int |
| Message | A message that describes the error. For more information about troubleshooting and error handling, see Handling Service Errors and Exceptions and Operation Error Codes. |
string |
| Type | Reserved for internal use. | string |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Used By
AddAdGroups
AddAds
AddAssetGroups
AddAudienceGroups
AddAudiences
AddBidStrategies
AddBudgets
AddCampaignConversionGoals
AddCampaigns
AddConversionGoals
AddDataExclusions
AddExperiments
AddImportJobs
AddKeywords
AddLabels
AddListItemsToSharedList
AddSeasonalityAdjustments
AddSharedEntity
AddUetTags
AddVideos
ApiFaultDetail
AppealEditorialRejections
ApplyAssetGroupListingGroupActions
ApplyCustomerListItems
ApplyCustomerListUserData
ApplyHotelGroupActions
ApplyOfflineConversionAdjustments
ApplyOfflineConversions
ApplyOnlineConversionAdjustments
ApplyProductPartitionActions
BatchErrorCollection
DeleteAdExtensions
DeleteAdExtensionsAssociations
DeleteAdGroupCriterions
DeleteAdGroups
DeleteAds
DeleteAssetGroups
DeleteAudienceGroupAssetGroupAssociations
DeleteAudienceGroups
DeleteAudiences
DeleteBidStrategies
DeleteBudgets
DeleteCampaignConversionGoals
DeleteCampaignCriterions
DeleteCampaigns
DeleteDataExclusions
DeleteExperiments
DeleteImportJobs
DeleteKeywords
DeleteLabelAssociations
DeleteLabels
DeleteListItemsFromSharedList
DeleteMedia
DeleteSeasonalityAdjustments
DeleteSharedEntities
DeleteSharedEntityAssociations
DeleteVideos
EditorialApiFaultDetail
GetAccountProperties
GetAdExtensionsAssociations
GetAdExtensionsByIds
GetAdExtensionsEditorialReasons
GetAdGroupsByIds
GetAdsByIds
GetAssetGroupsByCampaignId
GetAssetGroupsByIds
GetAssetGroupsEditorialReasons
GetAudienceGroupAssetGroupAssociationsByAssetGroupIds
GetAudienceGroupAssetGroupAssociationsByAudienceGroupIds
GetAudienceGroupsByIds
GetAudiencesByIds
GetBidStrategiesByIds
GetBudgetsByIds
GetCampaignCriterionsByIds
GetCampaignIdsByBidStrategyIds
GetCampaignIdsByBudgetIds
GetCampaignsByIds
GetConversionGoalsByIds
GetConversionGoalsByTagIds
GetDataExclusionsByAccountId
GetDataExclusionsByIds
GetEditorialReasonsByIds
GetExperimentsByIds
GetImportEntityIdsMapping
GetImportJobsByIds
GetKeywordsByIds
GetLabelAssociationsByEntityIds
GetLabelAssociationsByLabelIds
GetLabelsByIds
GetMediaAssociations
GetMediaMetaDataByIds
GetNegativeKeywordsByEntityIds
GetNegativeSitesByAdGroupIds
GetNegativeSitesByCampaignIds
GetSeasonalityAdjustmentsByAccountId
GetSeasonalityAdjustmentsByIds
GetSharedEntityAssociationsByEntityIds
GetSharedEntityAssociationsBySharedEntityIds
GetUetTagsByIds
GetVideosByIds
SetAdExtensionsAssociations
SetAudienceGroupAssetGroupAssociations
SetLabelAssociations
SetNegativeSitesToAdGroups
SetNegativeSitesToCampaigns
SetSharedEntityAssociations
UpdateAdGroups
UpdateAds
UpdateAssetGroups
UpdateAudienceGroups
UpdateAudiences
UpdateBidStrategies
UpdateBudgets
UpdateCampaigns
UpdateConversionGoals
UpdateDataExclusions
UpdateExperiments
UpdateImportJobs
UpdateKeywords
UpdateLabels
UpdateSeasonalityAdjustments
UpdateSharedEntities
UpdateUetTags
UpdateVideos