How to show instruction with image after install google workspace extension?

Question

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? THIS IS WHAT I WANT.

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.

"addOns": {
    "common": {
      "name": "XCelsior AI: GPT for Sheets",
      "logoUrl": "https://your-logo-url.com/logo.png",
      "useLocaleFromApp": true,
      "homepageTrigger": {
        "runFunction": "showPostInstallTip"
      }
    },

Is this a editor addon or a workspace addon? If it is a workspace addon, why are menu items in "Extensions" menu? — TheMaster
– TheMaster, Commented Sep 30, 2024 at 10:08
@TheMaster I believe the second picture is from some other totally different add-on. I've got no experience in this, but isn't that the whole problem here? That what the OP wants to achieve can only be done with an Editor add-on, and not a Workspace one? — user27425627
– user27425627, Commented Oct 1, 2024 at 17:57

TheMaster · Accepted Answer · 2024-11-26 01:17:15Z

2

There are two types of addons:

Editor addons
Workspace addons

Editor addons usually work with creating menu items in Extensions menu > Add ons

Workspace addons, on the other hand, create a icon/button in the sidebar.

It seems a editor addon was created, but it was published as a workspace addon, giving you the interface instructions as shown in your screenshots. addOns key inside the manifest is used to configure a Workspace addon. Restructure your manifest to remove the addOns key and it's values and republish to the marketplace. If there are any specific marketplace settings, you may need to change that as well. Once marketplace recognises it as a editor addon, you should have the interface you're looking for.

As noted by no7dw in the comment below,

turn out it could be config on google cloud console-> enable APIs and service-> app configuration -> App integrations -> uncheck Google workspace add-on

edited Nov 26, 2024 at 1:17

answered Oct 5, 2024 at 2:15

TheMaster

51.6k7 gold badges76 silver badges102 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

no7dw Over a year ago

thx a lot, u saved my day indeed . turn out it could be config on google cloud console-> enable APIs and service-> app configuration -> App integrations -> uncheck Google workspace add-on.

TheMaster Over a year ago

@no7dw You're welcome.

Collectives™ on Stack Overflow

How to show instruction with image after install google workspace extension?

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related