名前で特殊フォルダーを取得する

特殊なコレクションを使用して、名前で特殊フォルダーにアクセスします。

特殊フォルダーは、フォルダーを (ローカライズが必要となる) パスで探したり、ID を持つフォルダーを参照したりせずに、OneDrive の既知のフォルダーにアクセスするための、単純なエイリアスを提供します。 特殊フォルダーの名前が変更されたりドライブ内の別の場所に移動されたりした場合でも、この構文はそのフォルダーを返し続けます。

特殊なフォルダーは、まだ存在していない場合、アプリケーションが最初に書き込みを試行したときに自動的に作成されます。 ユーザーが削除した場合は、もう一度書き込まれたときに再作成されます。

メモ： 読み取り専用のアクセス許可があり、存在しない特別なフォルダーを要求すると、エラーが 403 Forbidden 表示されます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント)	Files.ReadWrite.AppFolder、Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
アプリケーション	Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All

HTTP 要求

GET /me/drive/special/{special-folder-name}

特殊フォルダー名

以下の特殊フォルダー名は、OneDrive および OneDrive for Business で使用できます。

名前	フォルダー ID	説明
App Root	approot	そのアプリケーションの個人用フォルダー。 通常は /Apps/{Application Name} 内
Camera Roll	cameraroll	カメラ ロールのバックアップ フォルダー。
デスクトップ	desktop	デスクトップ フォルダー。
Documents	documents	ドキュメント フォルダー。
Music	music	ミュージック フォルダー。
Photos	photos	フォト フォルダー。

オプションのクエリ パラメーター

このメソッドは、 $expand および $selectOData クエリ パラメーター をサポートして応答をカスタマイズします。

HTTP 応答

このメソッドは 200 OK 応答コードと、応答本文で driveItem オブジェクトを返します。

driveItem のプロパティまたはリレーションシップの追加の呼び出しと合わせて、特殊フォルダーのアドレス指定のメソッドを使用できます。

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "0123456789abc",
  "name": "Documents",
  "eTag": "012345819293.1",
  "specialFolder": {
    "name": "documents"
  }
}

特殊フォルダーの子を取得する

特殊フォルダーの子を要求する場合は、children コレクションを要求するか、子コレクションを展開する expand オプションを使用します。

HTTP 要求

GET /me/drive/special/{special-folder-name}/children

HTTP 応答

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {"name": "myfile.jpg", "size": 2048 },
    {"name": "Documents", "folder": { "childCount": 4} },
    {"name": "Photos", "folder": { "childCount": 203} },
    {"name": "my sheet(1).xlsx", "size": 197 }
  ]
}

解説

注:specialFolder ファセットを伴う DriveItem は、アイテムが特殊フォルダーであり、special コレクション経由でアクセスできることを示しています。

アプリに読み取り専用アクセス許可が付与されている場合、特殊フォルダーまたは特殊フォルダーの子を取得する要求は、その特殊フォルダーが存在していないと、404 Not Found エラーまたは 403 Forbidden エラーで失敗します。