RubyとGoogleドライブの連携してみる

こんにちは。次世代システム研究室のB.Mです。

はじめに

チームドライブについて

• 個人の場合は「マイドライブ」という名前です。
• 企業で「G Suite」を使っていると「チームドライブ」という機能が使えるようになります。

• 同じ：同様にファイルのアップロードやスプレッドシートの作成、メンバーとのファイル共有などできることは一緒です。
• 違い：ファイルの所属が個人からチームに変わるので、マイドライブの場合はメンバーが退社したときにファイルを引き継ぐ必要がありましたが、チームドライブの場合はファイルを引き継ぐ必要はありません。

Google API Client ライブラリーを使用してファイルとフォルダーとの操作

設定

gem 'google-api-client', '~> 0.34'

認証

SERVICE_ACCOUNT_CREDENTIAL_FILE_PATH =  "サービスアカウントの認証用ファイル.json";
def initialize
  authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
    json_key_io: File.open(SERVICE_ACCOUNT_CREDENTIAL_FILE_PATH),
    scope: %w(
      https://www.googleapis.com/auth/drive
      https://www.googleapis.com/auth/drive.file
    )
  authorizer.fetch_access_token!
  @drive = Google::Apis::DriveV3::DriveService.new
  @drive.authorization = authorizer
end

•  サービスアカウントは簡単にいうと以下の二行からわかると思います。
  
  • サービスアカウントにはパスワードがなく、ブラウザやCookieを介してログインできません。
  • サービスアカウントは、Googleへの認証に使用されるプライベート/パブリックRSAキーペアに関連付けられています。
• Scopeと呼ばれる変数パラメーターは、アクセストークンが許可するリソースと操作のセットを制御します。 アクセストークンリクエスト中に、アプリケーションはスコープパラメータで1つ以上の値を送信します。
  
  • https://www.googleapis.com/auth/drive  Googleドライブファイルを表示、編集、作成、削除します。
  • https://www.googleapis.com/auth/drive.file アプリで開いた、または作成したGoogleドライブのファイルとフォルダーの表示と管理。

ファイルとの操作

アップロード

def upload(file_path)
  file_object = {
    name: "UPLOAD_FILE_NAME",
    parents: [FOLDER_ID],
    modifiedTime: DateTime.now
  }
  result = @drive.create_file(
    file_object,
    supports_team_drives: true,
    upload_source: file_path)
  return result.id
end

• file_object: ファイル名等を指定します。parentsキーにチームドライブのIDです。
• supports_team_drives: リクエストするアプリケーションがチームドライブをサポートしているか指定するのでtrueにします。(警告：このアイテムは非推奨です。ですが、コードを実装した時点はまだ必要です。)

ファイルコピー

  def copy src_file_id, des_file_name, parent
    file_object = {
      name: des_file_name,
      parents: [parent]
    }    
    result = @drive.copy_file(src_file_id, file_object, supports_team_drives: true, supports_all_drives: true)
    result.id
  end

• parent: 親フォルダーのIDです。
• 返却値：コピーで生成されたファイルのIDです。

ファイル取得

def get_file file_id
  result = @drive.get_file(
    file_id, 
    include_team_drive_items: true, 
    supports_team_drives: true, supports_all_drives: true
  )
end

• file_id: ファイルのIDです。
• 返却値：ファイルオブジェクトです。

ファイル一覧

def list team_drive_id
  @service.list_files(
    corpora: 'teamDrive',
    team_drive_id: team_drive_id,
    q: "name='欲しいファイル名'",
    spaces: 'drive',
    fields: 'files(id,trashed)',
    include_team_drive_items: true,
    supports_team_drives: true)
end

ファイル削除

# 削除フラグの設定
def set_trashed(file)
  @service.update_file(
      file.id,
      {trashed: true},
      supports_team_drives: true)
end

• file_object: ゴミ箱に移動するのでtrashedにtrueを指定します。

フォルダーとの操作

フォルダー作成

  def mkdirp dir_name, parent
      file_object = {
        name: dir_name,
        parents: [parent],
        mime_type: 'application/vnd.google-apps.folder'
      }
      result= @drive.create_file(
        file_object,
        supports_team_drives: true, supports_all_drives: true)
      result.id
    end

• mime_type: ‘application/vnd.google-apps.folder’と指定したら、フォルダーが作成されます。
• parent: 親フォルダーです。

Google-api-ruby-clientのマイグレーション

おまけ

Slackへ通知機能を紹介したいと思います。

例えばあるファイルをアップロードして、Slackへ通知したいなら、以下のように実装できます。

最初はSlackのgemをインストールします。

gem "slack-incoming-webhooks", "0.3.0"

実装コード：

file_id = upload(file_path)    
url = "https://docs.google.com/spreadsheets/d/#{file_id}"
message = "#新しいファイルをアップロードしました\n#{url}" 

web_hook_url = 'https://hooks.slack.com/services/AAAA/BBBB/CCCCCCCC'
slack_username = 'Slackのユーザー名'
channel = 'Slackのチャネル'
slack = Slack::Incoming::Webhooks.new web_hook_url, username: slack_username, channel: channel
slack.post message

• slack.postを実行したら指定されたチャネルに設定したmessageを通知します。

最後に

参考リンク

• https://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/DriveV3/DriveService
• https://techblog.gmo-ap.jp/2019/05/17/upload_to_google_team_drive_with_ruby/
• https://techblog.gmo-ap.jp/2018/12/04/ruby_google_sheets_drive/
• https://developers.google.com/identity/protocols/oauth2
• https://github.com/googleapis/google-api-ruby-client
• https://cloud.google.com/iam/docs/