Reference documentation and code samples for the Google Workspace Add-ons V1 API module Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns.
A service for managing Google Workspace add-ons deployments.
A Google Workspace add-on is a third-party embedded component that can be
installed in Google Workspace Applications like Gmail, Calendar, Drive, and
the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
display UI cards, receive contextual information from the host application,
and perform actions in the host application (See:
https://developers.google.com/gsuite/add-ons/overview for more information).
A Google Workspace add-on deployment can be installed in developer mode,
which allows an add-on developer to test the experience an end-user would see
when installing and running the add-on in their G Suite applications. When
running in developer mode, more detailed error messages are exposed in the
add-on UI to aid in debugging.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Workspace Add-ons V1 API - Module Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/latest/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [1.2.1](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.2.1/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [1.1.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.1.0/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [1.0.1](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.0.1/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [0.6.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.6.0/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [0.5.2](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.5.2/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [0.4.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.4.0/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [0.3.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.3.0/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [0.2.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.2.0/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns)\n- [0.1.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.1.0/Google-Cloud-GSuiteAddOns-V1-GSuiteAddOns) \nReference documentation and code samples for the Google Workspace Add-ons V1 API module Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns.\n\nA service for managing Google Workspace add-ons deployments.\n\nA Google Workspace add-on is a third-party embedded component that can be\ninstalled in Google Workspace Applications like Gmail, Calendar, Drive, and\nthe Google Docs, Sheets, and Slides editors. Google Workspace add-ons can\ndisplay UI cards, receive contextual information from the host application,\nand perform actions in the host application (See:\n\u003chttps://developers.google.com/gsuite/add-ons/overview\u003e for more information).\n\nA Google Workspace add-on deployment resource specifies metadata about the\nadd-on, including a specification of the entry points in the host application\nthat trigger add-on executions (see:\n\u003chttps://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests\u003e).\nAdd-on deployments defined via the Google Workspace add-ons API define their\nentrypoints using HTTPS URLs (See:\n\u003chttps://developers.google.com/gsuite/add-ons/guides/alternate-runtimes\u003e),\n\nA Google Workspace add-on deployment can be installed in developer mode,\nwhich allows an add-on developer to test the experience an end-user would see\nwhen installing and running the add-on in their G Suite applications. When\nrunning in developer mode, more detailed error messages are exposed in the\nadd-on UI to aid in debugging.\n\nA Google Workspace add-on deployment can be published to Google Workspace\nMarketplace, which allows other Google Workspace users to discover and\ninstall the add-on. See:\n\u003chttps://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview\u003e\nfor details.\n\nTo load this service and instantiate a REST client: \n\n require \"google/cloud/gsuite_add_ons/v1/gsuite_add_ons/rest\"\n client = ::Google::Cloud::GSuiteAddOns::V1::GSuiteAddOns::Rest::Client.new"]]