AI Commerce Search audit logging

This page breaks down AI Commerce Search audit logging procedures by service, methods, and API interfaces. The audit logs generated vary depending on the AI Commerce Search product (including Recommendations AI) and product component, such as user events and models.

Recommendations AI audit logging

There are key Recommendations AI methods that generate various types of audit logs.

For data access:

  • PredictionService.Predict: This method, used to get recommendations, is categorized as a DATA_READ operation and will appear in the data access audit logs.

  • ModelService.GetModel and ModelService.ListModels: These methods for retrieving model information are also logged as DATA_READ operations.

For data modification:

  • Model management: CreateModel, DeleteModel, PauseModel, ResumeModel, TuneModel, UpdateModel. Methods that don't produce audit logs:

  • The google.longrunning.Operations.GetOperation and google.longrunning.Operations.ListOperations methods, which are used to check the status of long-running operations like model training don't produce audit logs.

AI Commerce Search audit logging

This document describes audit logging for Agent Search. Google Cloud services generate audit logs that record administrative and access activities within your Google Cloud resources. For more information about Cloud Audit Logs, see the following:

Service name

Agent Search audit logs use the service name retail.googleapis.com. Filter for this service:

    protoPayload.serviceName="retail.googleapis.com"
  

Methods by permission type

Each IAM permission has a type property, whose value is an enum that can be one of four values: ADMIN_READ, ADMIN_WRITE, DATA_READ, or DATA_WRITE. When you call a method, Agent Search generates an audit log whose category is dependent on the type property of the permission required to perform the method. Methods that require an IAM permission with the type property value of DATA_READ, DATA_WRITE, or ADMIN_READ generate Data Access audit logs. Methods that require an IAM permission with the type property value of ADMIN_WRITE generate Admin Activity audit logs.

API methods in the following list that are marked with (LRO) are long-running operations (LROs). These methods usually generate two audit log entries: one when the operation starts and another when it ends. For more information see Audit logs for long-running operations.
Permission type Methods
DATA_READ google.cloud.retail.v2.AnalyticsService.ExportAnalyticsMetrics
google.cloud.retail.v2.CatalogService.GetAttributesConfig
google.cloud.retail.v2.CatalogService.GetCompletionConfig
google.cloud.retail.v2.CatalogService.GetDefaultBranch
google.cloud.retail.v2.CatalogService.ListCatalogs
google.cloud.retail.v2.CompletionService.CompleteQuery
google.cloud.retail.v2.ControlService.GetControl
google.cloud.retail.v2.ControlService.ListControls
google.cloud.retail.v2.ModelService.GetModel
google.cloud.retail.v2.ModelService.ListModels
google.cloud.retail.v2.PredictionService.Predict
google.cloud.retail.v2.ProductService.GetProduct
google.cloud.retail.v2.ProductService.ListProducts
google.cloud.retail.v2.SearchService.Search
google.cloud.retail.v2.ServingConfigService.GetServingConfig
google.cloud.retail.v2.ServingConfigService.ListServingConfigs
google.cloud.retail.v2alpha.AnalyticsService.ExportAnalyticsMetrics (LRO)
google.cloud.retail.v2alpha.BranchService.GetBranch
google.cloud.retail.v2alpha.BranchService.ListBranches
google.cloud.retail.v2alpha.CatalogService.GetAttributesConfig
google.cloud.retail.v2alpha.CatalogService.GetCompletionConfig
google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch
google.cloud.retail.v2alpha.CatalogService.ListCatalogs
google.cloud.retail.v2alpha.CompletionService.CompleteQuery
google.cloud.retail.v2alpha.ControlService.GetControl
google.cloud.retail.v2alpha.ControlService.ListControls
google.cloud.retail.v2alpha.ConversationalSearchService.ConversationalSearch
google.cloud.retail.v2alpha.ModelService.GetModel
google.cloud.retail.v2alpha.ModelService.ListModels
google.cloud.retail.v2alpha.PredictionService.Predict
google.cloud.retail.v2alpha.ProductService.ExportProducts (LRO)
google.cloud.retail.v2alpha.ProductService.GetProduct
google.cloud.retail.v2alpha.ProductService.ListProducts
google.cloud.retail.v2alpha.ProjectService.GetAlertConfig
google.cloud.retail.v2alpha.ProjectService.GetLoggingConfig
google.cloud.retail.v2alpha.ProjectService.GetProject
google.cloud.retail.v2alpha.ProjectService.ListEnrolledSolutions
google.cloud.retail.v2alpha.SearchService.Search
google.cloud.retail.v2alpha.ServingConfigService.GetServingConfig
google.cloud.retail.v2alpha.ServingConfigService.ListServingConfigs
google.cloud.retail.v2alpha.UserEventService.ExportUserEvents (LRO)
google.cloud.retail.v2beta.AnalyticsService.ExportAnalyticsMetrics
google.cloud.retail.v2beta.CatalogService.GetAttributesConfig
google.cloud.retail.v2beta.CatalogService.GetCompletionConfig
google.cloud.retail.v2beta.CatalogService.GetDefaultBranch
google.cloud.retail.v2beta.CatalogService.ListCatalogs
google.cloud.retail.v2beta.CompletionService.CompleteQuery
google.cloud.retail.v2beta.ControlService.GetControl
google.cloud.retail.v2beta.ControlService.ListControls
google.cloud.retail.v2beta.ModelService.GetModel
google.cloud.retail.v2beta.ModelService.ListModels
google.cloud.retail.v2beta.PredictionService.Predict
google.cloud.retail.v2beta.ProductService.ExportProducts (LRO)
google.cloud.retail.v2beta.ProductService.GetProduct
google.cloud.retail.v2beta.ProductService.ListProducts
google.cloud.retail.v2beta.ProjectService.GetAlertConfig
google.cloud.retail.v2beta.SearchService.Search
google.cloud.retail.v2beta.ServingConfigService.GetServingConfig
google.cloud.retail.v2beta.ServingConfigService.ListServingConfigs
google.cloud.retail.v2beta.UserEventService.ExportUserEvents (LRO)
DATA_WRITE google.cloud.retail.v2.CatalogService.AddCatalogAttribute
google.cloud.retail.v2.CatalogService.RemoveCatalogAttribute
google.cloud.retail.v2.CatalogService.ReplaceCatalogAttribute
google.cloud.retail.v2.CatalogService.SetDefaultBranch
google.cloud.retail.v2.CatalogService.UpdateAttributesConfig
google.cloud.retail.v2.CatalogService.UpdateCatalog
google.cloud.retail.v2.CatalogService.UpdateCompletionConfig
google.cloud.retail.v2.CompletionService.ImportCompletionData (LRO)
google.cloud.retail.v2.ControlService.CreateControl
google.cloud.retail.v2.ControlService.DeleteControl
google.cloud.retail.v2.ControlService.UpdateControl
google.cloud.retail.v2.ModelService.CreateModel
google.cloud.retail.v2.ModelService.DeleteModel
google.cloud.retail.v2.ModelService.PauseModel
google.cloud.retail.v2.ModelService.ResumeModel
google.cloud.retail.v2.ModelService.TuneModel
google.cloud.retail.v2.ModelService.UpdateModel
google.cloud.retail.v2.ProductService.AddFulfillmentPlaces
google.cloud.retail.v2.ProductService.AddLocalInventories (LRO)
google.cloud.retail.v2.ProductService.CreateProduct
google.cloud.retail.v2.ProductService.DeleteProduct
google.cloud.retail.v2.ProductService.ImportProducts (LRO)
google.cloud.retail.v2.ProductService.PurgeProducts (LRO)
google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces
google.cloud.retail.v2.ProductService.RemoveLocalInventories (LRO)
google.cloud.retail.v2.ProductService.SetInventory (LRO)
google.cloud.retail.v2.ProductService.UpdateProduct
google.cloud.retail.v2.ServingConfigService.AddControl
google.cloud.retail.v2.ServingConfigService.CreateServingConfig
google.cloud.retail.v2.ServingConfigService.DeleteServingConfig
google.cloud.retail.v2.ServingConfigService.RemoveControl
google.cloud.retail.v2.ServingConfigService.UpdateServingConfig
google.cloud.retail.v2.UserEventService.ImportUserEvents (LRO)
google.cloud.retail.v2.UserEventService.PurgeUserEvents (LRO)
google.cloud.retail.v2.UserEventService.RejoinUserEvents (LRO)
google.cloud.retail.v2.UserEventService.WriteUserEvent
google.cloud.retail.v2alpha.CatalogService.AddCatalogAttribute
google.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributes
google.cloud.retail.v2alpha.CatalogService.RemoveCatalogAttribute
google.cloud.retail.v2alpha.CatalogService.ReplaceCatalogAttribute
google.cloud.retail.v2alpha.CatalogService.SetDefaultBranch
google.cloud.retail.v2alpha.CatalogService.UpdateAttributesConfig
google.cloud.retail.v2alpha.CatalogService.UpdateCatalog
google.cloud.retail.v2alpha.CatalogService.UpdateCompletionConfig
google.cloud.retail.v2alpha.CompletionService.ImportCompletionData (LRO)
google.cloud.retail.v2alpha.ControlService.CreateControl
google.cloud.retail.v2alpha.ControlService.DeleteControl
google.cloud.retail.v2alpha.ControlService.UpdateControl
google.cloud.retail.v2alpha.ModelService.CreateModel (LRO)
google.cloud.retail.v2alpha.ModelService.DeleteModel
google.cloud.retail.v2alpha.ModelService.PauseModel
google.cloud.retail.v2alpha.ModelService.ResumeModel
google.cloud.retail.v2alpha.ModelService.TuneModel (LRO)
google.cloud.retail.v2alpha.ModelService.UpdateModel
google.cloud.retail.v2alpha.ProductService.AddFulfillmentPlaces (LRO)
google.cloud.retail.v2alpha.ProductService.AddLocalInventories (LRO)
google.cloud.retail.v2alpha.ProductService.CreateProduct
google.cloud.retail.v2alpha.ProductService.DeleteProduct
google.cloud.retail.v2alpha.ProductService.ImportProducts (LRO)
google.cloud.retail.v2alpha.ProductService.PurgeProducts (LRO)
google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces (LRO)
google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories (LRO)
google.cloud.retail.v2alpha.ProductService.SetInventory (LRO)
google.cloud.retail.v2alpha.ProductService.UpdateProduct
google.cloud.retail.v2alpha.ProjectService.AcceptTerms
google.cloud.retail.v2alpha.ProjectService.EnrollSolution (LRO)
google.cloud.retail.v2alpha.ProjectService.UpdateAlertConfig
google.cloud.retail.v2alpha.ProjectService.UpdateLoggingConfig
google.cloud.retail.v2alpha.ServingConfigService.AddControl
google.cloud.retail.v2alpha.ServingConfigService.CreateServingConfig
google.cloud.retail.v2alpha.ServingConfigService.DeleteServingConfig
google.cloud.retail.v2alpha.ServingConfigService.RemoveControl
google.cloud.retail.v2alpha.ServingConfigService.UpdateServingConfig
google.cloud.retail.v2alpha.UserEventService.ImportUserEvents (LRO)
google.cloud.retail.v2alpha.UserEventService.PurgeUserEvents (LRO)
google.cloud.retail.v2alpha.UserEventService.RejoinUserEvents
google.cloud.retail.v2alpha.UserEventService.WriteUserEvent
google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute
google.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributes
google.cloud.retail.v2beta.CatalogService.RemoveCatalogAttribute
google.cloud.retail.v2beta.CatalogService.ReplaceCatalogAttribute