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 aDATA_READoperation and will appear in the data access audit logs.ModelService.GetModelandModelService.ListModels: These methods for retrieving model information are also logged asDATA_READoperations.
For data modification:
Model management:
CreateModel,DeleteModel,PauseModel,ResumeModel,TuneModel,UpdateModel. Methods that don't produce audit logs:The
google.longrunning.Operations.GetOperationandgoogle.longrunning.Operations.ListOperationsmethods, which are used to check the status of long-running operations like model training don't produce audit logs.
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:
- Types of audit logs
- Audit log entry structure
- Storing and routing audit logs
- Cloud Logging pricing summary
- Enable Data Access audit logs
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.
| Permission type | Methods |
|---|---|
DATA_READ |
google.cloud.retail.v2.AnalyticsService.ExportAnalyticsMetricsgoogle.cloud.retail.v2.CatalogService.GetAttributesConfiggoogle.cloud.retail.v2.CatalogService.GetCompletionConfiggoogle.cloud.retail.v2.CatalogService.GetDefaultBranchgoogle.cloud.retail.v2.CatalogService.ListCatalogsgoogle.cloud.retail.v2.CompletionService.CompleteQuerygoogle.cloud.retail.v2.ControlService.GetControlgoogle.cloud.retail.v2.ControlService.ListControlsgoogle.cloud.retail.v2.ModelService.GetModelgoogle.cloud.retail.v2.ModelService.ListModelsgoogle.cloud.retail.v2.PredictionService.Predictgoogle.cloud.retail.v2.ProductService.GetProductgoogle.cloud.retail.v2.ProductService.ListProductsgoogle.cloud.retail.v2.SearchService.Searchgoogle.cloud.retail.v2.ServingConfigService.GetServingConfiggoogle.cloud.retail.v2.ServingConfigService.ListServingConfigsgoogle.cloud.retail.v2alpha.AnalyticsService.ExportAnalyticsMetrics (LRO)google.cloud.retail.v2alpha.BranchService.GetBranchgoogle.cloud.retail.v2alpha.BranchService.ListBranchesgoogle.cloud.retail.v2alpha.CatalogService.GetAttributesConfiggoogle.cloud.retail.v2alpha.CatalogService.GetCompletionConfiggoogle.cloud.retail.v2alpha.CatalogService.GetDefaultBranchgoogle.cloud.retail.v2alpha.CatalogService.ListCatalogsgoogle.cloud.retail.v2alpha.CompletionService.CompleteQuerygoogle.cloud.retail.v2alpha.ControlService.GetControlgoogle.cloud.retail.v2alpha.ControlService.ListControlsgoogle.cloud.retail.v2alpha.ConversationalSearchService.ConversationalSearchgoogle.cloud.retail.v2alpha.ModelService.GetModelgoogle.cloud.retail.v2alpha.ModelService.ListModelsgoogle.cloud.retail.v2alpha.PredictionService.Predictgoogle.cloud.retail.v2alpha.ProductService.ExportProducts (LRO)google.cloud.retail.v2alpha.ProductService.GetProductgoogle.cloud.retail.v2alpha.ProductService.ListProductsgoogle.cloud.retail.v2alpha.ProjectService.GetAlertConfiggoogle.cloud.retail.v2alpha.ProjectService.GetLoggingConfiggoogle.cloud.retail.v2alpha.ProjectService.GetProjectgoogle.cloud.retail.v2alpha.ProjectService.ListEnrolledSolutionsgoogle.cloud.retail.v2alpha.SearchService.Searchgoogle.cloud.retail.v2alpha.ServingConfigService.GetServingConfiggoogle.cloud.retail.v2alpha.ServingConfigService.ListServingConfigsgoogle.cloud.retail.v2alpha.UserEventService.ExportUserEvents (LRO)google.cloud.retail.v2beta.AnalyticsService.ExportAnalyticsMetricsgoogle.cloud.retail.v2beta.CatalogService.GetAttributesConfiggoogle.cloud.retail.v2beta.CatalogService.GetCompletionConfiggoogle.cloud.retail.v2beta.CatalogService.GetDefaultBranchgoogle.cloud.retail.v2beta.CatalogService.ListCatalogsgoogle.cloud.retail.v2beta.CompletionService.CompleteQuerygoogle.cloud.retail.v2beta.ControlService.GetControlgoogle.cloud.retail.v2beta.ControlService.ListControlsgoogle.cloud.retail.v2beta.ModelService.GetModelgoogle.cloud.retail.v2beta.ModelService.ListModelsgoogle.cloud.retail.v2beta.PredictionService.Predictgoogle.cloud.retail.v2beta.ProductService.ExportProducts (LRO)google.cloud.retail.v2beta.ProductService.GetProductgoogle.cloud.retail.v2beta.ProductService.ListProductsgoogle.cloud.retail.v2beta.ProjectService.GetAlertConfiggoogle.cloud.retail.v2beta.SearchService.Searchgoogle.cloud.retail.v2beta.ServingConfigService.GetServingConfiggoogle.cloud.retail.v2beta.ServingConfigService.ListServingConfigsgoogle.cloud.retail.v2beta.UserEventService.ExportUserEvents (LRO) |
DATA_WRITE |
google.cloud.retail.v2.CatalogService.AddCatalogAttributegoogle.cloud.retail.v2.CatalogService.RemoveCatalogAttributegoogle.cloud.retail.v2.CatalogService.ReplaceCatalogAttributegoogle.cloud.retail.v2.CatalogService.SetDefaultBranchgoogle.cloud.retail.v2.CatalogService.UpdateAttributesConfiggoogle.cloud.retail.v2.CatalogService.UpdateCataloggoogle.cloud.retail.v2.CatalogService.UpdateCompletionConfiggoogle.cloud.retail.v2.CompletionService.ImportCompletionData (LRO)google.cloud.retail.v2.ControlService.CreateControlgoogle.cloud.retail.v2.ControlService.DeleteControlgoogle.cloud.retail.v2.ControlService.UpdateControlgoogle.cloud.retail.v2.ModelService.CreateModelgoogle.cloud.retail.v2.ModelService.DeleteModelgoogle.cloud.retail.v2.ModelService.PauseModelgoogle.cloud.retail.v2.ModelService.ResumeModelgoogle.cloud.retail.v2.ModelService.TuneModelgoogle.cloud.retail.v2.ModelService.UpdateModelgoogle.cloud.retail.v2.ProductService.AddFulfillmentPlacesgoogle.cloud.retail.v2.ProductService.AddLocalInventories (LRO)google.cloud.retail.v2.ProductService.CreateProductgoogle.cloud.retail.v2.ProductService.DeleteProductgoogle.cloud.retail.v2.ProductService.ImportProducts (LRO)google.cloud.retail.v2.ProductService.PurgeProducts (LRO)google.cloud.retail.v2.ProductService.RemoveFulfillmentPlacesgoogle.cloud.retail.v2.ProductService.RemoveLocalInventories (LRO)google.cloud.retail.v2.ProductService.SetInventory (LRO)google.cloud.retail.v2.ProductService.UpdateProductgoogle.cloud.retail.v2.ServingConfigService.AddControlgoogle.cloud.retail.v2.ServingConfigService.CreateServingConfiggoogle.cloud.retail.v2.ServingConfigService.DeleteServingConfiggoogle.cloud.retail.v2.ServingConfigService.RemoveControlgoogle.cloud.retail.v2.ServingConfigService.UpdateServingConfiggoogle.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.WriteUserEventgoogle.cloud.retail.v2alpha.CatalogService.AddCatalogAttributegoogle.cloud.retail.v2alpha.CatalogService.BatchRemoveCatalogAttributesgoogle.cloud.retail.v2alpha.CatalogService.RemoveCatalogAttributegoogle.cloud.retail.v2alpha.CatalogService.ReplaceCatalogAttributegoogle.cloud.retail.v2alpha.CatalogService.SetDefaultBranchgoogle.cloud.retail.v2alpha.CatalogService.UpdateAttributesConfiggoogle.cloud.retail.v2alpha.CatalogService.UpdateCataloggoogle.cloud.retail.v2alpha.CatalogService.UpdateCompletionConfiggoogle.cloud.retail.v2alpha.CompletionService.ImportCompletionData (LRO)google.cloud.retail.v2alpha.ControlService.CreateControlgoogle.cloud.retail.v2alpha.ControlService.DeleteControlgoogle.cloud.retail.v2alpha.ControlService.UpdateControlgoogle.cloud.retail.v2alpha.ModelService.CreateModel (LRO)google.cloud.retail.v2alpha.ModelService.DeleteModelgoogle.cloud.retail.v2alpha.ModelService.PauseModelgoogle.cloud.retail.v2alpha.ModelService.ResumeModelgoogle.cloud.retail.v2alpha.ModelService.TuneModel (LRO)google.cloud.retail.v2alpha.ModelService.UpdateModelgoogle.cloud.retail.v2alpha.ProductService.AddFulfillmentPlaces (LRO)google.cloud.retail.v2alpha.ProductService.AddLocalInventories (LRO)google.cloud.retail.v2alpha.ProductService.CreateProductgoogle.cloud.retail.v2alpha.ProductService.DeleteProductgoogle.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.UpdateProductgoogle.cloud.retail.v2alpha.ProjectService.AcceptTermsgoogle.cloud.retail.v2alpha.ProjectService.EnrollSolution (LRO)google.cloud.retail.v2alpha.ProjectService.UpdateAlertConfiggoogle.cloud.retail.v2alpha.ProjectService.UpdateLoggingConfiggoogle.cloud.retail.v2alpha.ServingConfigService.AddControlgoogle.cloud.retail.v2alpha.ServingConfigService.CreateServingConfiggoogle.cloud.retail.v2alpha.ServingConfigService.DeleteServingConfiggoogle.cloud.retail.v2alpha.ServingConfigService.RemoveControlgoogle.cloud.retail.v2alpha.ServingConfigService.UpdateServingConfiggoogle.cloud.retail.v2alpha.UserEventService.ImportUserEvents (LRO)google.cloud.retail.v2alpha.UserEventService.PurgeUserEvents (LRO)google.cloud.retail.v2alpha.UserEventService.RejoinUserEventsgoogle.cloud.retail.v2alpha.UserEventService.WriteUserEventgoogle.cloud.retail.v2beta.CatalogService.AddCatalogAttributegoogle.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributesgoogle.cloud.retail.v2beta.CatalogService.RemoveCatalogAttributegoogle.cloud.retail.v2beta.CatalogService.ReplaceCatalogAttribute |