Edit

Share via

BatchErrorCollection Data Object - Campaign Management

  • Article

Defines an error object that contains batch error details for the top level list index and a list of batch errors corresponding to the nested list index.

For example in the NestedPartialErrors response element for AddNegativeKeywordsToEntities, the top level error details correspond to the campaign or ad group in the service request. The nested list of batch errors would include any errors specific to the negative keywords that you attempted to add to the campaign or ad group.

Syntax

<xs:complexType name="BatchErrorCollection" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="BatchErrors" nillable="true" type="tns:ArrayOfBatchError" />
    <xs:element minOccurs="0" name="Code" nillable="true" 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:q69="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q69: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 BatchErrorCollection object has the following elements: BatchErrors, Code, Details, ErrorCode, FieldPath, ForwardCompatibilityMap, Index, Message, Type.

Element Description Data Type
BatchErrors A list of batch errors corresponding to the nested list index. BatchError array
Code A numeric error code that identifies the error for the top level list index. int
Details A message that provides additional details about the batch error for the top level list index. This string can be empty. string
ErrorCode A symbolic string constant that identifies the error for the top level list index. string
FieldPath The name of the data object's element where the error occurred.

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.		 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 top level list index in the request message that failed. int
Message A message that describes the error for the top level list index. string
Type Reserved for internal use. string

Requirements

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

Used By

AddAdExtensions
AddAdGroupCriterions
AddCampaignCriterions
AddNegativeKeywordsToEntities
DeleteNegativeKeywordsFromEntities
UpdateAdExtensions
UpdateAdGroupCriterions
UpdateCampaignCriterions