Firestore 稽核記錄資訊

Firestore 稽核記錄資訊

本文列出 Firestore 的稽核方法。 Google Cloud 服務會產生稽核記錄，用於記錄 Google Cloud 資源中的管理和存取活動。如要進一步瞭解 Cloud 稽核記錄，請參閱以下內容：

• 稽核記錄類型
• 稽核記錄項目結構
• 儲存及轉送稽核記錄
• Cloud Logging 定價摘要
• 啟用資料存取稽核記錄

附註

設定稽核記錄時，請使用服務名稱 datastore.googleapis.com 同時設定 datastore.googleapis.com 和 firestore.googleapis.com。設定完成後，Firestore API 的記錄會包含服務名稱 firestore.googleapis.com。

如要查看處理 DATA_READ 或 DATA_WRITE 要求所花費的時間，請參閱 AuditLog 的 metadata 物件中的 processing_duration 欄位。 processing_duration 是指資料庫實際處理要求所花費的時間。這比使用者延遲時間還短。特別是不包含網路額外負荷。

如果是 Listen 要求，只有在傳回初始結果集時，稽核記錄中才會出現 processing_duration。在該Listen目標
的後續稽核記錄中，不會再出現這類項目。

匯入、大量刪除作業和存留時間的個別寫入作業不會記錄在稽核記錄中。

服務名稱

如要查看 Firestore 稽核記錄，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「Logs Explorer」頁面：

   前往 Logs Explorer

2. 複製下列查詢並貼到「Logs Explorer」的「Query」欄位，然後點選「Run query」。

       protoPayload.serviceName="firestore.googleapis.com"
     

依權限類型區分的方法

Firestore 也會將下列作業納入 Key Visualizer 診斷工具。這些是「資料存取」稽核記錄，服務名稱為 firestorekeyvisualizer.googleapis.com。只要為 firestore.googleapis.com 服務啟用 DATA_READ，即可使用這些功能。

• google.cloud.keyvisualizer.KeyVisualizer.GetScan
• google.cloud.keyvisualizer.KeyVisualizer.ListScans

每個 IAM 權限都具有 type 屬性，其值為以下四個列舉值之一：ADMIN_READ、ADMIN_WRITE、DATA_READ 或 DATA_WRITE。呼叫方法時，Firestore 會產生一筆稽核記錄，類別取決於執行該方法所需權限的 type 屬性。若方法需要的 IAM 權限，type 屬性值為 DATA_READ、DATA_WRITE 或 ADMIN_READ，就會產生資料存取稽核記錄；若所需 IAM 權限的 type 屬性值為 ADMIN_WRITE，則會產生管理員活動稽核記錄。

下表列出的 API 方法中，如標有 (LRO) 字樣，表示為長時間執行的作業。這類方法通常會產生兩個稽核記錄項目，作業開始和結束時各一個。詳情請參閱「長時間執行的作業稽核記錄」。

權限類型	方法
ADMIN_READ	google.cloud.location.Locations.GetLocation google.cloud.location.Locations.ListLocations google.firestore.admin.v1.FirestoreAdmin.GetBackup google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule google.firestore.admin.v1.FirestoreAdmin.GetDatabase google.firestore.admin.v1.FirestoreAdmin.GetField google.firestore.admin.v1.FirestoreAdmin.GetIndex google.firestore.admin.v1.FirestoreAdmin.GetUserCreds google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules google.firestore.admin.v1.FirestoreAdmin.ListBackups google.firestore.admin.v1.FirestoreAdmin.ListDatabases google.firestore.admin.v1.FirestoreAdmin.ListFields google.firestore.admin.v1.FirestoreAdmin.ListIndexes google.firestore.admin.v1.FirestoreAdmin.ListUserCreds google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes google.firestore.admin.v1beta2.FirestoreAdmin.GetField google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex google.firestore.admin.v1beta2.FirestoreAdmin.ListFields google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes google.longrunning.Operations.GetOperation google.longrunning.Operations.ListOperations
ADMIN_WRITE	google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments (LRO) google.firestore.admin.v1.FirestoreAdmin.CloneDatabase google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule google.firestore.admin.v1.FirestoreAdmin.CreateDatabase google.firestore.admin.v1.FirestoreAdmin.CreateIndex (LRO) google.firestore.admin.v1.FirestoreAdmin.CreateUserCreds google.firestore.admin.v1.FirestoreAdmin.DeleteBackup google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase google.firestore.admin.v1.FirestoreAdmin.DeleteIndex google.firestore.admin.v1.FirestoreAdmin.DeleteUserCreds google.firestore.admin.v1.FirestoreAdmin.DisableUserCreds google.firestore.admin.v1.FirestoreAdmin.EnableUserCreds google.firestore.admin.v1.FirestoreAdmin.ExportDocuments (LRO) google.firestore.admin.v1.FirestoreAdmin.ImportDocuments (LRO) google.firestore.admin.v1.FirestoreAdmin.ResetUserPassword google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase google.firestore.admin.v1.FirestoreAdmin.UpdateField (LRO) google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex (LRO) google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments (LRO) google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField (LRO) google.longrunning.Operations.CancelOperation google.longrunning.Operations.DeleteOperation
DATA_READ	google.firestore.v1.Firestore.BatchGetDocuments google.firestore.v1.Firestore.BeginTransaction google.firestore.v1.Firestore.ExecutePipeline google.firestore.v1.Firestore.GetDocument google.firestore.v1.Firestore.ListCollectionIds google.firestore.v1.Firestore.ListDocuments google.firestore.v1.Firestore.Listen google.firestore.v1.Firestore.PartitionQuery google.firestore.v1.Firestore.Rollback google.firestore.v1.Firestore.RunAggregationQuery google.firestore.v1.Firestore.RunQuery google.firestore.v1beta1.Firestore.BatchGetDocuments google.firestore.v1beta1.Firestore.BatchWrite google.firestore.v1beta1.Firestore.BeginTransaction google.firestore.v1beta1.Firestore.GetDocument google.firestore.v1beta1.Firestore.ListCollectionIds google.firestore.v1beta1.Firestore.ListDocuments google.firestore.v1beta1.Firestore.Listen google.firestore.v1beta1.Firestore.PartitionQuery google.firestore.v1beta1.Firestore.Rollback google.firestore.v1beta1.Firestore.RunAggregationQuery google.firestore.v1beta1.Firestore.RunQuery
DATA_WRITE	google.firestore.v1.Firestore.BatchWrite google.firestore.v1.Firestore.Commit google.firestore.v1.Firestore.CreateDocument google.firestore.v1.Firestore.DeleteDocument google.firestore.v1.Firestore.UpdateDocument google.firestore.v1.Firestore.Write google.firestore.v1beta1.Firestore.Commit google.firestore.v1beta1.Firestore.CreateDocument google.firestore.v1beta1.Firestore.DeleteDocument google.firestore.v1beta1.Firestore.UpdateDocument google.firestore.v1beta1.Firestore.Write

API 介面稽核記錄

如要瞭解各方法所需的權限及評估方式，請參閱 Firestore 的 Identity and Access Management 說明文件。

google.cloud.location.Locations

屬於 google.cloud.location.Locations 的方法會產生以下稽核記錄。

GetLocation

• 方法：google.cloud.location.Locations.GetLocation
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.locations.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.cloud.location.Locations.GetLocation"
  

ListLocations

• 方法：google.cloud.location.Locations.ListLocations
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.locations.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.cloud.location.Locations.ListLocations"
  

google.firestore.admin.v1.FirestoreAdmin

屬於 google.firestore.admin.v1.FirestoreAdmin 的方法會產生以下稽核記錄。

BulkDeleteDocuments

• 方法：google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.bulkDelete - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments"
  

CloneDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.CloneDatabase
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.clone - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CloneDatabase"
  

CreateBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.backupSchedules.create - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule"
  

CreateDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateDatabase
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.create - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateDatabase"
  

CreateIndex

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateIndex
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.create - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateIndex"
  

CreateUserCreds

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateUserCreds
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.userCreds.create - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateUserCreds"
  

DeleteBackup

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteBackup
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.backups.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteBackup"
  

DeleteBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.backupSchedules.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule"
  

DeleteDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase"
  

DeleteIndex

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteIndex
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteIndex"
  

DeleteUserCreds

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteUserCreds
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.userCreds.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteUserCreds"
  

DisableUserCreds

• 方法：google.firestore.admin.v1.FirestoreAdmin.DisableUserCreds
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.userCreds.update - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DisableUserCreds"
  

EnableUserCreds

• 方法：google.firestore.admin.v1.FirestoreAdmin.EnableUserCreds
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.userCreds.update - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.EnableUserCreds"
  

ExportDocuments

• 方法：google.firestore.admin.v1.FirestoreAdmin.ExportDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.export - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ExportDocuments"
  

GetBackup

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetBackup
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.backups.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetBackup"
  

GetBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.backupSchedules.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule"
  

GetDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetDatabase
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.getMetadata - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetDatabase"
  

GetField

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetField
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetField"
  

GetIndex

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetIndex
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetIndex"
  

GetUserCreds

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetUserCreds
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.userCreds.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetUserCreds"
  

ImportDocuments

• 方法：google.firestore.admin.v1.FirestoreAdmin.ImportDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.import - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ImportDocuments"
  

ListBackupSchedules

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.backupSchedules.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules"
  

ListBackups

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListBackups
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.backups.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListBackups"
  

ListDatabases

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListDatabases
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListDatabases"
  

ListFields

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListFields
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListFields"
  

ListIndexes

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListIndexes
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListIndexes"
  

ListUserCreds

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListUserCreds
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.userCreds.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListUserCreds"
  

ResetUserPassword

• 方法：google.firestore.admin.v1.FirestoreAdmin.ResetUserPassword
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.userCreds.update - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ResetUserPassword"
  

RestoreDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.backups.restoreDatabase - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase"
  

UpdateBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.backupSchedules.update - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule"
  

UpdateDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.update - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase"
  

UpdateField

• 方法：google.firestore.admin.v1.FirestoreAdmin.UpdateField
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.update - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateField"
  

google.firestore.admin.v1beta1.FirestoreAdmin

屬於 google.firestore.admin.v1beta1.FirestoreAdmin 的方法會產生以下稽核記錄。

CreateIndex

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.create - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex"
  

DeleteIndex

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.export - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments"
  

GetIndex

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex"
  

ImportDocuments

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.import - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments"
  

ListIndexes

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes"
  

google.firestore.admin.v1beta2.FirestoreAdmin

屬於 google.firestore.admin.v1beta2.FirestoreAdmin 的方法會產生以下稽核記錄。

CreateIndex

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.create - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex"
  

DeleteIndex

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.export - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments"
  

GetField

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.GetField
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.GetField"
  

GetIndex

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex"
  

ImportDocuments

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.databases.import - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments"
  

ListFields

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ListFields
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ListFields"
  

ListIndexes

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.indexes.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes"
  

UpdateField

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.indexes.update - ADMIN_WRITE
• 方法的作業種類： 長時間執行的作業
  
• 篩選條件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField"
  

google.firestore.v1.Firestore

屬於 google.firestore.v1.Firestore 的方法會產生以下稽核記錄。

BatchGetDocuments

• 方法：google.firestore.v1.Firestore.BatchGetDocuments
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.BatchGetDocuments"
  

BatchWrite

• 方法：google.firestore.v1.Firestore.BatchWrite
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.delete - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.BatchWrite"
  

BeginTransaction

• 方法：google.firestore.v1.Firestore.BeginTransaction
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.BeginTransaction"
  

Commit

• 方法：google.firestore.v1.Firestore.Commit
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.Commit"
  

CreateDocument

• 方法：google.firestore.v1.Firestore.CreateDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.allocateIds - DATA_WRITE
  • datastore.entities.create - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.CreateDocument"
  

DeleteDocument

• 方法：google.firestore.v1.Firestore.DeleteDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.delete - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.DeleteDocument"
  

ExecutePipeline

• 方法：google.firestore.v1.Firestore.ExecutePipeline
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.ExecutePipeline"
  

注意： ExecutePipeline 是生命週期短暫的串流 RPC，會在傳送最後一則訊息 (文件) 時發出記錄項目。

GetDocument

• 方法：google.firestore.v1.Firestore.GetDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.GetDocument"
  

ListCollectionIds

• 方法：google.firestore.v1.Firestore.ListCollectionIds
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.ListCollectionIds"
  

ListDocuments

• 方法：google.firestore.v1.Firestore.ListDocuments
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.ListDocuments"
  

Listen

• 方法：google.firestore.v1.Firestore.Listen
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 串流 RPC
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.Listen"
  

注意：

Listen 是結合多個串流目標的長期 RPC。每個目標都是查詢或一組文件鍵。每個目標的串流都包含初始結果集，以及結果集的更新、新增和移除序列。目標是相關的稽核單位。Firestore 會依下列方式稽核每個目標：

• 新增目標後，請發出記錄項目，並設定目標查詢或文件鍵。在這些項目中，operation.first 為 true。如果串流是先前「Listen」目標串流的續傳，則會省略這項稽核記錄。
• 定期發出更新，回報自上次稽核記錄以來，這個目標的更新次數。
• 當目標從串流中移除時 (無論是明確移除，還是因 Listen RPC 終止而移除)，請發出記錄項目。這項記錄項目會回報自上次稽核記錄以來，這個目標的更新次數。在這些項目中，operation.last 為 true。
• 發出的記錄項目會使用相同的 operation.id。

PartitionQuery

• 方法：google.firestore.v1.Firestore.PartitionQuery
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.PartitionQuery"
  

Rollback

• 方法：google.firestore.v1.Firestore.Rollback
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.Rollback"
  

RunAggregationQuery

• 方法：google.firestore.v1.Firestore.RunAggregationQuery
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.RunAggregationQuery"
  

注意： RunAggregationQuery 是生命週期短暫的串流 RPC，會在傳送最後一則訊息 (文件) 時發出記錄項目。

RunQuery

• 方法：google.firestore.v1.Firestore.RunQuery
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.RunQuery"
  

注意： RunQuery 是生命週期短暫的串流 RPC，會在傳送最後一則訊息 (文件) 時發出記錄項目。

UpdateDocument

• 方法：google.firestore.v1.Firestore.UpdateDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.UpdateDocument"
  

Write

• 方法：google.firestore.v1.Firestore.Write
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1.Firestore.Write"
  

注意： Write 會針對收到的每則訊息發出記錄項目，因為每則訊息都對應至資料庫的獨立寫入作業。發出的記錄項目會使用相同的 operation.id。

google.firestore.v1beta1.Firestore

屬於 google.firestore.v1beta1.Firestore 的方法會產生以下稽核記錄。

BatchGetDocuments

• 方法：google.firestore.v1beta1.Firestore.BatchGetDocuments
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.BatchGetDocuments"
  

BatchWrite

• 方法：google.firestore.v1beta1.Firestore.BatchWrite
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.BatchWrite"
  

BeginTransaction

• 方法：google.firestore.v1beta1.Firestore.BeginTransaction
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.BeginTransaction"
  

Commit

• 方法：google.firestore.v1beta1.Firestore.Commit
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.Commit"
  

CreateDocument

• 方法：google.firestore.v1beta1.Firestore.CreateDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.allocateIds - DATA_WRITE
  • datastore.entities.create - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.CreateDocument"
  

DeleteDocument

• 方法：google.firestore.v1beta1.Firestore.DeleteDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.delete - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.DeleteDocument"
  

GetDocument

• 方法：google.firestore.v1beta1.Firestore.GetDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.GetDocument"
  

ListCollectionIds

• 方法：google.firestore.v1beta1.Firestore.ListCollectionIds
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.ListCollectionIds"
  

ListDocuments

• 方法：google.firestore.v1beta1.Firestore.ListDocuments
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.ListDocuments"
  

Listen

• 方法：google.firestore.v1beta1.Firestore.Listen
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 串流 RPC
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.Listen"
  

PartitionQuery

• 方法：google.firestore.v1beta1.Firestore.PartitionQuery
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.PartitionQuery"
  

Rollback

• 方法：google.firestore.v1beta1.Firestore.Rollback
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.databases.get - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.Rollback"
  

RunAggregationQuery

• 方法：google.firestore.v1beta1.Firestore.RunAggregationQuery
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.RunAggregationQuery"
  

注意： RunAggregationQuery 是生命週期短暫的串流 RPC，會在傳送最後一則訊息 (文件) 時發出記錄項目。

RunQuery

• 方法：google.firestore.v1beta1.Firestore.RunQuery
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.RunQuery"
  

注意： RunQuery 是生命週期短暫的串流 RPC，會在傳送最後一則訊息 (文件) 時發出記錄項目。

UpdateDocument

• 方法：google.firestore.v1beta1.Firestore.UpdateDocument
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.UpdateDocument"
  

Write

• 方法：google.firestore.v1beta1.Firestore.Write
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.firestore.v1beta1.Firestore.Write"
  

google.longrunning.Operations

屬於 google.longrunning.Operations 的方法會產生以下稽核記錄。

CancelOperation

• 方法：google.longrunning.Operations.CancelOperation
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.operations.cancel - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.longrunning.Operations.CancelOperation"
  

DeleteOperation

• 方法：google.longrunning.Operations.DeleteOperation
  
• 稽核記錄類型：管理員活動
  
• 權限：
  • datastore.operations.delete - ADMIN_WRITE
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.longrunning.Operations.DeleteOperation"
  

GetOperation

• 方法：google.longrunning.Operations.GetOperation
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.operations.get - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.longrunning.Operations.GetOperation"
  

ListOperations

• 方法：google.longrunning.Operations.ListOperations
  
• 稽核記錄類型：資料存取
  
• 權限：
  • datastore.operations.list - ADMIN_READ
• 方法的作業種類： 非長時間執行或串流作業。
  
• 篩選條件： protoPayload.methodName="google.longrunning.Operations.ListOperations"
  

不會產生稽核記錄的方法

某些方法可能不會產生稽核記錄，原因包括以下一或多項：

• 該方法的流量使用量高，若產生稽核記錄，會導致記錄與儲存成本過高。
• 稽核價值低。
• 其他稽核記錄或平台記錄已涵蓋該方法的活動。

下列方法不會產生稽核記錄：

• google.longrunning.Operations.WaitOperation

找出要求發出者

稽核記錄項目包含執行記錄作業的身分相關資訊。如要識別要求呼叫端，請查看 AuditLog 物件中的下列欄位：

• 呼叫端的 ID 會儲存在 AuthenticationInfo 欄位中。這可能包括使用者的 principalEmail。這項資訊有時會經過編輯。

  如果第三方驗證使用 JSON Web Token (JWT)，thirdPartyPrincipal 欄位會包含符記的標頭和酬載。舉例來說，使用 Firebase 驗證進行驗證的要求稽核記錄，會包含該要求的驗證權杖。

• AuditLog 項目 requestMetadata 物件中的 callerIp 欄位包含呼叫端的 IP 位址。