BatchError Data Object - Campaign Management

Defines an 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 minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q10:ArrayOfKeyValuePairOfstringstring" xmlns:q10="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
    <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

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, Keyword, and SiteLink 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 data 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. string
Type Reserved for internal use. string

Requirements

Service: CampaignManagementService.svc v11
Namespace: https://bingads.microsoft.com/CampaignManagement/v11

Used By

AddAdGroups
AddAds
AddAudiences
AddBudgets
AddCampaigns
AddConversionGoals
AddKeywords
AddLabels
AddListItemsToSharedList
AddSharedEntity
AddUetTags
ApiFaultDetail
AppealEditorialRejections
ApplyOfflineConversions
ApplyProductPartitionActions
BatchErrorCollection
DeleteAdExtensions
DeleteAdExtensionsAssociations
DeleteAdGroupCriterions
DeleteAdGroups
DeleteAds
DeleteAudiences
DeleteBudgets
DeleteCampaignCriterions
DeleteCampaigns
DeleteKeywords
DeleteLabelAssociations
DeleteLabels
DeleteListItemsFromSharedList
DeleteMedia
DeleteSharedEntities
DeleteSharedEntityAssociations
EditorialApiFaultDetail
GetAccountProperties
GetAdExtensionsAssociations
GetAdExtensionsByIds
GetAdExtensionsEditorialReasons
GetAdGroupsByIds
GetAdsByIds
GetAudiencesByIds
GetBudgetsByIds
GetCampaignCriterionsByIds
GetCampaignIdsByBudgetIds
GetCampaignsByIds
GetConversionGoalsByIds
GetConversionGoalsByTagIds
GetEditorialReasonsByIds
GetKeywordsByIds
GetLabelAssociationsByEntityIds
GetLabelAssociationsByLabelIds
GetLabelsByIds
GetMediaAssociations
GetMediaMetaDataByIds
GetNegativeKeywordsByEntityIds
GetNegativeSitesByAdGroupIds
GetNegativeSitesByCampaignIds
GetSharedEntityAssociationsByEntityIds
GetSharedEntityAssociationsBySharedEntityIds
GetUetTagsByIds
SetAdExtensionsAssociations
SetLabelAssociations
SetNegativeSitesToAdGroups
SetNegativeSitesToCampaigns
SetSharedEntityAssociations
UpdateAdGroups
UpdateAds
UpdateAudiences
UpdateBudgets
UpdateCampaigns
UpdateConversionGoals
UpdateKeywords
UpdateLabels
UpdateSharedEntities
UpdateUetTags