次の方法で共有

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

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

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

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

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

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

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Files.Read Files.Read.All、Files.ReadWrite、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント) Files.ReadWrite.AppFolder Files.Read、Files.Read.All、Files.ReadWrite、Files.ReadWrite.All、Sites.Read.All
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

GET /me/drive/special/{name}

特殊フォルダー名

OneDrive と OneDrive for Business では、次の特殊なフォルダー名を使用できます。

名前 フォルダー ID 説明
Documents documents ドキュメント フォルダー。
Photos photos フォト フォルダー。
Camera Roll cameraroll カメラ ロールのバックアップ フォルダー。
App Root approot そのアプリケーションの個人用フォルダー。 通常、 /Apps/{Application Name}。
Music music ミュージック フォルダー。
録音 recordings Recordings フォルダー。 このオプションは、OneDrive for Business と SharePoint Online でのみ使用できます。

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

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

応答

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

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

例

例 1: 名前で特別なフォルダーを取得する

要求

GET /me/drive/special/{name}

応答

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

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

例 2: 特別なフォルダーの子を取得する

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

要求

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

応答

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 エラーで失敗します。