Edit

Share via

AdApiError Data Object - Reporting

  • Article

Defines a Reporting Ad API error object that contains the details that explain why the service operation failed.

Syntax

<xs:complexType name="AdApiError" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Code" type="xs:int" />
    <xs:element minOccurs="0" name="Detail" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The AdApiError object has the following elements: Code, Detail, ErrorCode, Message.

Element Description Data Type
Code A numeric error code that identifies the error. int
Detail A message that contains additional details about the error. This string can be empty. string
ErrorCode A symbolic string constant that identifies the error. For example, UserIsNotAuthorized. string
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

Requirements

Service: ReportingService.svc v13
Namespace: https://adapi.microsoft.com

Used By

AdApiFaultDetail