共通エラー応答とコード

OneDrive API のエラーは、標準の HTTP 状態コード、および JSON エラー応答オブジェクトを使用して返されます。 次のような HTTP 状態コードが予期されます。

エラー応答は、エラーという名前の 1 つのプロパティを含む 1 つの JSON オブジェクトです。 このオブジェクトには、すべてのエラーの詳細が含まれます。 返された HTTP 状態 コードの代わりに、またはこれに加えて、ここに返される情報を使用する場合があります。 完全な JSON エラー本文の例を示します。

{
  "error": {
    "code": "invalidRange",
    "message": "Uploaded fragment overlaps with existing data.",
    "innererror": {
      "code": "fragmentOverlap"
    }
  }
}

コードのプロパティ

code プロパティには、有効な 15 の値のいずれかが含まれます。 アプリは、これらのエラーのいずれかを処理するように準備する必要があります。

innererror オブジェクトには、さらに詳細な追加のエラー コードを持つ別の複数の innererror オブジェクトが再帰的に含まれる可能性があります。 エラーを処理する際に、アプリは使用可能なすべてのエラー コード間をループして、アプリが理解する最も詳細なコードを使用する必要があります。 より詳細なコードの一部は、このページの下部に一覧表示されています。

エラー オブジェクトが予期したとおりのエラーであることを確認するには、innererror オブジェクト全体をループして、予期したエラー コードを検索する必要があります。 次に例を示します。

public bool IsError(string expectedErrorCode)
{
    OneDriveInnerError errorCode = this.Error;
    while (null != errorCode)
    {
        if (errorCode.Code == expectedErrorCode)
            return true;
        errorCode = errorCode.InnerError;
    }
    return false;
}

エラーを正しく処理する完全な例については、「OneDrive エラー コードの処理」を参照してください。

ルートにある message プロパティには、開発者が読み取ることを目的としたエラー メッセージが含まれます。 エラー メッセージはローカライズされておらず、直接ユーザーに表示すべきではありません。 エラーを処理する場合、コードは、いつでも変更できるため、値の message キーオフを行うべきではありません。また、失敗した要求に固有の動的な情報が含まれていることがよくあります。 code プロパティで返されるエラー コードに対してのみ、コードを記述する必要があります。

エラー応答で返されるリソースの詳細については、「エラー リソースの種類」のトピックを参照してください。

詳細なエラー コード

入れ子になったオブジェクト内でアプリで発生する可能性があるその他のエラーを次に innererror 示します。 アプリはこれらを処理する必要はありませんが、選択した場合は可能です。 サービスは、新しいエラー コードを追加したり、古いエラー コードの返しをいつでも停止したりする可能性があるため、すべてのアプリで 上記の基本 15 を処理できることが重要です。