EditorialError Data Object - Campaign Management
Defines an error object that identifies one of potentially many reasons why an entity failed editorial review.
Syntax
<xs:complexType name="EditorialError" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:BatchError">
<xs:sequence>
<xs:element minOccurs="0" name="Appealable" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="DisapprovedText" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Location" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PublisherCountry" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ReasonCode" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The EditorialError object has the following elements: Appealable, DisapprovedText, Location, PublisherCountry, ReasonCode.
| Element | Description | Data Type |
|---|---|---|
| Appealable | Reserved for future use. | boolean |
| DisapprovedText | The text that caused the entity to be disapproved. For text length violations, this element specifies the number of characters by which the specified text exceeds the maximum. |
string |
| Location | The element or property of the entity that caused the entity to be disapproved. | string |
| PublisherCountry | The corresponding country or region for the flagged editorial issue. | string |
| ReasonCode | A numeric code that identifies the error. For more information, see Editorial Reason Codes. | int |
The EditorialError object has Inherited Elements.
Inherited Elements
Inherited Elements from BatchError
The EditorialError object derives from the BatchError object, and inherits the following elements: Code, Details, ErrorCode, FieldPath, ForwardCompatibilityMap, Index, Message, Type. The descriptions below are specific to EditorialError, and might not apply to other objects that inherit the same elements from the BatchError object.
| 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 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. 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