Reference documentation and code samples for the Google Workspace Add-ons V1 API class Google::Apps::Script::Type::Gmail::UniversalAction.
An action that is always available in the add-on toolbar menu regardless of
message context.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#open_link
defopen_link()->::String
Returns
(::String) — A link that is opened by Gmail when the user triggers the action.
Note: The following fields are mutually exclusive: open_link, run_function. If a field in that set is populated, all other fields in the set will automatically be cleared.
#open_link=
defopen_link=(value)->::String
Parameter
value (::String) — A link that is opened by Gmail when the user triggers the action.
Note: The following fields are mutually exclusive: open_link, run_function. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — A link that is opened by Gmail when the user triggers the action.
Note: The following fields are mutually exclusive: open_link, run_function. If a field in that set is populated, all other fields in the set will automatically be cleared.
#run_function
defrun_function()->::String
Returns
(::String) — An endpoint that is called when the user triggers the
action. See the universal actions
guide for details.
Note: The following fields are mutually exclusive: run_function, open_link. If a field in that set is populated, all other fields in the set will automatically be cleared.
#run_function=
defrun_function=(value)->::String
Parameter
value (::String) — An endpoint that is called when the user triggers the
action. See the universal actions
guide for details.
Note: The following fields are mutually exclusive: run_function, open_link. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — An endpoint that is called when the user triggers the
action. See the universal actions
guide for details.
Note: The following fields are mutually exclusive: run_function, open_link. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text
deftext()->::String
Returns
(::String) — Required. User-visible text describing the action, for example, "Add a new
contact."
#text=
deftext=(value)->::String
Parameter
value (::String) — Required. User-visible text describing the action, for example, "Add a new
contact."
Returns
(::String) — Required. User-visible text describing the action, for example, "Add a new
contact."
[[["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::UniversalAction (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-UniversalAction)\n- [1.2.1](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.2.1/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [1.1.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.1.0/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [1.0.1](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/1.0.1/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [0.6.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.6.0/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [0.5.2](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.5.2/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [0.4.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.4.0/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [0.3.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.3.0/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [0.2.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.2.0/Google-Apps-Script-Type-Gmail-UniversalAction)\n- [0.1.0](/ruby/docs/reference/google-cloud-gsuite_add_ons-v1/0.1.0/Google-Apps-Script-Type-Gmail-UniversalAction) \nReference documentation and code samples for the Google Workspace Add-ons V1 API class Google::Apps::Script::Type::Gmail::UniversalAction.\n\nAn action that is always available in the add-on toolbar menu regardless of\nmessage context. \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### #open_link\n\n def open_link() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A link that is opened by Gmail when the user triggers the action.\n\n Note: The following fields are mutually exclusive: `open_link`, `run_function`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #open_link=\n\n def open_link=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A link that is opened by Gmail when the user triggers the action.\n\n\nNote: The following fields are mutually exclusive: `open_link`, `run_function`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A link that is opened by Gmail when the user triggers the action.\n\n Note: The following fields are mutually exclusive: `open_link`, `run_function`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #run_function\n\n def run_function() -\u003e ::String\n\n**Returns**\n\n- (::String) --- An endpoint that is called when the user triggers the action. See the [universal actions\n guide](/gmail/add-ons/how-tos/universal-actions) for details.\n\n\n Note: The following fields are mutually exclusive: `run_function`, `open_link`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #run_function=\n\n def run_function=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- An endpoint that is called when the user triggers the action. See the [universal actions\n guide](/gmail/add-ons/how-tos/universal-actions) for details.\n\n\nNote: The following fields are mutually exclusive: `run_function`, `open_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- An endpoint that is called when the user triggers the action. See the [universal actions\n guide](/gmail/add-ons/how-tos/universal-actions) for details.\n\n\n Note: The following fields are mutually exclusive: `run_function`, `open_link`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #text\n\n def text() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. User-visible text describing the action, for example, \"Add a new contact.\"\n\n### #text=\n\n def text=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. User-visible text describing the action, for example, \"Add a new contact.\" \n**Returns**\n\n- (::String) --- Required. User-visible text describing the action, for example, \"Add a new contact.\""]]
