Reference documentation and code samples for the Google Workspace Add-ons V1 API class Google::Apps::Script::Type::Gmail::GmailAddOnManifest.
Properties customizing the appearance and execution of a Gmail add-on.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#authorization_check_function
defauthorization_check_function()->::String
Returns
(::String) — The name of an endpoint that verifies that the add-on has
all the required third-party authorizations, by probing the third-party
APIs. If the probe fails, the function should throw an exception to
initiate the authorization flow. This function is called before each
invocation of the add-on, in order to ensure a smooth user experience.
#authorization_check_function=
defauthorization_check_function=(value)->::String
Parameter
value (::String) — The name of an endpoint that verifies that the add-on has
all the required third-party authorizations, by probing the third-party
APIs. If the probe fails, the function should throw an exception to
initiate the authorization flow. This function is called before each
invocation of the add-on, in order to ensure a smooth user experience.
Returns
(::String) — The name of an endpoint that verifies that the add-on has
all the required third-party authorizations, by probing the third-party
APIs. If the probe fails, the function should throw an exception to
initiate the authorization flow. This function is called before each
invocation of the add-on, in order to ensure a smooth user experience.
(::Google::Apps::Script::Type::Gmail::ComposeTrigger) — Defines the compose time trigger for a compose time add-on. This is the
trigger that causes an add-on to take action when the user is composing an
email.
All compose time addons are required to have the
gmail.addons.current.action.compose scope even though it might not edit the
draft.
value (::Google::Apps::Script::Type::Gmail::ComposeTrigger) — Defines the compose time trigger for a compose time add-on. This is the
trigger that causes an add-on to take action when the user is composing an
email.
All compose time addons are required to have the
gmail.addons.current.action.compose scope even though it might not edit the
draft.
Returns
(::Google::Apps::Script::Type::Gmail::ComposeTrigger) — Defines the compose time trigger for a compose time add-on. This is the
trigger that causes an add-on to take action when the user is composing an
email.
All compose time addons are required to have the
gmail.addons.current.action.compose scope even though it might not edit the
draft.
(::Google::Apps::Script::Type::HomepageExtensionPoint) — Defines an endpoint that will be executed in contexts that don't
match a declared contextual trigger. Any cards generated by this function
will always be available to the user, but may be eclipsed by contextual
content when this add-on declares more targeted triggers.
If present, this overrides the configuration from
addOns.common.homepageTrigger.
value (::Google::Apps::Script::Type::HomepageExtensionPoint) — Defines an endpoint that will be executed in contexts that don't
match a declared contextual trigger. Any cards generated by this function
will always be available to the user, but may be eclipsed by contextual
content when this add-on declares more targeted triggers.
If present, this overrides the configuration from
addOns.common.homepageTrigger.
Returns
(::Google::Apps::Script::Type::HomepageExtensionPoint) — Defines an endpoint that will be executed in contexts that don't
match a declared contextual trigger. Any cards generated by this function
will always be available to the user, but may be eclipsed by contextual
content when this add-on declares more targeted triggers.
If present, this overrides the configuration from
addOns.common.homepageTrigger.
[[["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 - Class Google::Apps::Script::Type::Gmail::GmailAddOnManifest (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-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [1.2.1](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.2.1/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [1.1.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.1.0/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [1.0.1](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.0.1/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [0.6.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.6.0/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [0.5.2](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.5.2/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [0.4.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.4.0/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [0.3.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.3.0/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [0.2.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.2.0/Google-Apps-Script-Type-Gmail-GmailAddOnManifest)\n- [0.1.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.1.0/Google-Apps-Script-Type-Gmail-GmailAddOnManifest) \nReference documentation and code samples for the Google Workspace Add-ons V1 API class Google::Apps::Script::Type::Gmail::GmailAddOnManifest.\n\nProperties customizing the appearance and execution of a Gmail add-on. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #authorization_check_function\n\n def authorization_check_function() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The name of an endpoint that verifies that the add-on has all the required third-party authorizations, by probing the third-party APIs. If the probe fails, the function should throw an exception to initiate the authorization flow. This function is called before each invocation of the add-on, in order to ensure a smooth user experience.\n\n### #authorization_check_function=\n\n def authorization_check_function=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The name of an endpoint that verifies that the add-on has all the required third-party authorizations, by probing the third-party APIs. If the probe fails, the function should throw an exception to initiate the authorization flow. This function is called before each invocation of the add-on, in order to ensure a smooth user experience. \n**Returns**\n\n- (::String) --- The name of an endpoint that verifies that the add-on has all the required third-party authorizations, by probing the third-party APIs. If the probe fails, the function should throw an exception to initiate the authorization flow. This function is called before each invocation of the add-on, in order to ensure a smooth user experience.\n\n### #compose_trigger\n\n def compose_trigger() -\u003e ::Google::Apps::Script::Type::Gmail::ComposeTrigger\n\n**Returns**\n\n- ([::Google::Apps::Script::Type::Gmail::ComposeTrigger](./Google-Apps-Script-Type-Gmail-ComposeTrigger)) --- Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time addons are required to have the gmail.addons.current.action.compose scope even though it might not edit the draft.\n\n### #compose_trigger=\n\n def compose_trigger=(value) -\u003e ::Google::Apps::Script::Type::Gmail::ComposeTrigger\n\n**Parameter**\n\n- **value** ([::Google::Apps::Script::Type::Gmail::ComposeTrigger](./Google-Apps-Script-Type-Gmail-ComposeTrigger)) --- Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time addons are required to have the gmail.addons.current.action.compose scope even though it might not edit the draft. \n**Returns**\n\n- ([::Google::Apps::Script::Type::Gmail::ComposeTrigger](./Google-Apps-Script-Type-Gmail-ComposeTrigger)) --- Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time addons are required to have the gmail.addons.current.action.compose scope even though it might not edit the draft.\n\n### #contextual_triggers\n\n def contextual_triggers() -\u003e ::Array\u003c::Google::Apps::Script::Type::Gmail::ContextualTrigger\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Apps::Script::Type::Gmail::ContextualTrigger](./Google-Apps-Script-Type-Gmail-ContextualTrigger)\\\u003e) --- Defines the set of conditions that trigger the add-on.\n\n### #contextual_triggers=\n\n def contextual_triggers=(value) -\u003e ::Array\u003c::Google::Apps::Script::Type::Gmail::ContextualTrigger\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Apps::Script::Type::Gmail::ContextualTrigger](./Google-Apps-Script-Type-Gmail-ContextualTrigger)\\\u003e) --- Defines the set of conditions that trigger the add-on. \n**Returns**\n\n- (::Array\\\u003c[::Google::Apps::Script::Type::Gmail::ContextualTrigger](./Google-Apps-Script-Type-Gmail-ContextualTrigger)\\\u003e) --- Defines the set of conditions that trigger the add-on.\n\n### #homepage_trigger\n\n def homepage_trigger() -\u003e ::Google::Apps::Script::Type::HomepageExtensionPoint\n\n**Returns**\n\n- ([::Google::Apps::Script::Type::HomepageExtensionPoint](./Google-Apps-Script-Type-HomepageExtensionPoint)) --- Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.\n\n\n If present, this overrides the configuration from\n `addOns.common.homepageTrigger`.\n\n### #homepage_trigger=\n\n def homepage_trigger=(value) -\u003e ::Google::Apps::Script::Type::HomepageExtensionPoint\n\n**Parameter**\n\n- **value** ([::Google::Apps::Script::Type::HomepageExtensionPoint](./Google-Apps-Script-Type-HomepageExtensionPoint)) --- Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.\n\n\n If present, this overrides the configuration from\n`addOns.common.homepageTrigger`. \n**Returns**\n\n- ([::Google::Apps::Script::Type::HomepageExtensionPoint](./Google-Apps-Script-Type-HomepageExtensionPoint)) --- Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.\n\n\n If present, this overrides the configuration from\n `addOns.common.homepageTrigger`.\n\n### #universal_actions\n\n def universal_actions() -\u003e ::Array\u003c::Google::Apps::Script::Type::Gmail::UniversalAction\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Apps::Script::Type::Gmail::UniversalAction](./Google-Apps-Script-Type-Gmail-UniversalAction)\\\u003e) --- Defines set of [universal\n actions](/gmail/add-ons/how-tos/universal-actions) for the add-on. The user triggers universal actions from the add-on toolbar menu.\n\n### #universal_actions=\n\n def universal_actions=(value) -\u003e ::Array\u003c::Google::Apps::Script::Type::Gmail::UniversalAction\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Apps::Script::Type::Gmail::UniversalAction](./Google-Apps-Script-Type-Gmail-UniversalAction)\\\u003e) --- Defines set of [universal\nactions](/gmail/add-ons/how-tos/universal-actions) for the add-on. The user triggers universal actions from the add-on toolbar menu. \n**Returns**\n\n- (::Array\\\u003c[::Google::Apps::Script::Type::Gmail::UniversalAction](./Google-Apps-Script-Type-Gmail-UniversalAction)\\\u003e) --- Defines set of [universal\n actions](/gmail/add-ons/how-tos/universal-actions) for the add-on. The user triggers universal actions from the add-on toolbar menu."]]