driveItem リソース型driveItem resource type

driveItem リソースは、ドライブに格納されているファイル、フォルダーなどのアイテムを表します。OneDrive および SharePoint 内のすべてのファイル システム オブジェクトが、driveItem リソースとして返されます。The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in OneDrive and SharePoint are returned as driveItem resources.

driveItem リソースのアドレス指定には、主に 2 つの方法があります。There are two primary ways of addressing a driveItem resource:

  • drive/items/{item-id} を使用した、driveItem 一意識別子による方法By the driveItem unique identifier using drive/items/{item-id}
  • /drive/root:/path/to/file を使用した、ファイル システム パスによる方法By file system path using /drive/root:/path/to/file

DriveItem リソースには、driveItem の ID および機能に関するデータを提供するプロパティとしてモデル化されたファセットがあります。DriveItem resources have facets modeled as properties that provide data about the driveItem's identities and capabilities. 次に例を示します。For example:

フォルダー ファセットを持つアイテムは、アイテムのコンテナーとして機能するため、フォルダーに含まれる driveItems のコレクションを指す children 参照を持ちます。Items with the folder facet act as containers of items and therefore have a children reference pointing to a collection of driveItems under the folder.

注: OneDrive for Business または SharePoint のドキュメント ライブラリでは、driveItem に[フォルダー][] ファセットがある場合、cTag プロパティは返されません。In OneDrive for Business or SharePoint document libraries, the cTag property is not returned, if the driveItem has a folder facet.

プロパティProperties

プロパティProperty Type 説明Description
audioaudio audioaudio オーディオのメタデータ (アイテムがオーディオ ファイルである場合)。読み取り専用です。Audio metadata, if the item is an audio file. Read-only.
contentcontent StreamStream コンテンツのストリーム (アイテムがファイルを表す場合)。The content stream, if the item represents a file.
createdBycreatedBy identitySetidentitySet そのアイテムを作成したユーザーの ID、デバイス、アプリケーション。読み取り専用です。Identity of the user, device, and application which created the item. Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset アイテム作成の日時。読み取り専用です。Date and time of item creation. Read-only.
cTagcTag StringString アイテムのコンテンツの eTag。メタデータのみが変更された場合、この eTag は変更されません。注: アイテムがフォルダーである場合、このプロパティは返されません。読み取り専用です。An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.
deleteddeleted deleteddeleted アイテムの削除状態に関する情報。読み取り専用です。Information about the deleted state of the item. Read-only.
descriptiondescription StringString ユーザーに表示されるアイテムの説明を提供します。読み取り/書き込み。OneDrive 個人用においてのみProvides a user-visible description of the item. Read-write. Only on OneDrive Personal
eTageTag StringString アイテム全体 (メタデータおよびコンテンツ) の eTag。読み取り専用です。eTag for the entire item (metadata + content). Read-only.
filefile filefile ファイルのメタデータ (アイテムがファイルである場合)。読み取り専用です。File metadata, if the item is a file. Read-only.
fileSystemInfofileSystemInfo fileSystemInfofileSystemInfo クライアント上のファイル システム情報。読み取り/書き込み。File system information on client. Read-write.
folderfolder [フォルダー][]folder フォルダーのメタデータ (アイテムがフォルダーである場合)。読み取り専用です。Folder metadata, if the item is a folder. Read-only.
idid StringString ドライブ内のアイテムの一意識別子。読み取り専用です。The unique identifier of the item within the Drive. Read-only.
imageimage imageimage 画像のメタデータ (アイテムが画像である場合)。読み取り専用です。Image metadata, if the item is an image. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet アイテムを最終更新したユーザーの ID、デバイス、アプリケーション。読み取り専用です。Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset アイテムが最後に変更された日時。読み取り専用です。Date and time the item was last modified. Read-only.
locationlocation geoCoordinatesgeoCoordinates 場所のメタデータ (アイテムに場所データが含まれている場合)。読み取り専用です。Location metadata, if the item has location data. Read-only.
namename StringString アイテムの名前 (ファイル名と拡張子)。読み取り/書き込み。The name of the item (filename and extension). Read-write.
packagepackage packagepackage これがある場合、アイテムはフォルダーやファイルではなく、パッケージです。パッケージは、コンテキスト次第で、ファイルとして、あるいはフォルダーとして扱われます。読み取り専用です。If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only.
parentReferenceparentReference itemReferenceitemReference 親の情報 (アイテムに親がある場合)。読み取り/書き込み。Parent information, if the item has a parent. Read-write.
写真photo photophoto 写真のメタデータ (アイテムが写真である場合)。読み取り専用です。Photo metadata, if the item is a photo. Read-only.
publicationpublication publicationFacetpublicationFacet アイテムが公開されているか、チェックアウトの状態かどうかの情報を、そのような操作をサポートする場所で提供します。Provides information about the published or checked-out state of an item, in locations that support such actions. 既定では、このプロパティは返されません。This property is not returned by default. 読み取り専用です。Read-only.
remoteItemremoteItem remoteItemremoteItem リモート アイテムのデータ (現在アクセス中のドライブ以外のドライブから共有されているアイテムの場合)。読み取り専用です。Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.
rootroot rootroot このプロパティが null ではない場合は、driveItem がドライブで最上位の driveItem であることを示します。If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.
searchResultsearchResult searchResultsearchResult 検索のメタデータ (検索結果に由来するアイテムの場合)。読み取り専用です。Search metadata, if the item is from a search result. Read-only.
共有shared sharedshared アイテムが他のユーザーと共有されていることを示し、アイテムの共有状態に関する情報を提供します。読み取り専用です。Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.
sharepointIdssharepointIds sharepointIdssharepointIds SharePoint REST 互換性に役立つ識別子を返します。読み取り専用です。Returns identifiers useful for SharePoint REST compatibility. Read-only.
sizesize Int64Int64 アイテムのサイズ (バイト単位)。読み取り専用です。Size of the item in bytes. Read-only.
specialFolderspecialFolder specialFolderspecialFolder 現在のアイテムが特別なフォルダーとしても使用可能な場合は、このファセットが返されます。読み取り専用です。If the current item is also available as a special folder, this facet is returned. Read-only.
videovideo videovideo ビデオのメタデータ (アイテムがビデオである場合)。読み取り専用です。Video metadata, if the item is a video. Read-only.
webDavUrlwebDavUrl StringString アイテムの WebDAV 互換性のある URL。WebDAV compatible URL for the item.
webUrlwebUrl StringString ブラウザーでリソースを表示するための URL。読み取り専用です。URL that displays the resource in the browser. Read-only.

注: eTag プロパティと cTag プロパティは、コンテナー (フォルダー) 上での機能が異なります。cTag 値は、フォルダーのいずれかの子孫のコンテンツまたはメタデータが変更されると変更されます。eTag 値は、子孫から派生したプロパティ (childCountlastModifiedDateTime など) 以外のフォルダーのプロパティが変更されたときにのみ、変更されます。Note: The eTag and cTag properties work differently on containers (folders). The cTag value is modified when content or metadata of any descendant of the folder is changed. The eTag value is only modified when the folder's properties are changed, except for properties that are derived from descendants (like childCount or lastModifiedDateTime).

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
アクティビティactivities itemActivity コレクションitemActivity collection このアイテムに対して行われた最近のアクティビティのリストです。The list of recent activities that took place on this item.
分析analytics itemAnalytics リソースitemAnalytics resource このアイテムについて行われたビュー アクティビティに関する分析。Analytics about the view activities that took place in this site.
childrenchildren driveItem コレクションdriveItem collection アイテムの直接の子のアイテム オブジェクトを格納するコレクション。子が含まれるのは、フォルダーを表すアイテムのみです。読み取り専用です。Null 許容型。Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
createdByUsercreatedByUser useruser アイテムを作成したユーザーの ID です。Identity of the user who created the item. 読み取り専用です。Read-only.
lastModifiedByUserlastModifiedByUser useruser アイテムを最後に変更したユーザーの ID です。Identity of the user who last modified the item. 読み取り専用です。Read-only.
listItemlistItem listItemlistItem SharePoint のドライブの場合は、関連付けられているドキュメント ライブラリのリスト アイテム。For drives in SharePoint, the associated document library list item. 読み取り専用です。Read-only. Null 許容型。Nullable.
アクセス許可permissions permission コレクションpermission collection アイテムのアクセス許可のセット。読み取り専用です。Null 許容型。The set of permissions for the item. Read-only. Nullable.
subscriptionssubscriptions subscription コレクションsubscription collection アイテムのサブスクリプションのセット。The set of subscriptions on the item. ドライブのルートでのみサポートされています。Only supported on the root of a drive.
thumbnailsthumbnails thumbnailSet コレクションthumbnailSet collection アイテムに関連付けられた ThumbnailSet オブジェクトを格納するコレクション。詳細については、サムネイルの取得についてのページをご覧ください。読み取り専用です。Null 許容型。Collection containing ThumbnailSet objects associated with the item. For more info, see getting thumbnails. Read-only. Nullable.
versionsversions driveItemVersion コレクションdriveItemVersion collection アイテムの以前のバージョンのリスト。The list of previous versions of the item. 詳細については、「[バージョンの一覧表示][]」を参照してください。For more info, see getting previous versions. 読み取り専用です。Read-only. Null 許容型。Nullable.
workbookworkbook workbookworkbook Excel スプレッドシートであるファイルの場合、スプレッドシートのコンテンツを操作するためにブックの API にアクセスします。For files that are Excel spreadsheets, accesses the workbook API to work with the spreadsheet's contents. Null 許容型。Nullable.

インスタンスの属性Instance Attributes

インスタンスの属性は、動作が特殊なプロパティです。これらのプロパティは一時的なものであり、a) サービスの動作を定義するか、b) 短期的なプロパティの値 (有効期限を持つアイテムのダウンロード URL など) を提供します。Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.

プロパティ名Property name 種類Type 説明Description
@microsoft.graph.conflictBehavior@microsoft.graph.conflictBehavior stringstring 新しいアイテムを作成するアクションの競合を解決する動作。failreplacerename という値を使用できます。PUT の既定値は replace です。この注釈とともにアイテムが返されることはありません。書き込み専用です。The conflict resolution behavior for actions that create a new item. You can use the values fail, replace, or rename. The default for PUT is replace. An item will never be returned with this annotation. Write-only.
@microsoft.graph.downloadUrl@microsoft.graph.downloadUrl stringstring このファイルのコンテンツをダウンロードするために使用できる URL。この URL では認証は必要ありません。読み取り専用です。A URL that can be used to download this file's content. Authentication is not required with this URL. Read-only.
@microsoft.graph.sourceUrl@microsoft.graph.sourceUrl stringstring PUT 要求を発行するときにこのインスタンスの注釈を使用すると、サービスに対し、URL のコンテンツをダウンロードし、それをファイルとして保存するように指示できます。書き込み専用です。When issuing a PUT request, this instance annotation can be used to instruct the service to download the contents of the URL, and store it as the file. Write-only.

注:@microsoft.graph.downloadUrl の値は短時間限定の URL であるため、キャッシュすることはできません。Note: The @microsoft.graph.downloadUrl value is a short-lived URL and can't be cached. URL は短い期間 (1 時間) だけ使用でき、その後は無効になります。The URL will only be available for a short period of time (1 hour) before it is invalidated. ユーザーのファイルへのアクセス許可を削除しても、すぐに URL が無効にならない場合があります。Removing file permissions for a user may not immediately invalidate the URL.

JSON 表記JSON representation

以下は、driveItem リソースの JSON 表記です。Here is a JSON representation of a driveItem resource.

driveItem リソースは baseItem から派生し、そのリソースからプロパティを継承します。The driveItem resource is derived from baseItem and inherits properties from that resource.

{
  "audio": { "@odata.type": "microsoft.graph.audio" },
  "content": { "@odata.type": "Edm.Stream" },
  "cTag": "string (etag)",
  "deleted": { "@odata.type": "microsoft.graph.deleted"},
  "description": "string",
  "file": { "@odata.type": "microsoft.graph.file" },
  "fileSystemInfo": { "@odata.type": "microsoft.graph.fileSystemInfo" },
  "folder": { "@odata.type": "microsoft.graph.folder" },
  "image": { "@odata.type": "microsoft.graph.image" },
  "location": { "@odata.type": "microsoft.graph.geoCoordinates" },
  "package": { "@odata.type": "microsoft.graph.package" },
  "photo": { "@odata.type": "microsoft.graph.photo" },
  "publication": {"@odata.type": "microsoft.graph.publicationFacet"},
  "remoteItem": { "@odata.type": "microsoft.graph.remoteItem" },
  "root": { "@odata.type": "microsoft.graph.root" },
  "searchResult": { "@odata.type": "microsoft.graph.searchResult" },
  "shared": { "@odata.type": "microsoft.graph.shared" },
  "sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
  "size": 1024,
  "specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
  "video": { "@odata.type": "microsoft.graph.video" },
  "webDavUrl": "string",

  /* relationships */
  "activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
  "analytics": {"@odata.type": "microsoft.graph.itemAnalytics"},
  "children": [{ "@odata.type": "microsoft.graph.driveItem" }],
  "createdByUser": { "@odata.type": "microsoft.graph.user" },
  "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
  "permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
  "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],
  "thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
  "versions": [ {"@odata.type": "microsoft.graph.driveItemVersion"}],

  /* inherited from baseItem */
  "id": "string (identifier)",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "eTag": "string",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "name": "string",
  "parentReference": {"@odata.type": "microsoft.graph.itemReference"},
  "webUrl": "string",

  /* instance annotations */
  "@microsoft.graph.conflictBehavior": "string",
  "@microsoft.graph.downloadUrl": "url",
  "@microsoft.graph.sourceUrl": "url"
}

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
アイテムを取得するGet item driveItemdriveItem ドライブ 内の DriveItem 用のメタデータを取得します。Retrieve the metadata for a DriveItem in a Drive by file system path or ID.
分析を取得するGet analytics itemAnalyticsitemAnalytics このリソースの分析を取得します。Get analytics for this resource.
間隔によりアクティビティを取得するGet activities by interval itemActivityStatitemActivityStat 指定した時間間隔内に itemActivityStats のコレクションを取得します。Get a collection of itemActivityStats within the specified time interval.
子を一覧表示するList children DriveItem のコレクションcollection of driveItem DriveItem の子リレーションシップで DriveItems のコレクションを返します。Return a collection of DriveItems in the children relationship of a DriveItem.
バージョンを一覧表示するList versions DriveItemVersion のコレクションcollection of DriveItemVersion 現在のユーザーのドライブ内のファイルのバージョンを取得します。This example retrieves the versions of a file in the current user's drive.
アイテムを作成するCreate item driveItemdriveItem 指定したドライブで driveItem を作成します。Creates a driveItem in the specified drive.
アイテムを更新するUpdate item driveItemdriveItem ドライブで driveItem を更新します。Updates a driveItem in the drive.
コンテンツをアップロードするUpload content driveItemdriveItem コンテンツを driveItem にアップロードします。Uploads content to the driveItem.
コンテンツをダウンロードするDownload content ダウンロード URLdownload Url DriveItem のコンテンツをダウンロードします。Downloads content of a driveItem.
特定のファイル形式をダウンロードするDownload specific file format ダウンロード URLdownload Url DriveItem のコンテンツを特定の形式でダウンロードします。Downloads content of a driveItem with a specific format.
アイテムを削除するDelete item コンテンツはありませんNo Content DriveItem を削除します。Deletes a driveItem.
アイテムを移動するMove item driveItemdriveItem DriveItem を新しい親アイテムに移動します。Move a DriveItem to a new folder
アイテムをコピーするCopy item コピーの進行状況を監視する方法についての詳細Returns details about how to monitor the progress of the copy, upon accepting the request. DriveItem (すべての子を含む) のコピーを作成します。Creates a copy of an driveItem (including any children).
アイテムを検索するSearch items DriveItem のコレクションcollection of driveItem クエリと一致するアイテムを対象にアイテムの階層を検索します。Search the hierarchy of items for items matching a query.
ドライブ内の変更内容を一覧表示するList changes in a drive 差分リンクdelta link ドライブでのすべての変更を一覧表示します。List any changes in the drive.
サムネイルを一覧表示するList thumbnails DriveItem のコレクションcolletion of driveItem DriveItems とそれらのサムネイルを一覧表示します。List driveItems with their thumbnails.
共有リンクを作成するCreate sharing link 共有リンクCreate sharing link DriveItem を共有するためのリンクを作成します。Create a link to share the driveItem.
アクセス許可を追加するAdd permissions [アクセス許可][]のコレクションcollection of permission 共有の招待をユーザーに送信します。Sends a sharing ivite to a user.
アクセス許可を一覧表示するList permissions [アクセス許可][]のコレクションcollection of permission DriveItem に対するアクセス許可のコレクションを取得します。Retrieves the collection of permissions on an driveItem.
アクセス許可を削除するDelete permission コンテンツはありませんNo Content DriveItem からアクセス許可を削除します。Removes the permission level from the user.
WebSocket チャネルを取得するGet WebSocket channel subscriptionsubscription Socket.io を使用して、ドライブのリアルタイムに近い変更通知を受信します。Receives near-real-time change notifications for a drive using socket.io.
アイテムをプレビューするPreview item JSON オブジェクトjson object 一時的なプレビューを表示するために、アイテムの、有効期限が短い埋め込み可能な URL を取得します。Obtain short-lived embeddable URLs for an item in order to render a temporary preview.