BatchError Data Object


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.

<xs:complexType name="BatchError">
    <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:q9="" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q9: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" />

ElementDescriptionData Type
CodeA numeric error code that identifies the
DetailsA message that provides additional details about the batch error. This string can be empty.string
ErrorCodeA symbolic string constant that identifies the error. For example, UserIsNotAuthorized.string
FieldPathThe 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.

Note: This value is subject to change, so you should not take a dependency on the current string format.

Note: 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.
ForwardCompatibilityMapThe list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

Note: Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this data object.
KeyValuePairOfstringstring array
IndexThe zero-based index of the item in the batch of items in the request message that
MessageA message that describes the error.string
TypeReserved for internal use.string

CampaignManagementService.svc v10