Handle request errors

  • The Routes Preferred API utilizes error messages within its responses to indicate issues with method calls.

  • These error messages provide specific details, including an error code, a descriptive message, and a status indicator, to help identify the cause of the error.

  • Common errors include missing API keys, resulting in a "PERMISSION_DENIED" status, or omitting required parameters like "origin," leading to an "INVALID_ARGUMENT" status.

  • For a comprehensive understanding of errors and their handling within Google Cloud APIs, refer to the provided documentation on Errors.

The Routes Preferred API returns error messages as part of the response to a method call. For example, if you omit the API key from the request, the method returns:

{
  "error": {
    "code": 403,
    "message": "The request is missing a valid API key.",
    "status": "PERMISSION_DENIED"
  }
}

If you omit a required body parameter, such as origin, the method returns:

{
  "error": {
    "code": 400,
    "message": "Origin and destination must be set.",
    "status": "INVALID_ARGUMENT"
  }
}

For more information on errors and error handling, see Errors.