What's the correct setup for appscript.json in a Google Sheets Add-On?

Other Questions Google Sheets
1

I’m having trouble getting my Google Sheets add-on approved for the Workspace Marketplace. The review team says it’s set up as a Workspace Add-On but it should be an Editor Add-On. I think the problem might be in my appscript.json file but I’m not sure.

Can someone help me figure out the right way to set up appscript.json for a Sheets Editor Add-On? Here’s what I have now:

{
  "timeZone": "America/New_York",
  "dependencies": {},
  "exceptionLogging": "CLOUD_LOGGING",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/spreadsheets.current",
    "https://www.googleapis.com/auth/script.external_call",
    "https://www.googleapis.com/auth/script.ui"
  ],
  "urlFetchAllowlist": [
     "https://mysite.com"
  ]
}

Is there something I need to change to make it work as an Editor Add-On? I’ve been stuck on this for a while and any help would be great. Thanks!

2

I’ve been through the add-on approval process a few times, and I can tell you it can be tricky. Your appscript.json is missing the key ‘addOns’ section that designates it as a Sheets Editor Add-On. Here’s what worked for me:

Add this to your existing JSON:

"addOns": {
  "common": {
    "name": "Your Add-on Name",
    "logoUrl": "https://your-logo-url.com/logo.png",
    "description": "A brief, compelling description"
  },
  "sheets": {}
}

Also, double-check your oauthScopes. Only include what’s absolutely necessary for your add-on to function. This can speed up the approval process.

One last tip: make sure your add-on’s functionality is clearly described in your store listing. This helps both users and the review team understand what your add-on does. Good luck with your submission!

3

hey sophia, looks like ur missing the ‘addOns’ section in ur json. try adding this:

"addOns": {
  "common": {
    "name": "Your Add-on Name",
    "logoUrl": "https://example.com/logo.png"
  },
  "sheets": {}
}

that should set it up as an editor add-on. good luck!

4

I’ve encountered similar issues when submitting add-ons. Your appscript.json is close, but it’s missing a crucial element for Editor Add-Ons. You need to include the ‘addOns’ section with a ‘sheets’ property. Here’s what you should add:

"addOns": {
  "common": {
    "name": "Your Add-on Name",
    "logoUrl": "https://your-logo-url.com/logo.png",
    "description": "Brief description of your add-on"
  },
  "sheets": {}
}

This explicitly tells Google that it’s a Sheets add-on. Also, ensure your oauthScopes are minimal and only include what’s necessary for your add-on’s functionality. This can help with the approval process. Good luck with your submission!