Sheets macro manifest resource

  • Sheets macros are defined using a manifest configuration, which must include all required fields.

  • Each macro definition specifies a keyboard shortcut, the name of the Apps Script function to execute, and the menu name displayed in the Google Sheets UI.

  • The keyboard shortcut must be unique and follow the format Ctrl+Alt+Shift+ followed by a single digit.

  • Macros without assigned shortcuts can only be run from the Tools > Macros menu in Google Sheets.

The configuration that is used to define Sheets macros. Manifests that define macros must have all the fields marked as Required.

Sheets

The top-level of the Sheets macro manifest configuration. This is only used to define Sheets macros.

JSON representation 
{
  "macros": [
    {
      object (Macro)
    }
  ]
}
Fields
macros[]

object (Macro)

Required. A list of defined macros and their associated properties.

Macro

The configuration for a single macro. The definition must have all the fields marked as Required.

JSON representation 
{
  "defaultShortcut": string,
  "functionName": string,
  "menuName": string
}
Fields
defaultShortcut

string

Defines the keyboard shortcut that executes the macro. This must be of the form Ctrl+Alt+Shift+Number, where Number is a single-digit. Macros without shortcuts can only be executed from the Tools > Macros menu.
functionName

string

Required. The name of the Apps Script function that executes the macro. By default this matches the menuName for functions automatically created, but this is not a requirement.
menuName

string

Required. The name of the macro as it appears in the Google Sheets UI.