Error Responses

When an API request is successful, the API returns a 200 OK status code along with the requested data in the response body. If an error occurs, the API returns one of the canonical error codes defined by Google APIs, mapped to an HTTP status code, and a response body containing error information. When encountering an error, inspect the message and status fields in the JSON response body for specific details to help with debugging.

Error format

If a request results in an error, the API returns an appropriate HTTP status code and a JSON response body. The error response contains an error object with the following structure:

  { 
  
 "error" 
 : 
  
 { 
  
 "code" 
 : 
  
 403 
 , 
  
 "message" 
 : 
  
 "User does not have sufficient permissions for this property." 
 , 
  
 "status" 
 : 
  
 "PERMISSION_DENIED" 
  
 } 
 } 
 

The error object contains these fields:

Common errors

The following table lists common errors returned by the API.