Google Workspace Add-ons V1 API - Class Google::Apps::Script::Type::Gmail::GmailAddOnManifest (v1.4.0)

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

def authorization_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=

def authorization_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.

#compose_trigger

def compose_trigger() -> ::Google::Apps::Script::Type::Gmail::ComposeTrigger
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.

#compose_trigger=

def compose_trigger=(value) -> ::Google::Apps::Script::Type::Gmail::ComposeTrigger
Parameter
  • 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.

#contextual_triggers

def contextual_triggers() -> ::Array<::Google::Apps::Script::Type::Gmail::ContextualTrigger>
Returns

#contextual_triggers=

def contextual_triggers=(value) -> ::Array<::Google::Apps::Script::Type::Gmail::ContextualTrigger>
Parameter
Returns

#homepage_trigger

def homepage_trigger() -> ::Google::Apps::Script::Type::HomepageExtensionPoint
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.

#homepage_trigger=

def homepage_trigger=(value) -> ::Google::Apps::Script::Type::HomepageExtensionPoint
Parameter
  • 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.

#universal_actions

def universal_actions() -> ::Array<::Google::Apps::Script::Type::Gmail::UniversalAction>
Returns

#universal_actions=

def universal_actions=(value) -> ::Array<::Google::Apps::Script::Type::Gmail::UniversalAction>
Parameter
Returns