Stay organized with collections
Save and categorize content based on your preferences.
This document describes audit logging for Google Workspace add-ons. 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:
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 audit logs.
Methods that require an IAM permission with the type property value
of ADMIN_WRITE generate
Admin Activity 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[[["\u003cp\u003eGoogle Workspace Add-ons generate audit logs that record administrative and access activities, categorized as either Data Access or Admin Activity based on the permission type required for the method call.\u003c/p\u003e\n"],["\u003cp\u003eAudit logs for Google Workspace Add-ons utilize the service name \u003ccode\u003egsuiteaddons.googleapis.com\u003c/code\u003e and can be filtered using \u003ccode\u003eprotoPayload.serviceName="gsuiteaddons.googleapis.com"\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eMethods requiring \u003ccode\u003eDATA_READ\u003c/code\u003e, \u003ccode\u003eDATA_WRITE\u003c/code\u003e, or \u003ccode\u003eADMIN_READ\u003c/code\u003e permissions generate Data Access audit logs, while those requiring \u003ccode\u003eADMIN_WRITE\u003c/code\u003e permissions generate Admin Activity audit logs.\u003c/p\u003e\n"],["\u003cp\u003eThis document provides a detailed breakdown of each method within \u003ccode\u003egoogle.cloud.gsuiteaddons.v1.GSuiteAddOns\u003c/code\u003e, specifying the audit log type, required permissions, and filtering criteria.\u003c/p\u003e\n"]]],["Google Workspace add-ons generate audit logs under the service name `gsuiteaddons.googleapis.com`. Log categories are determined by IAM permission types (`ADMIN_READ`, `ADMIN_WRITE`, `DATA_READ`, `DATA_WRITE`). `ADMIN_WRITE` permissions trigger Admin Activity logs, while `ADMIN_READ`, `DATA_READ`, and `DATA_WRITE` trigger Data Access logs. Specific methods like `CreateDeployment` and `DeleteDeployment` require `ADMIN_WRITE` permissions, generating Admin Activity logs. Methods such as `GetAuthorization` and `UninstallDeployment` need `ADMIN_READ` permissions and thus generate Data access logs. Filters are provided for each method.\n"],null,["This document describes audit logging for Google Workspace add-ons. Google Cloud services\ngenerate audit logs that record administrative and access activities within your Google Cloud resources.\nFor more information about Cloud Audit Logs, see the following:\n\n- [Types of audit logs](https://cloud.google.com/logging/docs/audit#types)\n- [Audit log entry structure](https://cloud.google.com/logging/docs/audit#audit_log_entry_structure)\n- [Storing and routing audit logs](https://cloud.google.com/logging/docs/audit#storing_and_routing_audit_logs)\n- [Cloud Logging pricing summary](https://cloud.google.com/stackdriver/pricing#logs-pricing-summary)\n- [Enable Data Access audit logs](https://cloud.google.com/logging/docs/audit/configure-data-access)\n\n\u003cbr /\u003e\n\nService name\n\nGoogle Workspace add-ons audit logs use the service name `gsuiteaddons.googleapis.com`.\nFilter for this service: \n\n```gdscript\n protoPayload.serviceName=\"gsuiteaddons.googleapis.com\"\n \n```\n\n\u003cbr /\u003e\n\nMethods by permission type\n\nEach IAM permission has a `type` property, whose value is an enum\nthat can be one of four values: `ADMIN_READ`, `ADMIN_WRITE`,\n`DATA_READ`, or `DATA_WRITE`. When you call a method,\nGoogle Workspace add-ons generates an audit log whose category is dependent on the\n`type` property of the permission required to perform the method.\n\nMethods that require an IAM permission with the `type` property value\nof `DATA_READ`, `DATA_WRITE`, or `ADMIN_READ` generate\n[Data Access](https://cloud.google.com/logging/docs/audit#data-access) audit logs.\n\nMethods that require an IAM permission with the `type` property value\nof `ADMIN_WRITE` generate\n[Admin Activity](https://cloud.google.com/logging/docs/audit#admin-activity) audit logs.\n\n| Permission type | Methods |\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ADMIN_READ` | `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetAuthorization` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetDeployment` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ListDeployments` `google.cloud.gsuiteaddons.v1.GSuiteAddOns.UninstallDeployment` |\n| `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` |\n\nAPI interface audit logs\n\nFor information about how and which permissions are evaluated for each method,\nsee the Identity and Access Management documentation for Google Workspace add-ons.\n\n`google.cloud.gsuiteaddons.v1.GSuiteAddOns`\n\nThe following audit logs are associated with methods belonging to\n`google.cloud.gsuiteaddons.v1.GSuiteAddOns`.\n\n`CreateDeployment`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.CreateDeployment` \n- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `gsuiteaddons.deployments.create - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.CreateDeployment\"\n ` \n\n`DeleteDeployment`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.DeleteDeployment` \n- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `gsuiteaddons.deployments.delete - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.DeleteDeployment\"\n ` \n\n`GetAuthorization`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetAuthorization` \n- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access) \n- **Permissions** :\n - `gsuiteaddons.authorizations.get - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetAuthorization\"\n ` \n\n`GetDeployment`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetDeployment` \n- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access) \n- **Permissions** :\n - `gsuiteaddons.deployments.get - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.GetDeployment\"\n ` \n\n`InstallDeployment`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.InstallDeployment` \n- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `gsuiteaddons.deployments.install - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.InstallDeployment\"\n ` \n\n`ListDeployments`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ListDeployments` \n- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access) \n- **Permissions** :\n - `gsuiteaddons.deployments.list - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.ListDeployments\"\n ` \n\n`ReplaceDeployment`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.ReplaceDeployment` \n- **Audit log type** : [Admin activity](https://cloud.google.com/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `gsuiteaddons.deployments.update - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.ReplaceDeployment\"\n ` \n\n`UninstallDeployment`\n\n- **Method** : `google.cloud.gsuiteaddons.v1.GSuiteAddOns.UninstallDeployment` \n- **Audit log type** : [Data access](https://cloud.google.com/logging/docs/audit#data-access) \n- **Permissions** :\n - `gsuiteaddons.deployments.execute - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.gsuiteaddons.v1.GSuiteAddOns.UninstallDeployment\"\n `"]]
