共有ドライブは、マイドライブとは異なる組織、共有、所有権のモデルに従います。アプリで共有ドライブにファイルを作成して管理する場合は、共有ドライブのサポートをアプリに実装する必要があります。実装の複雑さはアプリの機能によって異なります。
まず、アプリで以下の操作を行うときに、supportsAllDrives=true
クエリ パラメータをリクエストに含める必要があります。
Drive API バージョン 3
files.get
files.list
files.create
files.update
files.copy
files.delete
changes.list
changes.getStartPageToken
permissions.list
permissions.get
permissions.create
permissions.update
permissions.delete
Drive API バージョン 2
files.get
files.list
files.insert
files.update
files.patch
files.copy
files.trash
files.untrash
files.delete
files.touch
children.insert
parents.insert
changes.list
changes.getStartPageToken
changes.get
permissions.list
permissions.get
permissions.insert
permissions.update
permissions.patch
permissions.delete
supportsAllDrives=true
パラメータは、アプリケーションが共有ドライブ上のファイルを処理するように設計されていることを Google ドライブに通知します。
権限の読み取りや変更、変更の追跡、複数のコーパスの検索を行うアプリケーションでは、追加の共有ドライブ機能が必要になります。このドキュメントの残りの部分では、これらのタスクを実行するために必要な追加の変更について説明します。
共有ドライブのコンテンツを検索する
files.list
メソッドを使用して、共有ドライブを検索します。このセクションでは、files.list
メソッド内の共有ドライブ固有のフィールドについて説明します。共有ドライブを検索するには、ファイルとフォルダを検索するをご覧ください。
files.list
メソッドには、次の共有ドライブ固有のフィールドとクエリモードが含まれています。
driveId
- 検索する共有ドライブの ID。includeItemsFromAllDrives
- 共有ドライブのアイテムを結果に含めるかどうか。存在しないか false に設定されている場合、共有ドライブ アイテムは返されません。corpora
- クエリが適用されるアイテム(ファイル/ドキュメント)の本文。サポートされている本文はuser
、domain
、drive
、allDrives
です。効率を高めるために、allDrives
よりもuser
またはdrive
を優先します。supportsAllDrives
- リクエスト元のアプリがマイドライブと共有ドライブの両方をサポートしているかどうか。false の場合、共有ドライブのアイテムはレスポンスに含まれません。
次のクエリモードは共有ドライブに固有のものです。
includeItemsFromAllDrives |
corpora |
クエリの説明 |
---|---|---|
true |
user |
ユーザーがアクセスしたファイル(共有ドライブとマイドライブの両方を含む)をクエリします。 |
true |
drive |
指定した共有ドライブ内のすべてのアイテムを検索します。リクエストには driveId を指定する必要があります。 |
true |
allDrives |
ユーザーがアクセスしたファイルと、ユーザーがメンバーになっているすべての共有ドライブをクエリします。レスポンスに incompleteSearch : true が含まれている場合、このリクエストで一部のコーパスが検索されなかったことを示します。 |
true |
domain |
ドメインで共有されているファイル(共有ドライブとマイドライブの両方のファイルを含む)をクエリします。 |
共有ドライブの変更履歴を確認する
共有ドライブの変更を追跡するには、changes.list
メソッドを使用します。このセクションでは、changes.list
メソッド内の共有ドライブ固有のフィールドについて説明します。詳しくは、ユーザーと共有ドライブの変更を追跡するをご覧ください。changes.list
メソッドには、次の共有ドライブ固有のフィールドとクエリモードが含まれています。
driveId
- 変更が返される共有ドライブ。指定した変更 ID は、ユーザーに表示されるファイルの変更ではなく、共有ドライブ内の変更を指します。特定の共有ドライブの変更を参照するには、共有ドライブ ID と変更 ID の両方を識別子として使用する必要があります。supportsAllDrives
- リクエスト元のアプリが共有ドライブをサポートしているかどうか。false の場合、共有ドライブのアイテム(共有ドライブ内のアイテムと共有ドライブ内のファイルを含む)は返されません。includeItemsFromAllDrives
- 共有ドライブのファイルや変更をリストに含めるかどうか。
次のクエリモードは共有ドライブに固有のものです。
includeItemsFromAllDrives |
driveId |
クエリの説明 |
---|---|---|
true |
× | 変更内容は、ユーザーがアクセスした共有ドライブ内外のファイルの変更と、ユーザーがメンバーである共有ドライブに対する変更に反映されます。 |
true |
○ | 変更は、指定した共有ドライブとその共有ドライブ内のアイテムに加えられた変更を反映します。 |
変更ログの動作の詳細については、変更ログをご覧ください。
ドライブの UI で共有ドライブのサポートを有効にする
ドライブの UI を使用して共有ドライブのコンテンツにアクセスするには、Google API Console で [共有ドライブのサポート] がオンになっていることを確認します。詳細については、ドライブ UI 統合を構成するをご覧ください。
共有ドライブでファイル選択ツールを使用する
ファイル選択ツールは、共有ドライブ内のアイテムの選択をサポートします。共有ドライブのサポートの有効化と、ファイル選択ツールでの共有ドライブ ビューの追加について詳しくは、Google Picker API をご覧ください。
次のステップ
共有ドライブの作成と共有ドライブの権限の管理については、共有ドライブの管理に進んでください。