Handle request errors

  • The Routes API provides error messages within its responses to indicate issues with the request.

  • Errors are returned as JSON objects containing an error field with details about the issue, such as a code, message, and status.

  • Missing API keys result in a PERMISSION_DENIED error with a 403 code.

  • Omitting required parameters like origin leads to an INVALID_ARGUMENT error with a 400 code.

  • Further details on errors and their handling can be found in the Google Cloud API Design Guide on Errors.
European Economic Area (EEA) developers

The Routes 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.