共有ドライブのサポートを実装する

共有ドライブは、マイドライブとは異なる組織、共有、所有権のモデルに従います。アプリで共有ドライブ上のファイルを作成、管理する場合は、アプリに共有ドライブのサポートを実装する必要があります。実装の複雑さは、アプリの機能によって異なります。

まず、アプリが次のオペレーションを実行するときに、リクエストに supportsAllDrives=true クエリ パラメータを含める必要があります。

Drive API v3

  • 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 v2

  • 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 ドライブに通知します。

権限の読み取りや変更、変更の追跡、複数のコーパスの検索を行うアプリケーションには、共有ドライブの追加機能が必要です。このドキュメントの残りの部分では、これらのタスクを実行するために必要な追加の変更について説明します。

共有ドライブのコンテンツを検索する

list メソッドを files リソースで使用して、共有ドライブ内のユーザー ファイルを検索します。共有ドライブを検索するには、共有ドライブを検索するをご覧ください。

list メソッドには、共有ドライブ固有の次のクエリ パラメータが含まれています。

  • driveId: 検索する共有ドライブの ID。

  • corpora: クエリが適用されるアイテム（ファイルまたはドキュメント）の本文。 サポートされている本文は、user、domain、drive、allDrives です。効率を高めるには、allDrives ではなく user または drive を使用してください。デフォルトでは、corpora は user に設定されています。

  • includeItemsFromAllDrives: マイドライブと共有ドライブの両方のアイテムを結果に含めるかどうか。存在しない場合、または false に設定されている場合、共有ドライブのアイテムは返されません。

  • supportsAllDrives: リクエスト元のアプリケーションがマイドライブと共有ドライブの両方をサポートしているかどうか。false の場合、共有ドライブのアイテムはレスポンスに含まれません。

次のクエリモードは、共有ドライブに固有のものです。

includeItemsFromAllDrives corpora クエリの説明
true user ユーザーがアクセスしたファイル（共有ドライブとマイドライブの両方のファイル）をクエリします。
true domain ドメインと共有されているファイル（共有ドライブとマイドライブの両方のファイル）をクエリします。
true drive 指定した共有ドライブ内のすべてのアイテムをクエリします。リクエストで driveId を指定する必要があります。
true allDrives ユーザーがアクセスしたファイルと、ユーザーがメンバーになっているすべての共有ドライブをクエリします。レスポンスに incompleteSearch:true が含まれる場合があります。これは、このリクエストで一部のコーパスが検索されなかったことを示します。

共有ドライブの変更を追跡する

list メソッドを changes リソースで使用して、共有ドライブの変更を追跡します。詳細については、ユーザーと共有 ドライブの変更を追跡するをご覧ください。

list メソッドには、共有ドライブ固有の次のクエリ パラメータが含まれています。

  • driveId: 変更が返される共有ドライブ。指定した場合、変更 ID は、ファイルの現在の状態を提供する共有ドライブ内のアイテムの変更を参照します。特定の共有ドライブの変更を参照するには、共有ドライブ ID と変更 ID の両方を識別子として使用する必要があります。

  • includeItemsFromAllDrives: 共有ドライブのファイルまたは変更を変更リストに含めるかどうか。

  • supportsAllDrives: リクエスト元のアプリケーションが共有ドライブをサポートしているかどうか。false の場合、共有ドライブと共有ドライブ内のファイルの両方を含む共有ドライブのアイテムは返されません。

次のクエリモードは、共有ドライブに固有のものです。

includeItemsFromAllDrives driveId クエリの説明
true いいえ 変更は、ユーザーがアクセスした共有ドライブの内外のファイルに対する変更と、ユーザーがメンバーになっている共有ドライブに対する変更を反映しています。
true はい 変更は、指定された特定の共有ドライブと、その共有ドライブ内のアイテムに対する変更を反映しています。

変更ログの動作の詳細については、ユーザーと共有ドライブの変更を追跡する をご覧ください。

ドライブの UI で共有ドライブのサポートを有効にする

ドライブの UI を使用して共有ドライブのコンテンツにアクセスするには、 [**共有ドライブのサポート**] チェックボックスがオンになっていることを、[**ドライブの UI 統合**] タブの Google Drive API で [Google Cloud コンソール] を使用して確認してください。詳細については、ドライブの UI 統合を構成するをご覧ください。

Google Picker を共有ドライブで使用する

Google Picker では、共有 ドライブ内のアイテムを選択できます。共有ドライブのサポートを有効にして、ピッカーに共有ドライブの ビューを追加する方法について詳しくは、Google Picker APIをご覧ください。