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

[アーティクル]
10/30/2023

名前空間: microsoft.graph

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

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

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

この 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 クエリパラメーターをサポートします。

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。

応答

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

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

例

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

要求

GET /me/drive/special/{name}


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Special["{driveItem-id}"].GetAsync();



mgc drives special get --drive-id {drive-id} --drive-item-id {driveItem-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
special, err := graphClient.Drives().ByDriveId("drive-id").Special().ByDriveItemId("driveItem-id").Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DriveItem result = graphClient.drives().byDriveId("{drive-id}").special().byDriveItemId("{driveItem-id}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

let driveItem = await client.api('/me/drive/special/{name}')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->drives()->byDriveId('drive-id')->special()->byDriveItemId('driveItem-id')->get()->wait();


Import-Module Microsoft.Graph.Files

Get-MgDriveSpecial -DriveId $driveId -DriveItemId $driveItemId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.drives.by_drive_id('drive-id').special.by_drive_item_id('driveItem-id').get()

応答

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/{special-folder-name}/children

Snippet not available

Snippet not available

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

let children = await client.api('/me/drive/special/{special-folder-name}/children')
	.get();

Snippet not available

Snippet not available

Snippet not available

応答

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 }
  ]
}

備考

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

次の方法で共有

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

アクセス許可

HTTP 要求

特殊フォルダー名

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

要求ヘッダー

応答

例

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

要求

応答

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

要求

応答

備考

フィードバック

その他のリソース

次の方法で共有

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

アクセス許可

HTTP 要求

特殊フォルダー名

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

要求ヘッダー

応答

例

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

要求

応答

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

要求

応答

備考

フィードバック

その他のリソース

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