how to show instruction with image after install google workspace extension

18 views
Skip to first unread message

Wade D

unread,
Oct 2, 2024, 1:58:04 AMOct 2
to Google Apps Script Community

We've published our Google Sheets add-on, but new users often don't know how to access the extension after installing it. Currently, this is what we show by default, but I'm not sure how to change it.

enter image description here

I've noticed that some add-ons include an image with instructions like this one. How can I achieve that?

enter image description here

Thanks!

Relevant docs:

Gemini suggested a possible solution, but it conflicts with the manifect structure. Adding onInstallation to appsscript.json

{
  "manifestVersion": 2,
  "name": "My Addon",
  "description": "A sample addon that displays a custom message on installation.",
  "developerMetadata": {
    "supportsDomainWideInstallation": false
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/spreadsheets"
  ],
  "iconUrl": "https://www.example.com/icon.png",
  "onInstallation": {
    "type": "message",
    "message": "Thank you for installing My Addon!\n\nTo get started, follow these steps:\n1. Click on the addon icon in your Sheets sidebar.\n2. Select the 'Instructions' tab.\n3. Follow the instructions on the page.",
    "image": {
      "url": "https://www.example.com/instructions.png"
    }
  }
}

results in an error: "Invalid manifest, unknown fields: homepageUrl, onInstallation."

another option by LLM, added to manifest.json which is not the case i want. IT SHOW ON THE RIGHT HANDSIDE OF THE TOOLBAR. I WANNA ITSHOW ON THE EXTENSION MENU , AND SHOW A PICTURE AFTER INSTALLED JUST LIKE PICTURE 2.

{
  "timeZone": "America/New_York",
  "dependencies": {},
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "addOns": {
    "common": {
      "name": "XCelsior AI: GPT for Sheets",
      "logoUrl": "https://your-logo-url.com/logo.png",
      "useLocaleFromApp": true,
      "homepageTrigger": {
        "runFunction": "showPostInstallTip"
      }
    },
    "sheets": {}
  }
}

Ed Robinson

unread,
Oct 2, 2024, 9:03:37 AMOct 2
to Google Apps Script Community
Hi Wade,
I'm sure someone in the community can help. Can you share the name of any other add-ons that shows exactly the functionality you're looking to include? 

Ed

Reply all
Reply to author
Forward
0 new messages