Cloud Audit Logs for Google Workspace add-ons let you track administrative and
data-access operations on your resources to help you monitor access and
configuration changes. You can query these logs in the Logs Explorer and
check which Google Workspace add-ons API methods generate Cloud Audit Logs.

For more information about Cloud Audit Logs,
see the following documents:

- [Types of audit logs](https://cloud.google.com/logging/docs/audit#types)
- [Audit log entry structure](https://cloud.google.com/logging/docs/audit#audit_log_entry_structure)
- [Storing and routing audit logs](https://cloud.google.com/logging/docs/audit#storing_and_routing_audit_logs)
- [Cloud Logging pricing summary](https://cloud.google.com/stackdriver/pricing#logs-pricing-summary)
- [Enable Data Access audit logs](https://cloud.google.com/logging/docs/audit/configure-data-access)

<br />

## Service name

To view the Google Workspace add-ons audit logs, do the following:

1. In the Google Cloud console, go to the Logs Explorer page:

   [Go to Logs Explorer](https://console.cloud.google.com/logs/query)
2. Copy and paste the following query into the **Query** field of the
   Logs Explorer, and then click **Run query**.

   ```
       protoPayload.serviceName="gsuiteaddons.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,
Google Workspace add-ons 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](https://cloud.google.com/logging/docs/audit#data-access) audit logs.

Methods that require an IAM permission with the `type` property value
of `ADMIN_WRITE` generate
[Admin Activity](https://cloud.google.com/logging/docs/audit#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](https://cloud.google.com/logging/docs/audit/understanding-audit-logs#lro).

| Permission type | Methods |
|---|---|
| `ADMIN_READ` | `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetAuthorization` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetChatAppConfig` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetDeployment` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetInstallStatus` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ListDeployments` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.UninstallDeployment` |
| `ADMIN_WRITE` | `google.cloud.gsuiteaddons.v1.GSuiteAddOns.CreateDeployment` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.DeleteDeployment` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.InstallDeployment` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ReplaceDeployment` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.UpdateChatAppConfig` |

## API interface audit logs

For information about how and which permissions are evaluated for each method,
see the Identity and Access Management documentation for Google Workspace add-ons.

### `google.cloud.gsuiteaddons.v1.GSuiteAddOns`

The following audit logs are associated with methods belonging to
`google.cloud.gsuiteaddons.v1.GSuiteAddOns`.

#### `CreateDeployment`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.CreateDeployment`  
- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity)  
- **Permissions** :
  - `gsuiteaddons.deployments.create - ADMIN_WRITE`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.CreateDeployment"
  `  

#### `DeleteDeployment`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.DeleteDeployment`  
- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity)  
- **Permissions** :
  - `gsuiteaddons.deployments.delete - ADMIN_WRITE`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.DeleteDeployment"
  `  

#### `GetAuthorization`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetAuthorization`  
- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access)  
- **Permissions** :
  - `gsuiteaddons.authorizations.get - ADMIN_READ`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetAuthorization"
  `  

#### `GetChatAppConfig`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetChatAppConfig`  
- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access)  
- **Permissions** :
  - `gsuiteaddons.chatAppConfigs.get - ADMIN_READ`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetChatAppConfig"
  `  

#### `GetDeployment`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetDeployment`  
- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access)  
- **Permissions** :
  - `gsuiteaddons.deployments.get - ADMIN_READ`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetDeployment"
  `  

#### `GetInstallStatus`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetInstallStatus`  
- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access)  
- **Permissions** :
  - `gsuiteaddons.deployments.installStatus - ADMIN_READ`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetInstallStatus"
  `  

#### `InstallDeployment`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.InstallDeployment`  
- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity)  
- **Permissions** :
  - `gsuiteaddons.deployments.install - ADMIN_WRITE`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.InstallDeployment"
  `  

#### `ListDeployments`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ListDeployments`  
- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access)  
- **Permissions** :
  - `gsuiteaddons.deployments.list - ADMIN_READ`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.ListDeployments"
  `  

#### `ReplaceDeployment`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ReplaceDeployment`  
- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity)  
- **Permissions** :
  - `gsuiteaddons.deployments.update - ADMIN_WRITE`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.ReplaceDeployment"
  `  

#### `UninstallDeployment`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.UninstallDeployment`  
- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access)  
- **Permissions** :
  - `gsuiteaddons.deployments.execute - ADMIN_READ`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.UninstallDeployment"
  `  

#### `UpdateChatAppConfig`

- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.UpdateChatAppConfig`  
- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity)  
- **Permissions** :
  - `gsuiteaddons.chatAppConfigs.update - ADMIN_WRITE`
- **Method is a long-running or streaming operation** : No.  
- **Filter for this method** : `
  protoPayload.methodName="google.cloud.gsuiteaddons.v1.GSuiteAddOns.UpdateChatAppConfig"
  `