Pythonを使用したGoogle Firebase Cloud Firestoreの実践的な活用方法

【概要】

Firebase Admin SDK を用いて，Python から Google Firebase の Cloud Firestore（クラウド・ファイアストア）を操作する方法を解説する。サービスアカウントの秘密鍵の取得，SDK の導入，コレクションからのデータ取得，条件を指定したクエリまでを扱う。

【目次】

  1. 第１章　Google Firebase の主要機能と特徴
  2. 第２章　環境構築と初期設定
  3. 第３章　Firebase Admin SDK の設定と秘密鍵の取得手順
  4. 第４章　Firebase Admin SDK の Python 環境への導入
  5. 第５章　実践的なクエリ例

【関連する外部ページ】 https://firebase.google.com/docs/firestore/quickstart?hl=ja

【サイト内の関連ページ】

Google Firebase 活用ガイド

第１章　Google Firebase の主要機能と特徴

クラウドストレージサービスとして，アプリ開発のインフラを提供する．

データベース機能：Python と JavaScript の双方から利用できる．

認証システム（ID，パスワード），セキュリティ管理，課金システムなど，アプリケーション開発に必要な機能を備える．

* iOS，Android，Web プラットフォームに対応．利用開始には Google アカウントの登録が必要．

第２章　環境構築と初期設定

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1：winget によるインストール

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして、コマンド全体をコマンドプロンプトにコピー＆ペーストする。

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 2：インストーラーによるインストール

  1. Python公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

Python の開発環境 Visual Studio Code のインストールと Python 用の設定

Python の開発環境Visual Studio Code（プログラムを編集するソフトウェア。以下、VS Code）を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより，既存の VS Code を削除し，全ユーザー共有の設定で再インストールしたうえで，拡張機能（VS Code に機能を追加するソフトウェア）をまとめて導入する．

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして，コマンド全体をコマンドプロンプトにコピー＆ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM （%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す）
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合，VS Code で使用する Python 本体（インタプリタ：Python プログラムを解釈・実行するソフトウェア）を選択する必要がある．

  1. コマンドパレット（コマンド名で機能を呼び出す VS Code の入力欄）を開く（Ctrl+Shift+P）
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から，使用する Python（例：C:\Program Files\Python312\python.exe）を選択する．

Git のインストール（Windows 上） [クリックして展開]

管理者権限のコマンドプロンプトで以下を実行する．管理者権限は，winget の --scope machine オプションでシステム全体にインストールするために必要となる．

REM Git をシステム領域にインストール
winget install --scope machine --id Git.Git -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/VERYSILENT /NORESTART /NOCANCEL /SP- /CLOSEAPPLICATIONS /RESTARTAPPLICATIONS /COMPONENTS=""icons,ext\reg\shellhere,assoc,assoc_sh"" /o:PathOption=Cmd /o:CRLFOption=CRLFCommitAsIs /o:BashTerminalOption=MinTTY /o:DefaultBranchOption=main /o:EditorOption=VIM /o:SSHOption=OpenSSH /o:UseCredentialManager=Enabled /o:PerformanceTweaksFSCache=Enabled /o:EnableSymlinks=Disabled /o:EnableFSMonitor=Disabled"

第３章　Firebase Admin SDK の設定と秘密鍵の取得手順

公式ドキュメントに基づいて，以下の手順で設定を実施する．

  1. Firebaseの公式ポータルサイトにアクセスする．

    https://firebase.google.com/?hl=ja

  2. メインページから「コンソールへ移動」を選択する．
  3. Googleアカウントによる認証を実行する．

    有効なセッションが存在する場合は，自動的に次のステップに移行する．

  4. Firebaseコンソールへのアクセス権限を確認する．
  5. コンソール画面から対象となるプロジェクトを選択する．

    * 新規プロジェクトを作成する場合は，「プロジェクトを追加」から設定を開始する．

  6. Project Overviewメニューから設定ボタンをクリックする．
  7. メニューから「プロジェクトを設定」を選択する．
  8. 左側のサイドメニューから「サービスアカウント」を選択する．
  9. 開発に使用する言語として「Python」を選択する．

    選択後，Firebase Admin SDKの設定に必要なコードスニペットが自動的に表示される．

    * この画面では「Firebase サービスアカウントを使用したPythonアプリケーションの認証機能」の詳細が確認できる．

  10. 「新しい秘密鍵の生成」ボタンを選択する．
  11. 表示される確認ダイアログで「キーを生成」を実行する．
  12. 生成された認証用JSONファイルのダウンロードを確認する．

    ダウンロードされた認証用JSONファイルのファイル名を記録する（後続の設定プロセスで使用）．

第４章　Firebase Admin SDK の Python 環境への導入

セットアップガイドおよび クイックスタートの手順に従って実装を進める．

  1. 管理者権限でコマンドプロンプトを起動する （手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。

  2. Firebase Admin SDKのインストールを実行する．

    以下のコマンドを実行する． 

    pip install -U --no-user firebase-admin
  3. Pythonプログラムで動作確認を実施する．
    開発環境として，Jupyter Qt Console，Spyder，PyCharm，PyScripterなどの統合開発環境の利用を推奨する．

    以下のサンプルコードを実行する．

    エディタで「H:/my-project-abcde-firebase-adminsdk-q53ez-5d420dbcf2.json」を，ダウンロードした認証用JSONファイルの実際のパスに置き換える．

    このプログラムは，データベース内の「products」コレクションに格納されているドキュメントを取得して表示する． 実行結果の例も併せて提示する． 

    import firebase_admin
from firebase_admin import credentials
from firebase_admin import firestore

cred = credentials.Certificate('H:/my-project-abcde-firebase-adminsdk-q53ez-5d420dbcf2.json')
app = firebase_admin.initialize_app(cred)

db = firestore.client()
ref = db.collection(u'products')
docs = ref.stream()

for doc in docs:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))

    以下のようなコレクション構造を前提としている．

    実行結果：

* Webインターフェースを使用したデータベース管理手順
  1. Firebaseポータルサイトにアクセスする．

    https://firebase.google.com/?hl=ja

    * 必要に応じてGoogleアカウントでの認証が要求される．

  2. 「コンソールへ移動」を選択する．
  3. Firebaseコンソールの表示を確認する．
  4. 管理対象のプロジェクトを選択する．

    * 新規プロジェクトが必要な場合は「プロジェクトを追加」から作成することができる．

  5. 左側のサイドメニューから「Database」を選択する．
  6. データベース管理画面でコレクションとドキュメントの作成・編集作業が可能となる．

第５章　実践的なクエリ例

前述のコード例に続いて，以下のクエリ処理を実行する． FieldFilter(u'name', u'==', u'apple') は，name フィールドが apple に完全一致するドキュメントを検索する処理である（現行の Firestore クライアントでは，where() に filter=FieldFilter(...) の形で条件を渡す）。 

from google.cloud.firestore_v1.base_query import FieldFilter
a = ref.where(filter=FieldFilter(u'name', u'==', u'apple'))
docs = a.stream()
for doc in docs:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))

実行結果：

日時データの比較クエリ例

FieldFilter(u'time', u'>', datetime.datetime(2019, 4, 13, 3, 10, 0)) の条件式で，Python の datetime オブジェクトを使用した日時比較クエリを実行する． 

import datetime
from google.cloud.firestore_v1.base_query import FieldFilter
a = ref.where(filter=FieldFilter(u'time', u'>', datetime.datetime(2019, 4, 13, 3, 10, 0)))
docs = a.stream()
for doc in docs:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))