共有ドライブに対してGoogle Drive APIを実行する際のオプション指定について

この記事について

共有ドライブを操作する場合はsupportsAllDrivesというオプションを有効化したりしなかったりする必要があるようなんですが、それに関する情報がなかなか見つからなかったので自分でまとめてみます。
GoogleDriveAPIを有効化するところから書き始めるので、オプションの話だけ読みたい方はこちらまで飛ばしてください。

使用言語はPHPですが、他の言語でも必要なオプション自体は変わらないので、応用は効くと思います。

僕は最初このことを知らず、「設定は大丈夫そうなのに何故ファイルの作成も取得もできないんだ？？？」と小一時間悩むことになったので、そういう人が1人でも減れば嬉しいです…

対象者

• Google Drive APIをこれから初めて使う方
• Google Drive APIでファイルをアップロードしたり、アップロードしたファイルにアクセスできなくて困ってる方
• PHP版のライブラリを使っている方（他の言語でも応用はできそう）

動作環境・前提

	バージョン
Mac	14.7.2
チップ	Apple M2
PHP	8.3.6

Google Drive APIの有効化と、サービスアカウントの作成

ここでは、Google Cloud コンソール上で行う作業の手順をまとめます。
まだGoogle Cloudのプロジェクトが作成できていない方は、新しいプロジェクトを作成してから以下の手順に移ってください。

Google Cloudコンソールはこちらから開けます

①Google Drive APIを有効化する

1. ナビゲーションメニューの「APIとサービス」をホバーし、右に出てきたメニューの「ライブラリ」をクリック
2. 「API ライブラリへようこそ」という画面が表示されたら、検索ボックスでGoogle Drive APIを検索する
3. 検索結果の中から「Google Drive API」をクリックし、開いたページ内で「有効にする」ボタンを押下する
   
4. 「APIが有効です」と表示されたらOK
   

②サービスアカウントの作成

1. ナビゲーションメニューの「APIとサービス」をホバーし、右に出てきたメニューの「認証情報」をクリック
2. 認証情報の画面が開いたら、「認証情報を作成」ボタンを押下し、出てきたメニューから「サービスアカウント」を選択
   
3. 「①サービスアカウントの詳細」を入力して、「続行」を押下
4. 「②このサービス アカウントにプロジェクトへのアクセスを許可する」で、「ストレージフォルダ編集者」ロールを付与する（無ければ「ストレージフォルダ管理者」も可）
5. 付与できたら「続行」を押下。付与し忘れても、以下の手順９でロール付与できるので大丈夫です
6. 「③ユーザーにこのサービス アカウントへのアクセスを許可」は何も編集しないで、「完了」を押下
7. サービスアカウントが作成できたら、ナビゲーションメニューの「IAMと管理」をホバーし、「IAM」を押下
8. 作成したサービスアカウントに、「ストレージフォルダ編集者（or管理者）」のロールが付与できていることを確認する
9. もし付与できていなかったら、右にある鉛筆ボタンを押下し、ロールを付与する。付与されていることが確認できたらOK

③認証情報の取得

1. ナビゲーションメニューの「APIとサービス」をホバーし、右に出てきたメニューの「認証情報」をクリック
2. 2. サービスアカウントの作成で作成したサービスアカウントをクリックし、開いたページで「鍵」をクリック
3. 開いたタブ内で「キーを追加」ボタンを押下し、JSON形式で鍵を作成する
   
4. JSONファイルがダウンロードできたらOK

Google Driveにフォルダを用意する

ここでは、これからAPIで操作する対象となるGoogleDriveフォルダを作成していきます。
既に使用するフォルダを作成済みの場合は、以下の手順２まで飛ばしてください。

1. 共有ドライブ内に、新しいフォルダを作成する
2. 作成したフォルダを右クリックし、「共有」をホバーし、出てきたメニューから「共有」クリックする
3. 「（フォルダ名）を共有」のモーダルが表示されたら、前節の2. サービスアカウントの作成で作成したサービスアカウントのメールアドレスをコピペし、「完了」を押下

プロジェクトでコードを実装する

ここでは、いよいよコードの実装を行います。

だいたい以下のディレクトリ構成になっているイメージで話を進めます。

.
├── .env
├── composer.json
├── credentials/
└── app/

※ あくまでサンプルなので、環境変数とか認証情報の置き場所とかはテキトーです

①環境変数を設定する

1. 前々節の③認証情報の取得で作成したJSON形式の認証ファイルを用意する
2. 認証ファイルをcredentials配下に置く
3. .envに以下の形式で、手順2で配置した認証ファイルのプロジェクトrootからのpathを追記する

# 例
GOOGLE_APPLICATION_CREDENTIALS="/credentials/認証情報ファイル名"

②ライブラリをインストールする

1. ターミナルでcomposer require google/apiclientを実行する

google/apiclientとは

PHP用のGoogleAPIクライアントライブラリです。
https://github.com/googleapis/google-api-php-client

③APIを実行するサービスを作成する

1. 以下のようなサービスクラスを作成する

<?php

declare(strict_types=1);

namespace src\googleDriveApi;

use Google\Client;
use Google\Service\Drive;

class GoogleDriveFolderService
{
    private Client $client;
    private Drive $drive;

    public function __construct()
    {
        $this->client = new Client();

        $this->client->useApplicationDefaultCredentials();  // これを書くと、.envのGOOGLE_APPLICATION_CREDENTIALSを勝手に読み込んでくれる
        $this->client->setScopes([Drive::DRIVE]);   // scopeをGoogleDriveにする

        $this->drive = new Drive($this->client);
    }
}

2. このクラスの中で、Google Drive APIを実行するコードを書いていく↓

ファイル・フォルダを作成する

public function createFile($content): void 
{
    $postBody = new DriveFile([
        'name' => 'テストファイル',
        'parents' => ['00000000000000000000000000000'], // 親フォルダのID（任意）
    ]);

    $optParams = [
        'data' => $content, // アップロードするコンテンツ（フォルダ作成の場合は不要）
        'mimeType' => 'application/pdf',
        'supportsAllDrives' => true,
    ];

    $this->drive->files->create(
        $postBody,
        $optParams
    );
}

親フォルダのIDを指定すると、その配下に新しいフォルダを作成してくれます。
IDは、親フォルダを開いたときのURLの以下の部分を見るとわかります。

また、ファイル・フォルダの作成時は、supportsAllDrivesを有効（=True）にする必要があります！
これがないと、File not foundのエラーになってしまいます。

ファイルIDからファイル・フォルダを取得する

public function getDriveFileById(string $fileId): DriveFile
{
    $optParams = [
        'supportsAllDrives' => true,
    ];
    return $this->drive->files->get(
        $fileId,    // ファイルID
        $optParams,
    );
}

ファイルIDからファイル・フォルダを取得する（getメソッドを使う）場合も、supportsAllDrivesを有効（=True）にする必要があります！

最後に

今回は、共有ドライブでGoogle Drive APIを実行する際の手順をまとめました。
Cloudコンソールであれこれやったりライブラリを使う際に必須のオプションがあったりしてちょっと面倒ですが、慣れたら流れ作業でできそうです。

また、今回はサービスアカウントに「ストレージフォルダ編集者or管理者」ロールを付与して試しましたが、実際はもっと小さいロールでも実行できるのかもしれないなと思っています。
このあたりは、また別の機会に調べてみたいですね。

あと、そもそも「ストレージフォルダ」ってCloudStorageのことでは？なんでこれでGoogleDriveAPIが叩けるんだ？という疑問もあるので、そこも解消したいです。

GoogleCloud詳しい方、ぜひコメントで教えてください！

参考にさせていただいた記事

https://zenn.dev/nyazuki/articles/181c1d6269a7d1