共有ドライブをAPIで操作する〜入門編〜

以前、ドライブハックで共有ドライブの説明記事を公開しましたが、この記事についてはあくまで「共有ドライブとは何か?」を説明した座学的な記事でした。

今回はその続編として「共有ドライブを Google ドライブAPIで操作する方法」について解説します。少し技術的な内容になりますが、APIで何ができて何ができないのかを理解することは共有ドライブの仕様を理解するのに役立ちます。

是非最後まで記事を読んでみてください!

Google ドライブAPIの利用料金

Google ドライブAPIでは、利用量に対して課金が発生することはありません。ただし、APIの実行回数等に制限が存在しますので、その制限に対してプログラム上で対応を行う必要はあります。 Google ドライブAPIの制限についてはコチラの記事をご参考ください。

Google ドライブAPIのアクセス制御

Google ドライブ APIで共有ドライブ等のリソースにアクセスする場合、ユーザーから認可の移譲を受けるパターン(OAuth)と、権限移譲なしでリソースにアクセスするパターンが存在します。本記事では Google APIの認証については主題ではないため、説明を割愛します。Google APIの認証について詳しく知りたい方はこちらの記事をご参考ください。

共有ドライブに対してAPIで操作できること

共有ドライブに対して Google ドライブAPIで操作できる処理は以下の6つです。これらの処理は Google ドライブのUI上からも操作可能ですが、APIを利用することでシステム的に自動化することができます。ちなみに、以下表のAPIスコープはユーザー認可が必要になるAPI範囲を指します。

※各APIの詳細については次回記事で説明します。

できること HTTPリクエスト APIスコープ
共有ドライブを作成する POST https://www.googleapis.com/drive/v3/drives https://www.googleapis.com/auth/drive
共有ドライブを削除する DELETE https://www.googleapis.com/drive/v3/drives/driveId https://www.googleapis.com/auth/drive
共有ドライブのメタデータを取得する GET https://www.googleapis.com/drive/v3/drives/driveId https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.readonly
ユーザーの共有ドライブを一覧で取得する GET https://www.googleapis.com/drive/v3/drives https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.readonly
共有ドライブを更新する PATCH https://www.googleapis.com/drive/v3/drives/driveId https://www.googleapis.com/auth/drive
共有ドライブを非表示状態にする POST https://www.googleapis.com/drive/v3/drives/driveId/hide https://www.googleapis.com/auth/drive
共有ドライブを表示状態にする POST https://www.googleapis.com/drive/v3/drives/driveId/unhide https://www.googleapis.com/auth/drive

useDomainAdminAccessパラメータとは?

上記6つのAPIのうち、GET/PATCHに該当するAPIにはuseDomainAdminAccessというリクエストパラメータがサポートされています。Google翻訳で直訳すると、以下のような説明になります。

「ドメイン管理者としてリクエストを発行します。trueに設定すると、ファイルIDパラメーターが共有ドライブを参照し、リクエスターが共有ドライブが属するドメインの管理者である場合、リクエスターにアクセスが許可されます。(デフォルト:false)」

要は、API実行者が Google Workspace 管理者である場合、useDomainAdminAccessパラメーターを利用(useDomainAdminAccess=true)すると、共有ドライブに対する権限がなくても、ドメインに属する共有ドライブ全てにアクセスすることができるという意味のようです。

まとめ

  • 共有ドライブに対して Google ドライブAPIで操作できる処理は6種類
  • Google Workspace の管理者権限でuseDomainAdminAccessパラメータを利用すると、ドメインに属する全ての共有ドライブに接続可能

あなたへのオススメ記事...

コメントする

Your email address will not be published. Required fields are marked *