Drive API

Drive API を利用して、マイドライブ、共有ドライブ、組織/グループフォルダを管理できます。

file または file.read scope では、すべての Drive API を使用できます。group.folder または group.folder.read scope では、組織/グループフォルダに関する Drive API のみを使用できます。

Drive API は、User Account 認証で取得した Access Token で利用できます。Service Account 認証 (JWT) で取得した Token では利用できません。
利用しているプランとオプションにより、利用できる API に違いがあります。

Drive API を利用する {#user-drive-api}

マイドライブ、共有ドライブ、組織/グループフォルダそれぞれに対して異なる API が用意されていますが、使い方はよく似ています。
マイドライブには権限を管理する API は提供されていない、ドライブを作成・削除する API は共有ドライブにのみ提供されているなど、ドライブのタイプにより利用できる API に若干の違いがあります。

いずれのドライブのタイプでも、ファイルのアップロード、ファイル一覧の取得、フォルダの作成には、ルートフォルダとそれ以外のフォルダで異なる API が用意されています。

ドライブ内のフォルダ・ファイルにアクセスする場合には、まずルートフォルダ内のファイルリストを取得し、つぎに取得されたリスト内のフォルダを対象にフォルダ内のリストを取得し、と、フォルダ階層に沿って API を呼び出してアクセスします。
共有ドライブ ID sharedriveId やファイル ID fileId など、アクセスに必要なパラメータが既にわかっている場合には、目的の情報に直接アクセスすることもできます。

ドライブを管理する {#manage-drive}

マイドライブを管理する {#manage-mydrive}

マイドライブの利用には特別な準備は必要ありません。
アドバンストプラン、または、スタンダードプランと Drive オプションをご利用のお客様は、マイドライブを利用できます。マイドライブが利用できるプランまたはオプションを利用しているのにマイドライブが利用できない場合には、マイドライブの利用が許可されて居ない可能性がありますので、管理者画面より、マイドライブの利用が許可されているか確認してください。
Drive API では、マイドライブの使用量を確認できます。
ユーザーのマイドライブは一つですので、マイドライブのリストを取得する API はありません。また、権限を管理する API もありません。

共有ドライブを管理する {#manage-sharedrive}

共有ドライブは、モバイルアプリ、ブラウザ、Drive エクスプローラーのほか、以下の API で管理できます。

組織/グループフォルダを管理する {#manage-groupfolder}

組織/グループフォルダは、組織 (orgUnit) とグループ (Group) の機能の一部です。このため、組織/グループフォルダの有効化・無効化は、組織またはグループを管理する API で useFolder プロパティを指定することで行います。

組織の操作には orgunit または directory scope が、グループの操作には group または directory scope が必要です。

組織/グループフォルダを有効化 (useFolder = true) した後、以下の API により組織/グループフォルダを作成することで、組織/グループフォルダを利用できます。

以下の API で、組織/グループフォルダの使用量を確認できます。

組織/グループフォルダのデータを削除するには、以下の API を利用します。

組織/グループフォルダには組織 ID orgUnitId またはグループ ID groupId を指定してアクセスするため、組織/グループフォルダを取得する API はありません。また、組織/グループのフォルダの権限は、組織やグループのメンバーシップで管理するため、組織/グループフォルダの権限を管理する API もありません。

共有したフォルダを管理する {#manage-sharefolder}

共有したフォルダは、モバイルアプリ、ブラウザ、Drive エクスプローラーのほか、以下の API で管理できます。

共有されたフォルダを管理する {#manage-sharedfolder}

共有されたフォルダは、モバイルアプリ、ブラウザ、Drive エクスプローラーのほか、以下の API で管理できます。

ドライブの権限を管理する {#manage-drive-permission}

共有ドライブでは、共有ドライブの権限を管理する APIが用意されています。

共有ドライブの権限を管理する {#manage-sharedrive-permission}

ルートフォルダを管理する {#manage-rootfolder}

ファイルのアップロード、ファイル一覧の取得、フォルダの作成には、ルートフォルダとそれ以外のフォルダでは異なる API が用意されています。ルートフォルダでは以下の API を利用します。

マイドライブのルートフォルダを管理する {#manage-mydrive-rootfolder}

共有ドライブのルートフォルダを管理する {#manage-sharedrive-rootfolder}

組織/グループフォルダのルートフォルダを管理する {#manage-groupfolder-rootfolder}

共有されたフォルダのルートフォルダを管理する {#manage-sharedfolder-rootfolder}

ファイル・フォルダを管理する {#manage-file-folder}

ファイルのアップロードとダウンロードは、ファイルアップロード / ダウンロード を参照します。
ファイルの編集を防ぐためのファイルのロックを設定・解除もできます。

マイドライブのファイル・フォルダを管理する {#manage-mydrive-file-folder}

共有ドライブのファイル・フォルダを管理する {#manage-sharedrive-file-folder}

組織/グループフォルダのファイル・フォルダを管理する {#manage-groupfolder-file-folder}

共有されたフォルダのファイル・フォルダを管理する {#manage-sharedfolder-file-folder}

フォルダの権限を管理する {#manage-folder-permission}

共有ドライブと組織/グループフォルダには、フォルダの権限を管理する API が用意されています。
既定では、フォルダは、上位フォルダの権限を引き継ぎます。フォルダアクセス権限有効化 を行うことで、上位フォルダとは異なる権限を設定できます。
アクセス権限は、フォルダアクセス権限の登録 API を利用して、ユーザー・組織・グループに対して与えることができます。指定できる権限は読み取り権限 READ または書き込み権限 WRITE です。

フォルダアクセス権限リストの取得 API で、フォルダにアクセス権があるユーザー・組織・グループと、その権限の一覧が取得できます。アクセス権があるユーザー・組織・グループと、その権限の組み合わせには、アクセス権限 ID permissionId が割り当てられています。
permissionId を指定して フォルダアクセス権限の削除 API を呼び出すことで、そのユーザー・組織・グループへの権限を削除できます。
また、permissionId を指定して フォルダアクセス権限の部分更新 API を呼び出すと、権限を変更できます。

上位フォルダの権限を引き継ぐには、フォルダへのアクセス権限無効化 API を利用します。
フォルダアクセス権限の全削除 API を呼び出した場合には、共有ドライブや組織/グループマスターのみがアクセスできるフォルダになります。

マイドライブの権限は API では管理できません。

共有ドライブでフォルダの権限を管理する {#manage-sharedrive-folder-permission}

組織/グループフォルダでフォルダの権限を管理する {#manage-groupfolder-folder-permission}

共有されたフォルダの権限を管理する {#manage-sharedfolder-folder-permission}

バージョンを管理する {#manage-version}

バージョン履歴を利用して、ファイルの修正や上書きの履歴を確認し、以前のファイルを復元したり、以前のファイルをダウンロードできます。

マイドライブでバージョンを管理する {#manage-mydrive-version}

共有ドライブでバージョンを管理する {#manage-sharedrive-version}

組織/グループフォルダでバージョンを管理する {#manage-groupfolder-version}

共有されたフォルダでバージョンを管理する {#manage-sharedfolder-version}

リンク共有を管理する {#manage-link}

リンク共有により、フィアルやフォルダをリンクで共有することができます。

マイドライブでリンク共有を管理する {#manage-link-drive}

共有ドライブでリンク共有を管理する {#manage-link-sharedrive}

組織/グループのフォルダでリンク共有を管理する {#manage-link-group}

共有されたフォルダでリンク共有を管理する {#manage-link-sharedfolder}

ゴミ箱を管理する {#manage-trashfile}

ユーザーがファイルを削除すると、ファイルはゴミ箱に移動され、管理者が指定した保管期間を経過した後にゴミ箱から削除されます。
ゴミ箱の中のファイルの復元や削除ができます。

マイドライブのゴミ箱を管理する {#manage-mydrive-trashfile}

共有ドライブのゴミ箱を管理する {#manage-sharedrive-trashfile}

組織/グループのフォルダのゴミ箱を管理する {#manage-groupfolder-trashfile}