「刪除使用者資料」擴充功能 (delete-user-data
) 可讓您在 Firebase 專案中刪除使用者時,一併刪除使用者的資料。您可以設定這項擴充功能,將使用者資料從下列任何或所有位置刪除:Cloud Firestore、即時資料庫或 Cloud Storage。每個擴充功能刪除資料的觸發條件都會寫入使用者的 UserId
。
這項擴充功能有助於尊重使用者隱私及滿足法規遵循要求。不過,使用這項擴充功能不保證一定能符合政府和業界法規。
先備知識
您必須使用 Firebase 驗證來管理使用者。
這項擴充功能只會刪除 Cloud Firestore、即時資料庫和 Cloud Storage 中的資料。如果將使用者資料儲存在其他位置,刪除使用者時,也應該從這些來源刪除使用者資料。
安裝擴充功能
如要安裝擴充功能,請按照「安裝 Firebase 擴充功能」頁面中的步驟操作。總結來說,請執行下列其中一項操作:
Firebase 主控台:點選下方按鈕:
CLI:執行下列指令:
firebase ext:install firebase/delete-user-data --project=projectId-or-alias
安裝擴充功能時,系統會提示您指定多個設定參數:
Cloud Functions 位置:
選取要部署為這項擴充功能建立的函式,放在哪個位置。通常會希望將函數部署到靠近資料庫的位置。關於選取位置的說明,請參閱位置選取指南。
Cloud Firestore 路徑:
在 Cloud Firestore 執行個體中,哪些路徑下包含使用者資料?如果未使用 Cloud Firestore,請將這個欄位留空。請輸入完整路徑,並以半形逗號分隔。您可以使用
{UID}
代表已刪除使用者的使用者 ID。舉例來說,如果您有集合users
和admins
,且每個集合都有使用 User ID 做為文件 ID 的文件,那麼您可以輸入users/{UID},admins/{UID}
。Cloud Firestore 刪除模式:
(僅適用於使用
Cloud Firestore paths
參數的情況)。要如何刪除 Cloud Firestore 文件?如要一併刪除子集合中的文件,請將這個參數設為recursive
。即時資料庫執行個體:
您想從哪個即時資料庫執行個體刪除使用者資料?
即時資料庫位置:
(只有在您提供
Realtime Database instance
參數時才適用)。您想從哪個即時資料庫位置刪除使用者資料?即時資料庫路徑:
在即時資料庫執行個體中,哪些路徑下包含使用者資料?如果沒有使用即時資料庫,請留空。請輸入完整路徑,並以半形逗號分隔。您可以使用
{UID}
代表已刪除使用者的使用者 ID。例如:users/{UID},admins/{UID}
。Cloud Storage 路徑:
你要將使用者資料儲存在 Google Cloud Storage 中的哪個位置?如果未使用 Cloud Storage,請將這個欄位留空。請輸入 Storage 值區中檔案或目錄的完整路徑,並以半形逗號分隔。使用
{UID}
代表已刪除使用者的使用者 ID,並使用{DEFAULT}
代表預設的 Storage 值區。以下提供一系列範例:
- 如要使用檔案命名機制
{UID}-pic.png
刪除預設值區中的所有檔案,請輸入{DEFAULT}/{UID}-pic.png
。 - 如要一併刪除另一個名為
my-app-logs
的值區,檔案命名配置為{UID}-logs.txt
,請輸入{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt
。 - 如果「同時」刪除已加上 User ID 標籤的目錄及其所有檔案 (例如
media/{UID}
),請輸入{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt,{DEFAULT}/media/{UID}
。
- 如要使用檔案命名機制
探索要刪除的資料
這項擴充功能會使用幾��機制找出要刪除的資料。您必須明確設定這些機制,擴充功能才能刪除資料。這個擴充功能只會刪除根據提供的機制明確設定刪除的資料。
請注意每項服務之間的行為差異如下:
- Cloud Firestore:預設行為是淺刪除文件 (不會刪除子集合)。如要以遞迴方式刪除文件的所有子集合,請將「Cloud Firestore 刪除模式」選項設為「遞迴」。
- 即時資料庫:會刪除指定節點的所有資料。
- 儲存空間:如果指定目錄路徑,所有檔案和子目錄都會遭到刪除。
依路徑
設定 Cloud Firestore、即時資料庫和 Cloud Storage 路徑時,您可以在路徑中定義 UID
變數,系統會將該變數替換為已驗證使用者的 UID。刪除使用者時,擴充功能會刪除特定路徑中含有該 UID 的所有資料,例如:
- Cloud Firestore 路徑:
users/{UID},admins/{UID}
- 即時資料庫路徑:
likes/{UID}
- Cloud Storage 路徑:
{DEFAULT}/uploads/{UID},{DEFAULT}/avatars/{UID}.jpeg
自動探索 (Cloud Firestore)
如要啟用擴充功能,讓擴充功能自動探索要刪除的 Firestore 文件,請將「啟用自動探索功能」設定參數設為「是」。
自動探索功能的運作方式是自動遍歷資料庫,找出應根據設定刪除的集合和文件。這個擴充功能使用下列方法識別這些集合和文件:
- 首先,擴充功能會在資料庫中找出所有根集合,如果集合 ID 與使用者 UID 相符,系統就會刪除整個集合 (視「Cloud Firestore 刪除模式」的擴充功能設定而定,刪除作業會是遞迴或淺層)。
- 其次,如果集合 ID 不符,擴充功能就會嘗試識別並刪除文件 ID 與使用者 UID 相符的文件。
- 最後,針對每份文件 a. 如果目前的搜尋深度 (請見下文) 小於或等於設定的搜尋深度,系統就會針對目前文件的所有子集合重複這個程序。 b.如果已設定搜尋欄位,擴充功能會檢查提供的欄位是否與使用者的 UID 相符。如果找到相符的項目,系統就會刪除該文件。
搜尋瀏覽頁數
這個擴充功能提供可設定的搜尋深度值 (預設值為 3)。只有在目前的搜尋深度小於或等於設定的搜尋深度時,系統才會執行遍歷。目前的搜尋深度是根據目前集合或文件父項集合的深度而定,例如:
/users = 1
/users/<document-id> = 1
/users/<document-id>/comments = 2
/users/<document-id>/comments/<document-id> = 2
這項擴充功能「不會」自動刪除儲存在陣列或對應中的 UID,且不會搜尋儲存於上方指定深度範圍且由深層巢狀子集合的使用者 ID 加上的 UID。