REST Resource: projects.deployments | Google Workspace Add-ons

<!doctype html> <html lang="en" dir="ltr"> <head> <meta name="google-signin-client-id" content="721724668570-nbkv1cfusk7kk4eni4pjvepaus73b13t.apps.googleusercontent.com"> <meta name="google-signin-scope" content="profile email https://www.googleapis.com/auth/developerprofiles https://www.googleapis.com/auth/developerprofiles.award"> <meta property="og:site_name" content="Google for Developers"> <meta property="og:type" content="website"><meta name="theme-color" content="#fff"><meta charset="utf-8"> <meta content="IE=Edge" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="manifest" href="/_pwa/developers/manifest.json" crossorigin="use-credentials"> <link rel="preconnect" href="//www.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.googleapis.com" crossorigin> <link rel="preconnect" href="//apis.google.com" crossorigin> <link rel="preconnect" href="//www.google-analytics.com" crossorigin><link rel="stylesheet" href="//fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"> <link rel="stylesheet" href="//fonts.googleapis.com/css2?family=Material+Icons&family=Material+Symbols+Outlined&display=block"><link rel="stylesheet" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/css/app.css"> <link rel="shortcut icon" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/favicon-new.png"> <link rel="apple-touch-icon" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/touchicon-180-new.png"><link rel="canonical" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments"><link rel="search" type="application/opensearchdescription+xml" title="Google for Developers" href="https://developers.google.com/s/opensearch.xml"> <link rel="alternate" hreflang="en" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments" /><link rel="alternate" hreflang="x-default" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments" /><link rel="alternate" hreflang="ar" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=ar" /><link rel="alternate" hreflang="bn" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=bn" /><link rel="alternate" hreflang="zh-Hans" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=zh-cn" /><link rel="alternate" hreflang="zh-Hant" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=zh-tw" /><link rel="alternate" hreflang="fa" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=fa" /><link rel="alternate" hreflang="fr" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=fr" /><link rel="alternate" hreflang="de" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=de" /><link rel="alternate" hreflang="he" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=he" /><link rel="alternate" hreflang="hi" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=hi" /><link rel="alternate" hreflang="id" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=id" /><link rel="alternate" hreflang="it" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=it" /><link rel="alternate" hreflang="ja" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=ja" /><link rel="alternate" hreflang="ko" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=ko" /><link rel="alternate" hreflang="pl" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=pl" /><link rel="alternate" hreflang="pt-BR" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=pt-br" /><link rel="alternate" hreflang="ru" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=ru" /><link rel="alternate" hreflang="es-419" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=es-419" /><link rel="alternate" hreflang="th" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=th" /><link rel="alternate" hreflang="tr" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=tr" /><link rel="alternate" hreflang="vi" href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments?hl=vi" /><title>REST Resource: projects.deployments  |  Google Workspace Add-ons  |  Google for Developers</title> <meta property="og:title" content="REST Resource: projects.deployments  |  Google Workspace Add-ons  |  Google for Developers"><meta property="og:url" content="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments"><meta property="og:image" content="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/opengraph/white.png"> <meta property="og:image:width" content="1200"> <meta property="og:image:height" content="675"><meta property="og:locale" content="en"><meta name="twitter:card" content="summary_large_image"><script type="application/ld+json"> { "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "Google Workspace", "item": "https://developers.google.com/workspace" },{ "@type": "ListItem", "position": 2, "name": "Add-ons", "item": "https://developers.google.com/workspace/add-ons/overview" },{ "@type": "ListItem", "position": 3, "name": "REST Resource: projects.deployments", "item": "https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments" }] } </script> <link rel="stylesheet" href="/extras.css"></head> <body class="docs" template="page" theme="white" type="reference" itemscope itemtype="http://developers.google.com/ReferenceObject" layout="docs" concierge='closed' display-toc pending> <devsite-progress type="indeterminate" id="app-progress"></devsite-progress> <section class="devsite-wrapper"> <devsite-cookie-notification-bar></devsite-cookie-notification-bar><devsite-header role="banner"> <div class="devsite-header--inner nocontent"> <div class="devsite-top-logo-row-wrapper-wrapper"> <div class="devsite-top-logo-row-wrapper"> <div class="devsite-top-logo-row"> <button type="button" id="devsite-hamburger-menu" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Navigation menu button" visually-hidden aria-label="Open menu"> </button> <div class="devsite-product-name-wrapper"> <a href="https://developers.google.com/workspace"> <div class="devsite-product-logo-container" size="medium" > <picture> <img class="devsite-product-logo" alt="Google Workspace" src="https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" srcset=" https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" sizes="64px" loading="lazy" > </picture> </div> </a> <span class="devsite-product-name"> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item devsite-has-google-wordmark"> <a href="https://developers.google.com/workspace" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="Google Workspace" > <svg class="devsite-google-wordmark" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 148 48"> <title>Google</title> <path class="devsite-google-wordmark-svg-path" d="M19.58,37.65c-9.87,0-18.17-8.04-18.17-17.91c0-9.87,8.3-17.91,18.17-17.91c5.46,0,9.35,2.14,12.27,4.94l-3.45,3.45c-2.1-1.97-4.93-3.49-8.82-3.49c-7.21,0-12.84,5.81-12.84,13.02c0,7.21,5.64,13.02,12.84,13.02c4.67,0,7.34-1.88,9.04-3.58c1.4-1.4,2.32-3.41,2.66-6.16H19.58v-4.89h16.47c0.18,0.87,0.26,1.92,0.26,3.06c0,3.67-1.01,8.21-4.24,11.44C28.93,35.9,24.91,37.65,19.58,37.65z M61.78,26.12c0,6.64-5.1,11.53-11.36,11.53s-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53S61.78,19.43,61.78,26.12z M56.8,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C53.84,33.11,56.8,30.22,56.8,26.12z M87.25,26.12c0,6.64-5.1,11.53-11.36,11.53c-6.26,0-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53C82.15,14.59,87.25,19.43,87.25,26.12zM82.28,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C79.32,33.11,82.28,30.22,82.28,26.12z M112.09,15.29v20.7c0,8.52-5.02,12.01-10.96,12.01c-5.59,0-8.95-3.76-10.22-6.81l4.41-1.83c0.79,1.88,2.71,4.1,5.81,4.1c3.8,0,6.16-2.36,6.16-6.77v-1.66h-0.18c-1.14,1.4-3.32,2.62-6.07,2.62c-5.76,0-11.05-5.02-11.05-11.49c0-6.51,5.28-11.57,11.05-11.57c2.75,0,4.93,1.22,6.07,2.58h0.18v-1.88H112.09z M107.64,26.16c0-4.06-2.71-7.03-6.16-7.03c-3.49,0-6.42,2.97-6.42,7.03c0,4.02,2.93,6.94,6.42,6.94C104.93,33.11,107.64,30.18,107.64,26.16z M120.97,3.06v33.89h-5.07V3.06H120.97z M140.89,29.92l3.93,2.62c-1.27,1.88-4.32,5.11-9.61,5.11c-6.55,0-11.28-5.07-11.28-11.53c0-6.86,4.77-11.53,10.71-11.53c5.98,0,8.91,4.76,9.87,7.34l0.52,1.31l-15.42,6.38c1.18,2.31,3.01,3.49,5.59,3.49C137.79,33.11,139.58,31.84,140.89,29.92zM128.79,25.77l10.31-4.28c-0.57-1.44-2.27-2.45-4.28-2.45C132.24,19.04,128.66,21.31,128.79,25.77z"/> </svg>Workspace </a> </li> </ul> </span> </div> <div class="devsite-top-logo-row-middle"> <div class="devsite-header-upper-tabs"> <devsite-tabs class="upper-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Upper tabs"> <tab > <a href="https://developers.google.com/workspace" track-metadata-eventdetail="https://developers.google.com/workspace" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - home" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Home" track-name="home" > Home </a> </tab> <tab class="devsite-active"> <a href="https://developers.google.com/workspace/add-ons" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - add-ons" track-metadata-module="primary nav" aria-label="Add-ons, selected" data-category="Site-Wide Custom Events" data-label="Tab: Add-ons" track-name="add-ons" > Add-ons </a> </tab> <tab class="devsite-dropdown "> <a href="https://developers.google.com/workspace/products-menu" track-metadata-eventdetail="https://developers.google.com/workspace/products-menu" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - all products" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" > All products </a> <a href="#" role="button" aria-haspopup="true" aria-expanded="false" aria-label="Dropdown menu for All products" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/products-menu" track-metadata-position="nav - all products" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" class="devsite-tabs-dropdown-toggle devsite-icon devsite-icon-arrow-drop-down"></a> <div class="devsite-tabs-dropdown" aria-label="submenu" hidden> <div class="devsite-tabs-dropdown-content"> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Google Workspace apps</li> <li class="devsite-nav-item"> <a href="https://developers.google.com/admin-sdk" track-type="nav" track-metadata-eventdetail="https://developers.google.com/admin-sdk" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Admin console" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Admin console </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/cloud-search" track-type="nav" track-metadata-eventdetail="https://developers.google.com/cloud-search" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Cloud Search" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Cloud Search </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/gmail" track-type="nav" track-metadata-eventdetail="https://developers.google.com/gmail" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Gmail" > <div class="devsite-nav-item-title"> Gmail </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/calendar" track-type="nav" track-metadata-eventdetail="https://developers.google.com/calendar" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Calendar" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Calendar </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/chat" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/chat" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Chat" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Chat </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/classroom" track-type="nav" track-metadata-eventdetail="https://developers.google.com/classroom" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Google Classroom" > <div class="devsite-nav-item-title"> Google Classroom </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/docs" track-type="nav" track-metadata-eventdetail="https://developers.google.com/docs" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Docs" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Docs </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/drive" track-type="nav" track-metadata-eventdetail="https://developers.google.com/drive" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="google workspace apps" tooltip data-label="Tab menu: All products - Google Drive" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Drive </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/forms" track-type="nav" track-metadata-eventdetail="https://developers.google.com/forms" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Forms" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Forms </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/keep" track-type="nav" track-metadata-eventdetail="https://developers.google.com/keep" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Keep" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Keep </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/meet" track-type="nav" track-metadata-eventdetail="https://developers.google.com/meet" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Meet" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Meet </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/sheets" track-type="nav" track-metadata-eventdetail="https://developers.google.com/sheets" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Google Sheets" > <div class="devsite-nav-item-title"> Google Sheets </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/sites" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/sites" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Sites" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Sites </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/slides" track-type="nav" track-metadata-eventdetail="https://developers.google.com/slides" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Slides" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Slides </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/tasks" track-type="nav" track-metadata-eventdetail="https://developers.google.com/tasks" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Google Tasks" > <div class="devsite-nav-item-title"> Google Tasks </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/vault" track-type="nav" track-metadata-eventdetail="https://developers.google.com/vault" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline=" " tooltip data-label="Tab menu: All products - Google Vault" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Google Vault </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Extend, automate & share</li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/add-ons" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: All products - Add-ons" > <div class="devsite-nav-item-title"> Add-ons </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/apps-script" track-type="nav" track-metadata-eventdetail="https://developers.google.com/apps-script" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Apps Script" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Apps Script </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/chat/overview" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/chat/overview" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Chat apps" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Chat apps </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/drive/api/guides/about-apps" track-type="nav" track-metadata-eventdetail="https://developers.google.com/drive/api/guides/about-apps" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Drive apps" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Drive apps </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/marketplace" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/marketplace" track-metadata-position="nav - all products" track-metadata-module="tertiary nav" track-metadata-module_headline="extend, automate & share" tooltip data-label="Tab menu: All products - Marketplace" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Marketplace </div> </a> </li> </ul> </div> </div> </div> </tab> <tab class="devsite-dropdown "> <a href="https://developers.google.com/workspace/resources-menu" track-metadata-eventdetail="https://developers.google.com/workspace/resources-menu" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - resources" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" > Resources </a> <a href="#" role="button" aria-haspopup="true" aria-expanded="false" aria-label="Dropdown menu for Resources" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/resources-menu" track-metadata-position="nav - resources" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" class="devsite-tabs-dropdown-toggle devsite-icon devsite-icon-arrow-drop-down"></a> <div class="devsite-tabs-dropdown" aria-label="submenu" hidden> <div class="devsite-tabs-dropdown-content"> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Tools</li> <li class="devsite-nav-item"> <a href="https://admin.google.com/" track-type="nav" track-metadata-eventdetail="https://admin.google.com/" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-category="Workspace top menu navigation" target="admin-console" data-label="Tab menu: Resources - Admin console" > <div class="devsite-nav-item-title"> Admin console </div> </a> </li> <li class="devsite-nav-item"> <a href="https://script.google.com/" track-type="nav" track-metadata-eventdetail="https://script.google.com/" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip target="_blank" data-label="Tab menu: Resources - Apps Script dashboard" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Apps Script dashboard </div> </a> </li> <li class="devsite-nav-item"> <a href="https://console.cloud.google.com/workspace-api" track-type="nav" track-metadata-eventdetail="https://console.cloud.google.com/workspace-api" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: Resources - Google Cloud console" target="console" > <div class="devsite-nav-item-title"> Google Cloud console </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/explore" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/explore" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-label="Tab menu: Resources - APIs Explorer" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> APIs Explorer </div> </a> </li> <li class="devsite-nav-item"> <a href="https://addons.gsuite.google.com/uikit/builder" track-type="nav" track-metadata-eventdetail="https://addons.gsuite.google.com/uikit/builder" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="tools" tooltip data-label="Tab menu: Resources - Card Builder" target="_blank" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Card Builder </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Training & support</li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/guides/get-started" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/guides/get-started" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="training & support" tooltip data-category="Workspace top menu navigation" data-label="Tab menu: Resources - How to get started" > <div class="devsite-nav-item-title"> How to get started </div> </a> </li> <li class="devsite-nav-item"> <a href="https://codelabs.developers.google.com/?product=googleworkspace" track-type="nav" track-metadata-eventdetail="https://codelabs.developers.google.com/?product=googleworkspace" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="training & support" tooltip target="_blank" data-category="Workspace top menu navigation" data-label="Tab menu: Resources - Codelabs" > <div class="devsite-nav-item-title"> Codelabs </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/support" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/support" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="training & support" tooltip data-label="Tab menu: Resources - Developer support" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Developer support </div> </a> </li> </ul> </div> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-title" role="heading" tooltip>Updates</li> <li class="devsite-nav-item"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" track-type="nav" track-metadata-eventdetail="https://developers.googleblog.com/search/?query=Google+Workspace" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-category="Workspace top menu navigation" target="_blank" data-label="Tab menu: Resources - Blog" > <div class="devsite-nav-item-title"> Blog </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/preview" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/preview" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-label="Tab menu: Resources - Developer previews" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Developer Previews </div> </a> </li> <li class="devsite-nav-item"> <a href="https://developers.google.com/workspace/newsletters" track-type="nav" track-metadata-eventdetail="https://developers.google.com/workspace/newsletters" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-label="Tab menu: Resources - Newsletter" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> Newsletter </div> </a> </li> <li class="devsite-nav-item"> <a href="https://twitter.com/workspacedevs" track-type="nav" track-metadata-eventdetail="https://twitter.com/workspacedevs" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-label="Tab menu: Resources - X (Twitter)" target="_blank" data-category="Workspace top menu navigation" > <div class="devsite-nav-item-title"> X (Twitter) </div> </a> </li> <li class="devsite-nav-item"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" track-type="nav" track-metadata-eventdetail="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" track-metadata-position="nav - resources" track-metadata-module="tertiary nav" track-metadata-module_headline="updates" tooltip data-category="Workspace top menu navigation" target="_blank" data-label="Tab menu: Resources - YouTube" > <div class="devsite-nav-item-title"> YouTube </div> </a> </li> </ul> </div> </div> </div> </tab> </nav> </devsite-tabs> </div> <devsite-search enable-signin enable-search enable-suggestions enable-query-completion project-name="Google Workspace Add-ons" tenant-name="Google for Developers" project-scope="/workspace/add-ons/overview" url-scoped="https://developers.google.com/s/results/workspace/add-ons/overview" > <form class="devsite-search-form" action="https://developers.google.com/s/results" method="GET"> <div class="devsite-search-container"> <button type="button" search-open class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Open search"></button> <div class="devsite-searchbox"> <input aria-activedescendant="" aria-autocomplete="list" aria-label="Search" aria-expanded="false" aria-haspopup="listbox" autocomplete="off" class="devsite-search-field devsite-search-query" name="q" placeholder="Search" role="combobox" type="text" value="" > <div class="devsite-search-image material-icons" aria-hidden="true"> </div> <div class="devsite-search-shortcut-icon-container" aria-hidden="true"> <kbd class="devsite-search-shortcut-icon">/</kbd> </div> </div> </div> </form> <button type="button" search-close class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Close search"></button> </devsite-search> </div> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es" >Español</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> <devsite-user enable-profiles fp-auth id="devsite-user"> <span class="button devsite-top-button" aria-hidden="true" visually-hidden>Sign in</span> </devsite-user> </div> </div> </div> <div class="devsite-collapsible-section "> <div class="devsite-header-background"> <div class="devsite-product-id-row" > <div class="devsite-product-description-row"> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/workspace/add-ons/overview" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Lower Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="Google Workspace Add-ons" > Add-ons </a> </li> </ul> </div> </div> <div class="devsite-doc-set-nav-row"> <devsite-tabs class="lower-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Lower tabs"> <tab > <a href="https://developers.google.com/workspace/add-ons" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - overview" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Overview" track-name="overview" > Overview </a> </tab> <tab > <a href="https://developers.google.com/workspace/add-ons/overview" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons/overview" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - guides" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Guides" track-name="guides" > Guides </a> </tab> <tab class="devsite-active"> <a href="https://developers.google.com/workspace/add-ons/reference" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons/reference" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - reference" track-metadata-module="primary nav" aria-label="Reference, selected" data-category="Site-Wide Custom Events" data-label="Tab: Reference" track-name="reference" > Reference </a> </tab> <tab > <a href="https://developers.google.com/workspace/add-ons/samples" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons/samples" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - samples" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Samples" track-name="samples" > Samples </a> </tab> <tab > <a href="https://developers.google.com/workspace/add-ons/workspace-support" track-metadata-eventdetail="https://developers.google.com/workspace/add-ons/workspace-support" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - support" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Support" track-name="support" > Support </a> </tab> </nav> </devsite-tabs> </div> </div> </div> </div> </devsite-header> <devsite-book-nav scrollbars > <div class="devsite-book-nav-filter" > <span class="filter-list-icon material-icons" aria-hidden="true"></span> <input type="text" placeholder="Filter" aria-label="Type to filter" role="searchbox"> <span class="filter-clear-button hidden" data-title="Clear filter" aria-label="Clear filter" role="button" tabindex="0"></span> </div> <nav class="devsite-book-nav devsite-nav nocontent" aria-label="Side menu"> <div class="devsite-mobile-header"> <button type="button" id="devsite-close-nav" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Close navigation" aria-label="Close navigation"> </button> <div class="devsite-product-name-wrapper"> <a href="https://developers.google.com/workspace"> <div class="devsite-product-logo-container" size="medium" > <picture> <img class="devsite-product-logo" alt="Google Workspace" src="https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" srcset=" https://fonts.gstatic.com/s/i/productlogos/googleg/v6/16px.svg" sizes="64px" loading="lazy" > </picture> </div> </a> <span class="devsite-product-name"> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item devsite-has-google-wordmark"> <a href="https://developers.google.com/workspace" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="Google Workspace" > <svg class="devsite-google-wordmark" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 148 48"> <title>Google</title> <path class="devsite-google-wordmark-svg-path" d="M19.58,37.65c-9.87,0-18.17-8.04-18.17-17.91c0-9.87,8.3-17.91,18.17-17.91c5.46,0,9.35,2.14,12.27,4.94l-3.45,3.45c-2.1-1.97-4.93-3.49-8.82-3.49c-7.21,0-12.84,5.81-12.84,13.02c0,7.21,5.64,13.02,12.84,13.02c4.67,0,7.34-1.88,9.04-3.58c1.4-1.4,2.32-3.41,2.66-6.16H19.58v-4.89h16.47c0.18,0.87,0.26,1.92,0.26,3.06c0,3.67-1.01,8.21-4.24,11.44C28.93,35.9,24.91,37.65,19.58,37.65z M61.78,26.12c0,6.64-5.1,11.53-11.36,11.53s-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53S61.78,19.43,61.78,26.12z M56.8,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C53.84,33.11,56.8,30.22,56.8,26.12z M87.25,26.12c0,6.64-5.1,11.53-11.36,11.53c-6.26,0-11.36-4.89-11.36-11.53c0-6.68,5.1-11.53,11.36-11.53C82.15,14.59,87.25,19.43,87.25,26.12zM82.28,26.12c0-4.15-2.96-6.99-6.39-6.99c-3.43,0-6.39,2.84-6.39,6.99c0,4.11,2.96,6.99,6.39,6.99C79.32,33.11,82.28,30.22,82.28,26.12z M112.09,15.29v20.7c0,8.52-5.02,12.01-10.96,12.01c-5.59,0-8.95-3.76-10.22-6.81l4.41-1.83c0.79,1.88,2.71,4.1,5.81,4.1c3.8,0,6.16-2.36,6.16-6.77v-1.66h-0.18c-1.14,1.4-3.32,2.62-6.07,2.62c-5.76,0-11.05-5.02-11.05-11.49c0-6.51,5.28-11.57,11.05-11.57c2.75,0,4.93,1.22,6.07,2.58h0.18v-1.88H112.09z M107.64,26.16c0-4.06-2.71-7.03-6.16-7.03c-3.49,0-6.42,2.97-6.42,7.03c0,4.02,2.93,6.94,6.42,6.94C104.93,33.11,107.64,30.18,107.64,26.16z M120.97,3.06v33.89h-5.07V3.06H120.97z M140.89,29.92l3.93,2.62c-1.27,1.88-4.32,5.11-9.61,5.11c-6.55,0-11.28-5.07-11.28-11.53c0-6.86,4.77-11.53,10.71-11.53c5.98,0,8.91,4.76,9.87,7.34l0.52,1.31l-15.42,6.38c1.18,2.31,3.01,3.49,5.59,3.49C137.79,33.11,139.58,31.84,140.89,29.92zM128.79,25.77l10.31-4.28c-0.57-1.44-2.27-2.45-4.28-2.45C132.24,19.04,128.66,21.31,128.79,25.77z"/> </svg>Workspace </a> </li> </ul> </span> </div> </div> <div class="devsite-book-nav-wrapper"> <div class="devsite-mobile-nav-top"> <ul class="devsite-nav-list"> <li class="devsite-nav-item"> <a href="/workspace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Home" track-name="home" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Home" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Home </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons" class="devsite-nav-title gc-analytics-event devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: Add-ons" track-name="add-ons" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Add-ons" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Add-ons </span> </a> <ul class="devsite-nav-responsive-tabs"> <li class="devsite-nav-item"> <a href="/workspace/add-ons" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Overview" track-name="overview" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Overview" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Overview </span> <span class="devsite-nav-icon material-icons" data-icon="forward" > </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons/overview" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Guides" track-name="guides" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Guides" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Guides </span> <span class="devsite-nav-icon material-icons" data-icon="forward" > </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons/reference" class="devsite-nav-title gc-analytics-event devsite-nav-has-children devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: Reference" track-name="reference" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Reference" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip menu="_book"> Reference </span> <span class="devsite-nav-icon material-icons" data-icon="forward" menu="_book"> </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons/samples" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Samples" track-name="samples" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Samples" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Samples </span> <span class="devsite-nav-icon material-icons" data-icon="forward" > </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons/workspace-support" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Support" track-name="support" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Support" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Support </span> <span class="devsite-nav-icon material-icons" data-icon="forward" > </span> </a> </li> </ul> </li> <li class="devsite-nav-item"> <a href="/workspace/products-menu" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" data-category="Site-Wide Custom Events" data-label="Responsive Tab: All products" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > All products </span> </a> <ul class="devsite-nav-responsive-tabs devsite-nav-has-menu "> <li class="devsite-nav-item"> <span class="devsite-nav-title" tooltip data-category="Site-Wide Custom Events" data-label="Tab: All products" track-name="all products" > <span class="devsite-nav-text" tooltip menu="All products"> More </span> <span class="devsite-nav-icon material-icons" data-icon="forward" menu="All products"> </span> </span> </li> </ul> </li> <li class="devsite-nav-item"> <a href="/workspace/resources-menu" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Resources" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Resources </span> </a> <ul class="devsite-nav-responsive-tabs devsite-nav-has-menu "> <li class="devsite-nav-item"> <span class="devsite-nav-title" tooltip data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" > <span class="devsite-nav-text" tooltip menu="Resources"> More </span> <span class="devsite-nav-icon material-icons" data-icon="forward" menu="Resources"> </span> </span> </li> </ul> </li> </ul> </div> <div class="devsite-mobile-nav-bottom"> <ul class="devsite-nav-list" menu="_book"> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference" ><span class="devsite-nav-text" tooltip>Overview</span></a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> <span class="devsite-nav-text" tooltip>REST Resources</span> </div></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest" ><span class="devsite-nav-text" tooltip>Overview</span></a></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> <span class="devsite-nav-text" tooltip>projects</span> </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects" ><span class="devsite-nav-text" tooltip>Overview</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects/getAuthorization" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects/getAuthorization" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects/getAuthorization" ><span class="devsite-nav-text" tooltip>getAuthorization</span></a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> <span class="devsite-nav-text" tooltip>projects.deployments</span> </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments" ><span class="devsite-nav-text" tooltip>Overview</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/create" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/create" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/create" ><span class="devsite-nav-text" tooltip>create</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/delete" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/delete" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/delete" ><span class="devsite-nav-text" tooltip>delete</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/get" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/get" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/get" ><span class="devsite-nav-text" tooltip>get</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus" ><span class="devsite-nav-text" tooltip>getInstallStatus</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/install" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/install" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/install" ><span class="devsite-nav-text" tooltip>install</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/list" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/list" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/list" ><span class="devsite-nav-text" tooltip>list</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment" ><span class="devsite-nav-text" tooltip>replaceDeployment</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/uninstall" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rest/v1/projects.deployments/uninstall" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rest/v1/projects.deployments/uninstall" ><span class="devsite-nav-text" tooltip>uninstall</span></a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> <span class="devsite-nav-text" tooltip>RPC Resources</span> </div></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc" ><span class="devsite-nav-text" tooltip>Overview</span></a></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/apps.extensions.markup" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/apps.extensions.markup" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/apps.extensions.markup" ><span class="devsite-nav-text" tooltip>apps.extensions.markup</span></a></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.card.v1" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.card.v1" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.card.v1" ><span class="devsite-nav-text" tooltip>google.apps.card.v1</span></a></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> <span class="devsite-nav-text" tooltip>google.apps.script.type</span> </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type" ><span class="devsite-nav-text" tooltip>Overview</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type/calendar" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type/calendar" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type/calendar" ><span class="devsite-nav-text" tooltip>calendar</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type/docs" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type/docs" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type/docs" ><span class="devsite-nav-text" tooltip>docs</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type/drive" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type/drive" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type/drive" ><span class="devsite-nav-text" tooltip>drive</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type/gmail" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type/gmail" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type/gmail" ><span class="devsite-nav-text" tooltip>gmail</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type/sheets" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type/sheets" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type/sheets" ><span class="devsite-nav-text" tooltip>sheets</span></a></li><li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.apps.script.type/slides" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.apps.script.type/slides" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.apps.script.type/slides" ><span class="devsite-nav-text" tooltip>slides</span></a></li></ul></div></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.cloud.gsuiteaddons.v1" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.cloud.gsuiteaddons.v1" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.cloud.gsuiteaddons.v1" ><span class="devsite-nav-text" tooltip>google.cloud.gsuiteaddons.v1</span></a></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/rpc/google.type" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/rpc/google.type" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/rpc/google.type" ><span class="devsite-nav-text" tooltip>google.type</span></a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> <span class="devsite-nav-text" tooltip>Other REST and RPC Resources</span> </div></li> <li class="devsite-nav-item"><a href="/workspace/add-ons/reference/audit-logging" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /workspace/add-ons/reference/audit-logging" track-type="bookNav" track-name="click" track-metadata-eventdetail="/workspace/add-ons/reference/audit-logging" ><span class="devsite-nav-text" tooltip>Audit logging</span></a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> <span class="devsite-nav-text" tooltip>Apps Script resources</span> </div></li> <li class="devsite-nav-item devsite-nav-external"><a href="/apps-script/reference/card-service" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /apps-script/reference/card-service" track-type="bookNav" track-name="click" track-metadata-eventdetail="/apps-script/reference/card-service" target="_blank"><span class="devsite-nav-text" tooltip>Card service</span><span class="devsite-nav-icon material-icons" data-icon="external" data-title="External" aria-hidden="true"></span></a></li> <li class="devsite-nav-item devsite-nav-external"><a href="/apps-script/manifest/addons" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /apps-script/manifest/addons" track-type="bookNav" track-name="click" track-metadata-eventdetail="/apps-script/manifest/addons" target="_blank"><span class="devsite-nav-text" tooltip>Google Workspace Add-ons manifest</span><span class="devsite-nav-icon material-icons" data-icon="external" data-title="External" aria-hidden="true"></span></a></li> <li class="devsite-nav-item devsite-nav-external"><a href="/apps-script/reference/conference-data" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /apps-script/reference/conference-data" track-type="bookNav" track-name="click" track-metadata-eventdetail="/apps-script/reference/conference-data" target="_blank"><span class="devsite-nav-text" tooltip>Calendar conference data service</span><span class="devsite-nav-icon material-icons" data-icon="external" data-title="External" aria-hidden="true"></span></a></li> </ul> <ul class="devsite-nav-list" menu="All products" aria-label="Side menu" hidden> <li class="devsite-nav-item devsite-nav-heading"> <span class="devsite-nav-title" tooltip > <span class="devsite-nav-text" tooltip > Google Workspace apps </span> </span> </li> <li class="devsite-nav-item"> <a href="/admin-sdk" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Admin console" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Admin console </span> </a> </li> <li class="devsite-nav-item"> <a href="/cloud-search" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Cloud Search" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Cloud Search </span> </a> </li> <li class="devsite-nav-item"> <a href="/gmail" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Gmail" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Gmail </span> </a> </li> <li class="devsite-nav-item"> <a href="/calendar" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Calendar" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Calendar </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/chat" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Chat" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Chat </span> </a> </li> <li class="devsite-nav-item"> <a href="/classroom" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Classroom" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Classroom </span> </a> </li> <li class="devsite-nav-item"> <a href="/docs" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Docs" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Docs </span> </a> </li> <li class="devsite-nav-item"> <a href="/drive" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Drive" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Drive </span> </a> </li> <li class="devsite-nav-item devsite-nav-heading"> <span class="devsite-nav-title" tooltip > <span class="devsite-nav-text" tooltip > </span> </span> </li> <li class="devsite-nav-item"> <a href="/forms" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Forms" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Forms </span> </a> </li> <li class="devsite-nav-item"> <a href="/keep" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Keep" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Keep </span> </a> </li> <li class="devsite-nav-item"> <a href="/meet" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Meet" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Meet </span> </a> </li> <li class="devsite-nav-item"> <a href="/sheets" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Sheets" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Sheets </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/sites" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Sites" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Sites </span> </a> </li> <li class="devsite-nav-item"> <a href="/slides" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Slides" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Slides </span> </a> </li> <li class="devsite-nav-item"> <a href="/tasks" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Tasks" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Tasks </span> </a> </li> <li class="devsite-nav-item"> <a href="/vault" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Vault" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Vault </span> </a> </li> <li class="devsite-nav-item devsite-nav-heading"> <span class="devsite-nav-title" tooltip > <span class="devsite-nav-text" tooltip > Extend, automate & share </span> </span> </li> <li class="devsite-nav-item"> <a href="/workspace/add-ons" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Add-ons" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Add-ons </span> </a> </li> <li class="devsite-nav-item"> <a href="/apps-script" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Apps Script" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Apps Script </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/chat/overview" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Chat apps" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Chat apps </span> </a> </li> <li class="devsite-nav-item"> <a href="/drive/api/guides/about-apps" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Drive apps" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Drive apps </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/marketplace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Marketplace" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Marketplace </span> </a> </li> </ul> <ul class="devsite-nav-list" menu="Resources" aria-label="Side menu" hidden> <li class="devsite-nav-item devsite-nav-heading"> <span class="devsite-nav-title" tooltip > <span class="devsite-nav-text" tooltip > Tools </span> </span> </li> <li class="devsite-nav-item"> <a href="https://admin.google.com/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Admin console" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Admin console </span> </a> </li> <li class="devsite-nav-item"> <a href="https://script.google.com/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Apps Script dashboard" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Apps Script dashboard </span> </a> </li> <li class="devsite-nav-item"> <a href="https://console.cloud.google.com/workspace-api" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google Cloud console" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Google Cloud console </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/explore" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: APIs Explorer" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > APIs Explorer </span> </a> </li> <li class="devsite-nav-item"> <a href="https://addons.gsuite.google.com/uikit/builder" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Card Builder" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Card Builder </span> </a> </li> <li class="devsite-nav-item devsite-nav-heading"> <span class="devsite-nav-title" tooltip > <span class="devsite-nav-text" tooltip > Training & support </span> </span> </li> <li class="devsite-nav-item"> <a href="/workspace/guides/get-started" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: How to get started" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > How to get started </span> </a> </li> <li class="devsite-nav-item"> <a href="https://codelabs.developers.google.com/?product=googleworkspace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Codelabs" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Codelabs </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/support" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Developer support" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Developer support </span> </a> </li> <li class="devsite-nav-item devsite-nav-heading"> <span class="devsite-nav-title" tooltip > <span class="devsite-nav-text" tooltip > Updates </span> </span> </li> <li class="devsite-nav-item"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Blog" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Blog </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/preview" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Developer Previews" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Developer Previews </span> </a> </li> <li class="devsite-nav-item"> <a href="/workspace/newsletters" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Newsletter" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > Newsletter </span> </a> </li> <li class="devsite-nav-item"> <a href="https://twitter.com/workspacedevs" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: X (Twitter)" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > X (Twitter) </span> </a> </li> <li class="devsite-nav-item"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: YouTube" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> <span class="devsite-nav-text" tooltip > YouTube </span> </a> </li> </ul> </div> </div> </nav> </devsite-book-nav> <section id="gc-wrapper"> <main role="main" class="devsite-main-content" has-book-nav > <devsite-content> <article class="devsite-article"> <div class="devsite-article-meta nocontent" role="navigation"> <ul class="devsite-breadcrumb-list" aria-label="Breadcrumb"> <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="" > Home </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/workspace" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="2" track-type="globalNav" track-name="breadcrumb" track-metadata-position="2" track-metadata-eventdetail="Google Workspace" > Google Workspace </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/workspace/add-ons/overview" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="3" track-type="globalNav" track-name="breadcrumb" track-metadata-position="3" track-metadata-eventdetail="Google Workspace Add-ons" > Add-ons </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/workspace/add-ons/reference" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="4" track-type="globalNav" track-name="breadcrumb" track-metadata-position="4" track-metadata-eventdetail="" > Reference </a> </li> </ul> <devsite-thumb-rating position="header"> </devsite-thumb-rating> </div> <devsite-feedback position="header" project-name="Google Workspace Add-ons" product-id="717201" bucket="add-ons" context="" version="t-devsite-webserver-20241114-r00-rc02.464922260396498922" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="header" class="nocontent" project-feedback-url="https://issuetracker.google.com/issues/new?component=642720&template=1392206" project-icon="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/touchicon-180-new.png" project-support-url="https://developers.google.com/workspace/add-ons/workspace-support" > <button> Send feedback </button> </devsite-feedback> <h1 class="devsite-page-title" tabindex="-1"> REST Resource: projects.deployments </h1> <devsite-feature-tooltip ack-key="AckCollectionsBookmarkTooltipDismiss" analytics-category="Site-Wide Custom Events" analytics-action-show="Callout Profile displayed" analytics-action-close="Callout Profile dismissed" analytics-label="Create Collection Callout" class="devsite-page-bookmark-tooltip nocontent" dismiss-button="true" id="devsite-collections-dropdown" dismiss-button-text="Dismiss" close-button-text="Got it"> <devsite-bookmark></devsite-bookmark> <span slot="popout-heading"> Stay organized with collections </span> <span slot="popout-contents"> Save and categorize content based on your preferences. </span> </devsite-feature-tooltip> <div class="devsite-page-title-meta"><devsite-view-release-notes></devsite-view-release-notes></div> <devsite-toc class="devsite-nav" depth="2" devsite-toc-embedded > </devsite-toc> <div class="devsite-article-body clearfix "> <meta itemprop="name" content="projects.deployments"> <meta itemprop="path" content="/workspace/add-ons/reference/rest/v1/projects.deployments"> <section id="/workspace/add-ons/reference/rest/v1/projects.deployments"> <ul class="toc"> <li><a href="#Deployment">Resource: Deployment</a> <ul> <li><a href="#Deployment.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#AddOns">AddOns</a> <ul> <li><a href="#AddOns.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#CommonAddOnManifest">CommonAddOnManifest</a> <ul> <li><a href="#CommonAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#LayoutProperties">LayoutProperties</a> <ul> <li><a href="#LayoutProperties.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#AddOnWidgetSet">AddOnWidgetSet</a> <ul> <li><a href="#AddOnWidgetSet.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#WidgetType">WidgetType</a></li> <li><a href="#HomepageExtensionPoint">HomepageExtensionPoint</a> <ul> <li><a href="#HomepageExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#UniversalActionExtensionPoint">UniversalActionExtensionPoint</a> <ul> <li><a href="#UniversalActionExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#GmailAddOnManifest">GmailAddOnManifest</a> <ul> <li><a href="#GmailAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#ContextualTrigger">ContextualTrigger</a> <ul> <li><a href="#ContextualTrigger.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#UnconditionalTrigger">UnconditionalTrigger</a></li> <li><a href="#UniversalAction">UniversalAction</a> <ul> <li><a href="#UniversalAction.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#ComposeTrigger">ComposeTrigger</a> <ul> <li><a href="#ComposeTrigger.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#MenuItemExtensionPoint">MenuItemExtensionPoint</a> <ul> <li><a href="#MenuItemExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#DraftAccess">DraftAccess</a></li> <li><a href="#DriveAddOnManifest">DriveAddOnManifest</a> <ul> <li><a href="#DriveAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#DriveExtensionPoint">DriveExtensionPoint</a> <ul> <li><a href="#DriveExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#CalendarAddOnManifest">CalendarAddOnManifest</a> <ul> <li><a href="#CalendarAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#ConferenceSolution">ConferenceSolution</a> <ul> <li><a href="#ConferenceSolution.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#CalendarExtensionPoint">CalendarExtensionPoint</a> <ul> <li><a href="#CalendarExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#EventAccess">EventAccess</a></li> <li><a href="#DocsAddOnManifest">DocsAddOnManifest</a> <ul> <li><a href="#DocsAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#DocsExtensionPoint">DocsExtensionPoint</a> <ul> <li><a href="#DocsExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a> <ul> <li><a href="#LinkPreviewExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#UriPattern">UriPattern</a> <ul> <li><a href="#UriPattern.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#CreateActionExtensionPoint">CreateActionExtensionPoint</a> <ul> <li><a href="#CreateActionExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#SheetsAddOnManifest">SheetsAddOnManifest</a> <ul> <li><a href="#SheetsAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#SheetsExtensionPoint">SheetsExtensionPoint</a> <ul> <li><a href="#SheetsExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#SlidesAddOnManifest">SlidesAddOnManifest</a> <ul> <li><a href="#SlidesAddOnManifest.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#SlidesExtensionPoint">SlidesExtensionPoint</a> <ul> <li><a href="#SlidesExtensionPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#HttpOptions">HttpOptions</a> <ul> <li><a href="#HttpOptions.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> <li><a href="#HttpAuthorizationHeader">HttpAuthorizationHeader</a></li> <li><a href="#METHODS_SUMMARY">Methods</a></li> </ul> <section id="Deployment"> <h2 id="resource:-deployment" data-text="Resource: Deployment" tabindex="-1">Resource: Deployment</h2> <section id="Deployment.description"> <p>A Google Workspace Add-on deployment</p> </section> <section id="Deployment.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"name"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"oauthScopes"</span><span class="pun">: </span><span class="pun">[</span> <span class="kwd">string</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"addOns"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#AddOns">AddOns</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"etag"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="Deployment.FIELDS"> <table class="properties responsive fixed" id="Deployment.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="Deployment.FIELDS.name"> <td><code translate="no" dir="ltr">name</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>The deployment resource name. Example: <code translate="no" dir="ltr">projects/123/deployments/my_deployment</code>.</p> </td> </tr> <tr id="Deployment.FIELDS.oauthScopes"> <td><code translate="no" dir="ltr">oauth<wbr>Scopes[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint.</p> </td> </tr> <tr id="Deployment.FIELDS.addOns"> <td><code translate="no" dir="ltr">add<wbr>Ons</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#AddOns">AddOns</a></code>)</code></p> <p>The Google Workspace Add-on configuration.</p> </td> </tr> <tr id="Deployment.FIELDS.etag"> <td><code translate="no" dir="ltr">etag</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>This value is computed by the server based on the version of the deployment in storage, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.</p> </td> </tr> </tbody> </table> </section> </section> <section id="AddOns"> <h2 id="addons" data-text="AddOns" tabindex="-1">AddOns</h2> <section id="AddOns.description"> <p>A Google Workspace Add-on configuration.</p> </section> <section id="AddOns.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"common"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CommonAddOnManifest">CommonAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"gmail"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#GmailAddOnManifest">GmailAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"drive"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DriveAddOnManifest">DriveAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"calendar"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CalendarAddOnManifest">CalendarAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"docs"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DocsAddOnManifest">DocsAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"sheets"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SheetsAddOnManifest">SheetsAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"slides"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SlidesAddOnManifest">SlidesAddOnManifest</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"httpOptions"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HttpOptions">HttpOptions</a></code>)</span> <span class="pun">}</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="AddOns.FIELDS"> <table class="properties responsive fixed" id="AddOns.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="AddOns.FIELDS.common"> <td><code translate="no" dir="ltr">common</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CommonAddOnManifest">CommonAddOnManifest</a></code>)</code></p> <p>Configuration that is common across all Google Workspace Add-ons.</p> </td> </tr> <tr id="AddOns.FIELDS.gmail"> <td><code translate="no" dir="ltr">gmail</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#GmailAddOnManifest">GmailAddOnManifest</a></code>)</code></p> <p>Gmail add-on configuration.</p> </td> </tr> <tr id="AddOns.FIELDS.drive"> <td><code translate="no" dir="ltr">drive</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DriveAddOnManifest">DriveAddOnManifest</a></code>)</code></p> <p>Drive add-on configuration.</p> </td> </tr> <tr id="AddOns.FIELDS.calendar"> <td><code translate="no" dir="ltr">calendar</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CalendarAddOnManifest">CalendarAddOnManifest</a></code>)</code></p> <p>Calendar add-on configuration.</p> </td> </tr> <tr id="AddOns.FIELDS.docs"> <td><code translate="no" dir="ltr">docs</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DocsAddOnManifest">DocsAddOnManifest</a></code>)</code></p> <p>Docs add-on configuration.</p> </td> </tr> <tr id="AddOns.FIELDS.sheets"> <td><code translate="no" dir="ltr">sheets</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SheetsAddOnManifest">SheetsAddOnManifest</a></code>)</code></p> <p>Sheets add-on configuration.</p> </td> </tr> <tr id="AddOns.FIELDS.slides"> <td><code translate="no" dir="ltr">slides</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SlidesAddOnManifest">SlidesAddOnManifest</a></code>)</code></p> <p>Slides add-on configuration.</p> </td> </tr> <tr id="AddOns.FIELDS.httpOptions"> <td><code translate="no" dir="ltr">http<wbr>Options</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HttpOptions">HttpOptions</a></code>)</code></p> <p>Options for sending requests to add-on HTTP endpoints</p> </td> </tr> </tbody> </table> </section> </section> <section id="CommonAddOnManifest"> <h2 id="commonaddonmanifest" data-text="CommonAddOnManifest" tabindex="-1">CommonAddOnManifest</h2> <section id="CommonAddOnManifest.description"> <p>Add-on configuration that is shared across all add-on host applications.</p> </section> <section id="CommonAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"name"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"logoUrl"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"layoutProperties"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LayoutProperties">LayoutProperties</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"addOnWidgetSet"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#AddOnWidgetSet">AddOnWidgetSet</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"useLocaleFromApp"</span><span class="pun">: </span><span class="kwd">boolean</span><span class="pun">,</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"universalActions"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UniversalActionExtensionPoint">UniversalActionExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"openLinkUrlPrefixes"</span><span class="pun">: </span><span class="kwd">array</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="CommonAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="CommonAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="CommonAddOnManifest.FIELDS.name"> <td><code translate="no" dir="ltr">name</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The display name of the add-on.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.logoUrl"> <td><code translate="no" dir="ltr">logo<wbr>Url</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The URL for the logo image shown in the add-on toolbar.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.layoutProperties"> <td><code translate="no" dir="ltr">layout<wbr>Properties</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LayoutProperties">LayoutProperties</a></code>)</code></p> <p>Common layout properties for the add-on cards.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.addOnWidgetSet"> <td><code translate="no" dir="ltr">add<wbr>On<wbr>Widget<wbr>Set</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#AddOnWidgetSet">AddOnWidgetSet</a></code>)</code></p> <p>The widgets used in the add-on. If this field is not specified, the default set is used.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.useLocaleFromApp"> <td><code translate="no" dir="ltr">use<wbr>Locale<wbr>From<wbr>App</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">boolean</code></p> <p>Whether to pass locale information from host app.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>Defines an endpoint that will be executed in any context, in any host. Any cards generated by this function will always be available to the user, but might be eclipsed by contextual content when this add-on declares more targeted triggers.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.universalActions"> <td><code translate="no" dir="ltr">universal<wbr>Actions[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UniversalActionExtensionPoint">UniversalActionExtensionPoint</a></code>)</code></p> <p>Defines a list of extension points in the universal action menu which serves as a settings menu for the add-on. The extension point can be a link URL to open or an endpoint to execute as a form submission.</p> </td> </tr> <tr id="CommonAddOnManifest.FIELDS.openLinkUrlPrefixes"> <td><code translate="no" dir="ltr">open<wbr>Link<wbr>Url<wbr>Prefixes</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">array (<code translate="no" dir="ltr"><a href="https://protobuf.dev/reference/protobuf/google.protobuf/#list-value">ListValue</a></code> format)</code></p> <p>An OpenLink action can only use a URL with an <code translate="no" dir="ltr">HTTPS</code>, <code translate="no" dir="ltr">MAILTO</code> or <code translate="no" dir="ltr">TEL</code> scheme. For <code translate="no" dir="ltr">HTTPS</code> links, the URL must also <a href="/gmail/add-ons/concepts/manifests#whitelisting_urls">match</a> one of the prefixes specified in the allowlist. If the prefix omits the scheme, <code translate="no" dir="ltr">HTTPS</code> is assumed. <code translate="no" dir="ltr">HTTP</code> links are automatically rewritten to <code translate="no" dir="ltr">HTTPS</code> links.</p> </td> </tr> </tbody> </table> </section> </section> <section id="LayoutProperties"> <h2 id="layoutproperties" data-text="LayoutProperties" tabindex="-1">LayoutProperties</h2> <section id="LayoutProperties.description"> <p>Card layout properties shared across all add-on host applications.</p> </section> <section id="LayoutProperties.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"primaryColor"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"secondaryColor"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"useNewMaterialDesign"</span><span class="pun">: </span><span class="kwd">boolean</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="LayoutProperties.FIELDS"> <table class="properties responsive fixed" id="LayoutProperties.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="LayoutProperties.FIELDS.primaryColor"> <td><code translate="no" dir="ltr">primary<wbr>Color</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>The primary color of the add-on. It sets the color of the toolbar. If no primary color is set, the default value provided by the framework is used.</p> </td> </tr> <tr id="LayoutProperties.FIELDS.secondaryColor"> <td><code translate="no" dir="ltr">secondary<wbr>Color</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>The secondary color of the add-on. It sets the color of buttons. If the primary color is set but no secondary color is set, the secondary color is the same as the primary color. If neither primary color nor secondary color is set, the default value provided by the framework is used.</p> </td> </tr> <tr id="LayoutProperties.FIELDS.useNewMaterialDesign"> <td><code translate="no" dir="ltr">use<wbr>New<wbr>Material<wbr>Design</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">boolean</code></p> <p>Enables material design for cards.</p> </td> </tr> </tbody> </table> </section> </section> <section id="AddOnWidgetSet"> <h2 id="addonwidgetset" data-text="AddOnWidgetSet" tabindex="-1">AddOnWidgetSet</h2> <section id="AddOnWidgetSet.description"> <p>The widget subset used by an add-on.</p> </section> <section id="AddOnWidgetSet.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"usedWidgets"</span><span class="pun">: </span><span class="pun">[</span> <span class="kwd">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#WidgetType">WidgetType</a></code>)</span> <span class="pun">]</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="AddOnWidgetSet.FIELDS"> <table class="properties responsive fixed" id="AddOnWidgetSet.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="AddOnWidgetSet.FIELDS.usedWidgets"> <td><code translate="no" dir="ltr">used<wbr>Widgets[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#WidgetType">WidgetType</a></code>)</code></p> <p>The list of widgets used in an add-on.</p> </td> </tr> </tbody> </table> </section> </section> <section id="WidgetType"> <h2 id="widgettype" data-text="WidgetType" tabindex="-1">WidgetType</h2> <section id="WidgetType.description"> <p>The widget type. <code translate="no" dir="ltr">WIDGET_TYPE_UNSPECIFIED</code> is the basic widget set.</p> </section> <section id="WidgetType.ENUM_VALUES"> <table class="constants responsive fixed" id="WidgetType.ENUM_VALUES-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="WidgetType.ENUM_VALUES.WIDGET_TYPE_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">WIDGET_TYPE_UNSPECIFIED</code></td> <td>The default widget set.</td> </tr> <tr id="WidgetType.ENUM_VALUES.DATE_PICKER"> <td><code class="apitype" translate="no" dir="ltr">DATE_PICKER</code></td> <td>The date picker.</td> </tr> <tr id="WidgetType.ENUM_VALUES.STYLED_BUTTONS"> <td><code class="apitype" translate="no" dir="ltr">STYLED_BUTTONS</code></td> <td>Styled buttons include filled buttons and deactivated buttons.</td> </tr> <tr id="WidgetType.ENUM_VALUES.PERSISTENT_FORMS"> <td><code class="apitype" translate="no" dir="ltr">PERSISTENT_FORMS</code></td> <td>Persistent forms allow persisting form values during actions.</td> </tr> <tr id="WidgetType.ENUM_VALUES.FIXED_FOOTER"> <td><code class="apitype" translate="no" dir="ltr">FIXED_FOOTER</code></td> <td>Fixed footer in a card.</td> </tr> <tr id="WidgetType.ENUM_VALUES.UPDATE_SUBJECT_AND_RECIPIENTS"> <td><code class="apitype" translate="no" dir="ltr">UPDATE_SUBJECT_AND_RECIPIENTS</code></td> <td>Update the subject and recipients of a draft.</td> </tr> <tr id="WidgetType.ENUM_VALUES.GRID_WIDGET"> <td><code class="apitype" translate="no" dir="ltr">GRID_WIDGET</code></td> <td>The grid widget.</td> </tr> <tr id="WidgetType.ENUM_VALUES.ADDON_COMPOSE_UI_ACTION"> <td><code class="apitype" translate="no" dir="ltr">ADDON_COMPOSE_UI_ACTION</code></td> <td>A Gmail add-on action that applies to the add-on compose UI.</td> </tr> </tbody> </table> </section> </section> <section id="HomepageExtensionPoint"> <h2 id="homepageextensionpoint" data-text="HomepageExtensionPoint" tabindex="-1">HomepageExtensionPoint</h2> <section id="HomepageExtensionPoint.description"> <p>Common format for declaring an add-on's homepage view.</p> </section> <section id="HomepageExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"enabled"</span><span class="pun">: </span><span class="kwd">boolean</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="HomepageExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="HomepageExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="HomepageExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when this extension point is activated.</p> </td> </tr> <tr id="HomepageExtensionPoint.FIELDS.enabled"> <td><code translate="no" dir="ltr">enabled</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">boolean</code></p> <p>Optional. If set to <code translate="no" dir="ltr">false</code>, deactivates the homepage view in this context.</p><p>Defaults to <code translate="no" dir="ltr">true</code> if unset.</p><p>If an add-on's custom homepage view is disabled, a generic overview card is provided for users instead.</p> </td> </tr> </tbody> </table> </section> </section> <section id="UniversalActionExtensionPoint"> <h2 id="universalactionextensionpoint" data-text="UniversalActionExtensionPoint" tabindex="-1">UniversalActionExtensionPoint</h2> <section id="UniversalActionExtensionPoint.description"> <p>Format for declaring a universal action menu item extension point.</p> </section> <section id="UniversalActionExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"label"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="com">// Union field <code translate="no" dir="ltr">action_type</code> can be only one of the following:</span> <span class="str">"openLink"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="com">// End of list of possible types for union field <code translate="no" dir="ltr">action_type</code>.</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="UniversalActionExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="UniversalActionExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="UniversalActionExtensionPoint.FIELDS.label"> <td><code translate="no" dir="ltr">label</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. User-visible text that describes the action taken by activating this extension point, for example, "Add a new contact."</p> </td> </tr> <tr id="UniversalActionExtensionPoint.FIELDS.oneof_action_type" class="alt"> <td colspan="2">Union field <code translate="no" dir="ltr">action_type</code>. Required. The action type supported on a universal action menu item. It can either be a link to open or an endpoint to execute. <code translate="no" dir="ltr">action_type</code> can be only one of the following:</td> </tr> <tr id="UniversalActionExtensionPoint.FIELDS.openLink"> <td><code translate="no" dir="ltr">open<wbr>Link</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>URL to be opened by the UniversalAction.</p> </td> </tr> <tr id="UniversalActionExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Endpoint to be run by the UniversalAction.</p> </td> </tr> </tbody> </table> </section> </section> <section id="GmailAddOnManifest"> <h2 id="gmailaddonmanifest" data-text="GmailAddOnManifest" tabindex="-1">GmailAddOnManifest</h2> <section id="GmailAddOnManifest.description"> <p>Properties customizing the appearance and execution of a Gmail add-on.</p> </section> <section id="GmailAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"contextualTriggers"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#ContextualTrigger">ContextualTrigger</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"universalActions"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UniversalAction">UniversalAction</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"composeTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#ComposeTrigger">ComposeTrigger</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"authorizationCheckFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="GmailAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="GmailAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="GmailAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>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.</p><p>If present, this overrides the configuration from <code translate="no" dir="ltr">addons.common.homepageTrigger</code>.</p> </td> </tr> <tr id="GmailAddOnManifest.FIELDS.contextualTriggers"> <td><code translate="no" dir="ltr">contextual<wbr>Triggers[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#ContextualTrigger">ContextualTrigger</a></code>)</code></p> <p>Defines the set of conditions that trigger the add-on.</p> </td> </tr> <tr id="GmailAddOnManifest.FIELDS.universalActions"> <td><code translate="no" dir="ltr">universal<wbr>Actions[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UniversalAction">UniversalAction</a></code>)</code></p> <p>Defines a set of <a href="/gmail/add-ons/how-tos/universal-actions">universal actions</a> for the add-on. The user triggers universal actions from the add-on toolbar menu.</p> </td> </tr> <tr id="GmailAddOnManifest.FIELDS.composeTrigger"> <td><code translate="no" dir="ltr">compose<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#ComposeTrigger">ComposeTrigger</a></code>)</code></p> <p>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 add-ons must have the <code translate="no" dir="ltr">gmail.addons.current.action.compose</code> scope even though it might not edit the draft.</p> </td> </tr> <tr id="GmailAddOnManifest.FIELDS.authorizationCheckFunction"> <td><code translate="no" dir="ltr">authorization<wbr>Check<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>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.</p> </td> </tr> </tbody> </table> </section> </section> <section id="ContextualTrigger"> <h2 id="contextualtrigger" data-text="ContextualTrigger" tabindex="-1">ContextualTrigger</h2> <section id="ContextualTrigger.description"> <p>Defines a trigger that fires when the open email meets a specific criteria. When the trigger fires, it executes a specific endpoint, usually in order to create new cards and update the UI.</p> </section> <section id="ContextualTrigger.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"onTriggerFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="com">// Union field <code translate="no" dir="ltr">trigger</code> can be only one of the following:</span> <span class="str">"unconditional"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UnconditionalTrigger">UnconditionalTrigger</a></code>)</span> <span class="pun">}</span> <span class="com">// End of list of possible types for union field <code translate="no" dir="ltr">trigger</code>.</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="ContextualTrigger.FIELDS"> <table class="properties responsive fixed" id="ContextualTrigger.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="ContextualTrigger.FIELDS.onTriggerFunction"> <td><code translate="no" dir="ltr">on<wbr>Trigger<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The name of the endpoint to call when a message matches the trigger.</p> </td> </tr> <tr id="ContextualTrigger.FIELDS.oneof_trigger" class="alt"> <td colspan="2">Union field <code translate="no" dir="ltr">trigger</code>. The type of trigger determines the conditions Gmail uses to show the add-on. <code translate="no" dir="ltr">trigger</code> can be only one of the following:</td> </tr> <tr id="ContextualTrigger.FIELDS.unconditional"> <td><code translate="no" dir="ltr">unconditional</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UnconditionalTrigger">UnconditionalTrigger</a></code>)</code></p> <p>Unconditional triggers are executed when any mail message is opened.</p> </td> </tr> </tbody> </table> </section> </section> <section id="UnconditionalTrigger"> <h2 id="unconditionaltrigger" data-text="UnconditionalTrigger" tabindex="-1">UnconditionalTrigger</h2> <p>This type has no fields.</p> <section id="UnconditionalTrigger.description"> <p>A trigger that fires when any email message is opened.</p> </section> </section> <section id="UniversalAction"> <h2 id="universalaction" data-text="UniversalAction" tabindex="-1">UniversalAction</h2> <section id="UniversalAction.description"> <p>An action that is always available in the add-on toolbar menu regardless of message context.</p> </section> <section id="UniversalAction.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"text"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="com">// Union field <code translate="no" dir="ltr">action_type</code> can be only one of the following:</span> <span class="str">"openLink"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="com">// End of list of possible types for union field <code translate="no" dir="ltr">action_type</code>.</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="UniversalAction.FIELDS"> <table class="properties responsive fixed" id="UniversalAction.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="UniversalAction.FIELDS.text"> <td><code translate="no" dir="ltr">text</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. User-visible text describing the action, for example, "Add a new contact."</p> </td> </tr> <tr id="UniversalAction.FIELDS.oneof_action_type" class="alt"> <td colspan="2">Union field <code translate="no" dir="ltr">action_type</code>. The type of the action determines the behavior of Gmail when the user invokes the action. <code translate="no" dir="ltr">action_type</code> can be only one of the following:</td> </tr> <tr id="UniversalAction.FIELDS.openLink"> <td><code translate="no" dir="ltr">open<wbr>Link</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>A link that is opened by Gmail when the user triggers the action.</p> </td> </tr> <tr id="UniversalAction.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>An endpoint that is called when the user triggers the action. See the <a href="/gmail/add-ons/how-tos/universal-actions">universal actions guide</a> for details.</p> </td> </tr> </tbody> </table> </section> </section> <section id="ComposeTrigger"> <h2 id="composetrigger" data-text="ComposeTrigger" tabindex="-1">ComposeTrigger</h2> <section id="ComposeTrigger.description"> <p>A trigger that activates when user is composing an email.</p> </section> <section id="ComposeTrigger.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"actions"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#MenuItemExtensionPoint">MenuItemExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"draftAccess"</span><span class="pun">: </span><span class="kwd">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DraftAccess">DraftAccess</a></code>)</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="ComposeTrigger.FIELDS"> <table class="properties responsive fixed" id="ComposeTrigger.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="ComposeTrigger.FIELDS.actions"> <td><code translate="no" dir="ltr">actions[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#MenuItemExtensionPoint">MenuItemExtensionPoint</a></code>)</code></p> <p>Defines the set of actions for a compose time add-on. These are actions that users can trigger on a compose time add-on.</p> </td> </tr> <tr id="ComposeTrigger.FIELDS.draftAccess"> <td><code translate="no" dir="ltr">draft<wbr>Access</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DraftAccess">DraftAccess</a></code>)</code></p> <p>Defines the level of data access when a compose time add-on is triggered.</p> </td> </tr> </tbody> </table> </section> </section> <section id="MenuItemExtensionPoint"> <h2 id="menuitemextensionpoint" data-text="MenuItemExtensionPoint" tabindex="-1">MenuItemExtensionPoint</h2> <section id="MenuItemExtensionPoint.description"> <p>Common format for declaring a menu item or button that appears within a host app.</p> </section> <section id="MenuItemExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"label"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"logoUrl"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="MenuItemExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="MenuItemExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="MenuItemExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when this extension point is activated.</p> </td> </tr> <tr id="MenuItemExtensionPoint.FIELDS.label"> <td><code translate="no" dir="ltr">label</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. User-visible text that describes the action taken by activating this extension point. For example, "Insert invoice."</p> </td> </tr> <tr id="MenuItemExtensionPoint.FIELDS.logoUrl"> <td><code translate="no" dir="ltr">logo<wbr>Url</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>The URL for the logo image shown in the add-on toolbar.</p><p>If not set, defaults to the add-on's primary logo URL.</p> </td> </tr> </tbody> </table> </section> </section> <section id="DraftAccess"> <h2 id="draftaccess" data-text="DraftAccess" tabindex="-1">DraftAccess</h2> <section id="DraftAccess.description"> <p>An enum that defines the level of data access the compose trigger requires.</p> </section> <section id="DraftAccess.ENUM_VALUES"> <table class="constants responsive fixed" id="DraftAccess.ENUM_VALUES-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="DraftAccess.ENUM_VALUES.UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">UNSPECIFIED</code></td> <td>Default value when nothing is set for draftaccess.</td> </tr> <tr id="DraftAccess.ENUM_VALUES.NONE"> <td><code class="apitype" translate="no" dir="ltr">NONE</code></td> <td>The compose trigger can't access any data of the draft when a compose add-on is triggered.</td> </tr> <tr id="DraftAccess.ENUM_VALUES.METADATA"> <td><code class="apitype" translate="no" dir="ltr">METADATA</code></td> <td>Gives the compose trigger the permission to access the metadata of the draft when a compose add-on is triggered. This includes the audience list, such as the To and Cc list of a draft message.</td> </tr> </tbody> </table> </section> </section> <section id="DriveAddOnManifest"> <h2 id="driveaddonmanifest" data-text="DriveAddOnManifest" tabindex="-1">DriveAddOnManifest</h2> <section id="DriveAddOnManifest.description"> <p>Properties customizing the appearance and execution of a Drive add-on.</p> </section> <section id="DriveAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"onItemsSelectedTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DriveExtensionPoint">DriveExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="DriveAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="DriveAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="DriveAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>If present, this overrides the configuration from <code translate="no" dir="ltr">addons.common.homepageTrigger</code>.</p> </td> </tr> <tr id="DriveAddOnManifest.FIELDS.onItemsSelectedTrigger"> <td><code translate="no" dir="ltr">on<wbr>Items<wbr>Selected<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DriveExtensionPoint">DriveExtensionPoint</a></code>)</code></p> <p>Corresponds to behavior that executes when items are selected in the relevant Drive view, such as the My Drive Doclist.</p> </td> </tr> </tbody> </table> </section> </section> <section id="DriveExtensionPoint"> <h2 id="driveextensionpoint" data-text="DriveExtensionPoint" tabindex="-1">DriveExtensionPoint</h2> <section id="DriveExtensionPoint.description"> <p>Common format for declaring a Drive add-on's triggers.</p> </section> <section id="DriveExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="DriveExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="DriveExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="DriveExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when the extension point is activated.</p> </td> </tr> </tbody> </table> </section> </section> <section id="CalendarAddOnManifest"> <h2 id="calendaraddonmanifest" data-text="CalendarAddOnManifest" tabindex="-1">CalendarAddOnManifest</h2> <section id="CalendarAddOnManifest.description"> <p>Properties customizing the appearance and execution of a Calendar add-on.</p> </section> <section id="CalendarAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"conferenceSolution"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#ConferenceSolution">ConferenceSolution</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"createSettingsUrlFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"eventOpenTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CalendarExtensionPoint">CalendarExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"eventUpdateTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CalendarExtensionPoint">CalendarExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"eventAttachmentTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#MenuItemExtensionPoint">MenuItemExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"currentEventAccess"</span><span class="pun">: </span><span class="kwd">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#EventAccess">EventAccess</a></code>)</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="CalendarAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="CalendarAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="CalendarAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>Defines an endpoint that is 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 might be eclipsed by contextual content when this add-on declares more targeted triggers.</p><p>If present, this overrides the configuration from <code translate="no" dir="ltr">addons.common.homepageTrigger</code>.</p> </td> </tr> <tr id="CalendarAddOnManifest.FIELDS.conferenceSolution"> <td><code translate="no" dir="ltr">conference<wbr>Solution[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#ConferenceSolution">ConferenceSolution</a></code>)</code></p> <p>Defines conference solutions provided by this add-on. Third-party conferencing add-ons can only be built in <a href="https://developers.google.com/apps-script/reference/conference-data">Apps Script</a>.</p> </td> </tr> <tr id="CalendarAddOnManifest.FIELDS.createSettingsUrlFunction"> <td><code translate="no" dir="ltr">create<wbr>Settings<wbr>Url<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>An endpoint to execute that creates a URL to the add-on's settings page.</p> </td> </tr> <tr id="CalendarAddOnManifest.FIELDS.eventOpenTrigger"> <td><code translate="no" dir="ltr">event<wbr>Open<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CalendarExtensionPoint">CalendarExtensionPoint</a></code>)</code></p> <p>An endpoint that triggers when an event is opened to be viewed or edited.</p> </td> </tr> <tr id="CalendarAddOnManifest.FIELDS.eventUpdateTrigger"> <td><code translate="no" dir="ltr">event<wbr>Update<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CalendarExtensionPoint">CalendarExtensionPoint</a></code>)</code></p> <p>An endpoint that triggers when the open event is updated.</p> </td> </tr> <tr id="CalendarAddOnManifest.FIELDS.eventAttachmentTrigger"> <td><code translate="no" dir="ltr">event<wbr>Attachment<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#MenuItemExtensionPoint">MenuItemExtensionPoint</a></code>)</code></p> <p>A configuration for a contextual trigger that fires when the user clicks on the add-on attachment provider in the Calendar dropdown menu.</p> </td> </tr> <tr id="CalendarAddOnManifest.FIELDS.currentEventAccess"> <td><code translate="no" dir="ltr">current<wbr>Event<wbr>Access</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#EventAccess">EventAccess</a></code>)</code></p> <p>Defines the level of data access when an event add-on is triggered.</p> </td> </tr> </tbody> </table> </section> </section> <section id="ConferenceSolution"> <h2 id="conferencesolution" data-text="ConferenceSolution" tabindex="-1">ConferenceSolution</h2> <section id="ConferenceSolution.description"> <p>Defines conference-related values. Third-party conferencing add-ons can only be built in <a href="https://developers.google.com/apps-script/reference/conference-data">Apps Script</a>.</p> </section> <section id="ConferenceSolution.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"onCreateFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"id"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"name"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"logoUrl"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="ConferenceSolution.FIELDS"> <table class="properties responsive fixed" id="ConferenceSolution.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="ConferenceSolution.FIELDS.onCreateFunction"> <td><code translate="no" dir="ltr">on<wbr>Create<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to call when conference data should be created.</p> </td> </tr> <tr id="ConferenceSolution.FIELDS.id"> <td><code translate="no" dir="ltr">id</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. IDs should be uniquely assigned across conference solutions within one add-on, otherwise the wrong conference solution might be used when the add-on is triggered. While you can change the display name of an add-on, the ID shouldn’t be changed.</p> </td> </tr> <tr id="ConferenceSolution.FIELDS.name"> <td><code translate="no" dir="ltr">name</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The display name of the conference solution.</p> </td> </tr> <tr id="ConferenceSolution.FIELDS.logoUrl"> <td><code translate="no" dir="ltr">logo<wbr>Url</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The URL for the logo image of the conference solution.</p> </td> </tr> </tbody> </table> </section> </section> <section id="CalendarExtensionPoint"> <h2 id="calendarextensionpoint" data-text="CalendarExtensionPoint" tabindex="-1">CalendarExtensionPoint</h2> <section id="CalendarExtensionPoint.description"> <p>Common format for declaring a calendar add-on's triggers.</p> </section> <section id="CalendarExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="CalendarExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="CalendarExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="CalendarExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when this extension point is activated.</p> </td> </tr> </tbody> </table> </section> </section> <section id="EventAccess"> <h2 id="eventaccess" data-text="EventAccess" tabindex="-1">EventAccess</h2> <section id="EventAccess.description"> <p>An enum that defines the level of data access event triggers require.</p> </section> <section id="EventAccess.ENUM_VALUES"> <table class="constants responsive fixed" id="EventAccess.ENUM_VALUES-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="EventAccess.ENUM_VALUES.UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">UNSPECIFIED</code></td> <td>Default value when nothing is set for eventAccess.</td> </tr> <tr id="EventAccess.ENUM_VALUES.METADATA"> <td><code class="apitype" translate="no" dir="ltr">METADATA</code></td> <td>Gives event triggers the permission to access the metadata of events, such as event ID and calendar ID.</td> </tr> <tr id="EventAccess.ENUM_VALUES.READ"> <td><code class="apitype" translate="no" dir="ltr">READ</code></td> <td>Gives event triggers access to all provided event fields including the metadata, attendees, and conference data.</td> </tr> <tr id="EventAccess.ENUM_VALUES.WRITE"> <td><code class="apitype" translate="no" dir="ltr">WRITE</code></td> <td>Gives event triggers access to the metadata of events and the ability to perform all actions, including adding attendees and setting conference data.</td> </tr> <tr id="EventAccess.ENUM_VALUES.READ_WRITE"> <td><code class="apitype" translate="no" dir="ltr">READ_WRITE</code></td> <td>Gives event triggers access to all provided event fields including the metadata, attendees, and conference data and the ability to perform all actions.</td> </tr> </tbody> </table> </section> </section> <section id="DocsAddOnManifest"> <h2 id="docsaddonmanifest" data-text="DocsAddOnManifest" tabindex="-1">DocsAddOnManifest</h2> <section id="DocsAddOnManifest.description"> <p>Properties customizing the appearance and execution of a Google Docs add-on.</p> </section> <section id="DocsAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"onFileScopeGrantedTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DocsExtensionPoint">DocsExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"linkPreviewTriggers"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"createActionTriggers"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CreateActionExtensionPoint">CreateActionExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="DocsAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="DocsAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="DocsAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>If present, this overrides the configuration from <code translate="no" dir="ltr">addons.common.homepageTrigger</code>.</p> </td> </tr> <tr id="DocsAddOnManifest.FIELDS.onFileScopeGrantedTrigger"> <td><code translate="no" dir="ltr">on<wbr>File<wbr>Scope<wbr>Granted<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#DocsExtensionPoint">DocsExtensionPoint</a></code>)</code></p> <p>Endpoint to execute when file scope authorization is granted for this document/user pair.</p> </td> </tr> <tr id="DocsAddOnManifest.FIELDS.linkPreviewTriggers"> <td><code translate="no" dir="ltr">link<wbr>Preview<wbr>Triggers[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a></code>)</code></p> <p>A list of extension points for previewing links in a Google Docs document. For details, see <a href="https://developers.google.com/workspace/add-ons/guides/preview-links-smart-chips">Preview links with smart chips</a>.</p> </td> </tr> <tr id="DocsAddOnManifest.FIELDS.createActionTriggers"> <td><code translate="no" dir="ltr">create<wbr>Action<wbr>Triggers[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#CreateActionExtensionPoint">CreateActionExtensionPoint</a></code>)</code></p> <p>A list of extension points for creating third-party resources from within Google Workspace applications. For more information, see <a href="https://developers.google.com/workspace/add-ons/guides/create-insert-resource-smart-chip">Create third-party resources from the @ menu</a>.</p> </td> </tr> </tbody> </table> </section> </section> <section id="DocsExtensionPoint"> <h2 id="docsextensionpoint" data-text="DocsExtensionPoint" tabindex="-1">DocsExtensionPoint</h2> <section id="DocsExtensionPoint.description"> <p>Common format for declaring a Docs add-on's triggers.</p> </section> <section id="DocsExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="DocsExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="DocsExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="DocsExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when this extension point is activated.</p> </td> </tr> </tbody> </table> </section> </section> <section id="LinkPreviewExtensionPoint"> <h2 id="linkpreviewextensionpoint" data-text="LinkPreviewExtensionPoint" tabindex="-1">LinkPreviewExtensionPoint</h2> <section id="LinkPreviewExtensionPoint.description"> <p>The configuration for a trigger that fires when a user types or pastes a link from a third-party or non-Google service into a Google Docs, Sheets, or Slides file.</p> </section> <section id="LinkPreviewExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"labelText"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"localizedLabelText"</span><span class="pun">: </span><span class="pun">{</span> <span class="str">string</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="kwd">...</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"patterns"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UriPattern">UriPattern</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span><span class="pun">,</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"logoUrl"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="LinkPreviewExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="LinkPreviewExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="LinkPreviewExtensionPoint.FIELDS.labelText"> <td><code translate="no" dir="ltr">label<wbr>Text</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The text for an example smart chip that prompts users to preview the link, such as <code translate="no" dir="ltr">Example: Support case</code>. This text is static and displays before users execute the add-on.</p> </td> </tr> <tr id="LinkPreviewExtensionPoint.FIELDS.localizedLabelText"> <td><code translate="no" dir="ltr">localized<wbr>Label<wbr>Text</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">map (key: string, value: string)</code></p> <p>Optional. A map of <code translate="no" dir="ltr">labeltext</code> to localize into other languages. Format the language in <a href="https://wikipedia.org/wiki/ISO_639_macrolanguage">ISO 639</a> and the country/region in <a href="https://wikipedia.org/wiki/ISO_3166">ISO 3166</a>, separated by a hyphen <code translate="no" dir="ltr">-</code>. For example, <code translate="no" dir="ltr">en-US</code>.</p><p>If a user's locale is present in the map's keys, the user sees the localized version of the <code translate="no" dir="ltr">labeltext</code>.</p><p>An object containing a list of <code translate="no" dir="ltr">"key": value</code> pairs. Example: <code translate="no" dir="ltr">{ "name": "wrench", "mass": "1.3kg", "count": "3" }</code>.</p> </td> </tr> <tr id="LinkPreviewExtensionPoint.FIELDS.patterns"> <td><code translate="no" dir="ltr">patterns[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#UriPattern">UriPattern</a></code>)</code></p> <p>Required. An array of URL patterns that trigger the add-on to preview links.</p> </td> </tr> <tr id="LinkPreviewExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. Endpoint to execute when a link preview is triggered.</p> </td> </tr> <tr id="LinkPreviewExtensionPoint.FIELDS.logoUrl"> <td><code translate="no" dir="ltr">logo<wbr>Url</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Optional. The icon that displays in the smart chip and preview card. If omitted, the add-on uses its toolbar icon, <a href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments#CommonAddOnManifest.FIELDS.logoUrl"><code translate="no" dir="ltr">logourl</code></a>.</p> </td> </tr> </tbody> </table> </section> </section> <section id="UriPattern"> <h2 id="uripattern" data-text="UriPattern" tabindex="-1">UriPattern</h2> <section id="UriPattern.description"> <p>The configuration for each URL pattern that triggers a link preview.</p> </section> <section id="UriPattern.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"hostPattern"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"pathPrefix"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="UriPattern.FIELDS"> <table class="properties responsive fixed" id="UriPattern.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="UriPattern.FIELDS.hostPattern"> <td><code translate="no" dir="ltr">host<wbr>Pattern</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required for each URL pattern to preview. The domain of the URL pattern. The add-on previews links that contain this domain in the URL. To preview links for a specific subdomain, like <code translate="no" dir="ltr">subdomain.example.com</code>, include the subdomain. To preview links for the entire domain, specify a wildcard character with an asterisk (<code translate="no" dir="ltr">*</code>) as the subdomain.</p><p>For example, <code translate="no" dir="ltr">*.example.com</code> matches <code translate="no" dir="ltr">subdomain.example.com</code> and <code translate="no" dir="ltr">another.subdomain.example.com</code>.</p> </td> </tr> <tr id="UriPattern.FIELDS.pathPrefix"> <td><code translate="no" dir="ltr">path<wbr>Prefix</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Optional. The path that appends the domain of the <code translate="no" dir="ltr">hostpattern</code>.</p><p>For example, if the URL host pattern is <code translate="no" dir="ltr">support.example.com</code>, to match URLs for cases hosted at <code translate="no" dir="ltr">support.example.com/cases/</code>, enter <code translate="no" dir="ltr">cases</code>.</p><p>To match all URLs in the host pattern domain, leave <code translate="no" dir="ltr">pathprefix</code> empty.</p> </td> </tr> </tbody> </table> </section> </section> <section id="CreateActionExtensionPoint"> <h2 id="createactionextensionpoint" data-text="CreateActionExtensionPoint" tabindex="-1">CreateActionExtensionPoint</h2> <section id="CreateActionExtensionPoint.description"> <p>The configuration for a trigger that fires when a user invokes the resource creation workflow in a Google Workspace application. For more information, see <a href="https://developers.google.com/workspace/add-ons/guides/create-insert-resource-smart-chip">Create third-party resources from the @ menu</a>.</p> </section> <section id="CreateActionExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"id"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"labelText"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"localizedLabelText"</span><span class="pun">: </span><span class="pun">{</span> <span class="str">string</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="kwd">...</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span><span class="pun">,</span> <span class="str">"logoUrl"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="CreateActionExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="CreateActionExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="CreateActionExtensionPoint.FIELDS.id"> <td><code translate="no" dir="ltr">id</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The unique ID to differentiate this extension point. The ID can have up to 64 characters and should be in the format of <code translate="no" dir="ltr">[a-zA-Z0-9-]+</code>.</p> </td> </tr> <tr id="CreateActionExtensionPoint.FIELDS.labelText"> <td><code translate="no" dir="ltr">label<wbr>Text</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The text that displays alongside an icon for the resource creation entry point, such as <code translate="no" dir="ltr">Create support case</code>. This text is static and displays before users execute the add-on.</p> </td> </tr> <tr id="CreateActionExtensionPoint.FIELDS.localizedLabelText"> <td><code translate="no" dir="ltr">localized<wbr>Label<wbr>Text</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">map (key: string, value: string)</code></p> <p>Optional. A map of <code translate="no" dir="ltr">labeltext</code> to localize into other languages. Format the language in <a href="https://wikipedia.org/wiki/ISO_639_macrolanguage">ISO 639</a> and the country/region in <a href="https://wikipedia.org/wiki/ISO_3166">ISO 3166</a>, separated by a hyphen <code translate="no" dir="ltr">-</code>. For example, <code translate="no" dir="ltr">en-US</code>.</p><p>If a user's locale is present in the map's keys, the user sees the localized version of the <code translate="no" dir="ltr">labeltext</code>.</p><p>An object containing a list of <code translate="no" dir="ltr">"key": value</code> pairs. Example: <code translate="no" dir="ltr">{ "name": "wrench", "mass": "1.3kg", "count": "3" }</code>.</p> </td> </tr> <tr id="CreateActionExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. Endpoint to execute when a resource creation workflow is triggered to create a link.</p> </td> </tr> <tr id="CreateActionExtensionPoint.FIELDS.logoUrl"> <td><code translate="no" dir="ltr">logo<wbr>Url</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Optional. The icon that displays for the resource creation entry point. If omitted, the menu uses your add-on's toolbar icon, <a href="https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.deployments#CommonAddOnManifest.FIELDS.logoUrl"><code translate="no" dir="ltr">logourl</code></a>.</p> </td> </tr> </tbody> </table> </section> </section> <section id="SheetsAddOnManifest"> <h2 id="sheetsaddonmanifest" data-text="SheetsAddOnManifest" tabindex="-1">SheetsAddOnManifest</h2> <section id="SheetsAddOnManifest.description"> <p>Properties customizing the appearance and execution of a Google Sheets add-on.</p> </section> <section id="SheetsAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"onFileScopeGrantedTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SheetsExtensionPoint">SheetsExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"linkPreviewTriggers"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="SheetsAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="SheetsAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="SheetsAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>If present, this overrides the configuration from <code translate="no" dir="ltr">addons.common.homepageTrigger</code>.</p> </td> </tr> <tr id="SheetsAddOnManifest.FIELDS.onFileScopeGrantedTrigger"> <td><code translate="no" dir="ltr">on<wbr>File<wbr>Scope<wbr>Granted<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SheetsExtensionPoint">SheetsExtensionPoint</a></code>)</code></p> <p>Endpoint to execute when file scope authorization is granted for this document/user pair.</p> </td> </tr> <tr id="SheetsAddOnManifest.FIELDS.linkPreviewTriggers"> <td><code translate="no" dir="ltr">link<wbr>Preview<wbr>Triggers[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a></code>)</code></p> <p>A list of extension points for previewing links in a Google Sheets document. For details, see <a href="https://developers.google.com/workspace/add-ons/guides/preview-links-smart-chips">Preview links with smart chips</a>.</p> </td> </tr> </tbody> </table> </section> </section> <section id="SheetsExtensionPoint"> <h2 id="sheetsextensionpoint" data-text="SheetsExtensionPoint" tabindex="-1">SheetsExtensionPoint</h2> <section id="SheetsExtensionPoint.description"> <p>Common format for declaring a Sheets add-on's triggers.</p> </section> <section id="SheetsExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="SheetsExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="SheetsExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="SheetsExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when this extension point is activated.</p> </td> </tr> </tbody> </table> </section> </section> <section id="SlidesAddOnManifest"> <h2 id="slidesaddonmanifest" data-text="SlidesAddOnManifest" tabindex="-1">SlidesAddOnManifest</h2> <section id="SlidesAddOnManifest.description"> <p>Properties customizing the appearance and execution of a Google Slides add-on.</p> </section> <section id="SlidesAddOnManifest.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"homepageTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"onFileScopeGrantedTrigger"</span><span class="pun">: </span><span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SlidesExtensionPoint">SlidesExtensionPoint</a></code>)</span> <span class="pun">}</span><span class="pun">,</span> <span class="str">"linkPreviewTriggers"</span><span class="pun">: </span><span class="pun">[</span> <span class="pun">{</span> <span class="kwd">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a></code>)</span> <span class="pun">}</span> <span class="pun">]</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="SlidesAddOnManifest.FIELDS"> <table class="properties responsive fixed" id="SlidesAddOnManifest.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="SlidesAddOnManifest.FIELDS.homepageTrigger"> <td><code translate="no" dir="ltr">homepage<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HomepageExtensionPoint">HomepageExtensionPoint</a></code>)</code></p> <p>If present, this overrides the configuration from <code translate="no" dir="ltr">addons.common.homepageTrigger</code>.</p> </td> </tr> <tr id="SlidesAddOnManifest.FIELDS.onFileScopeGrantedTrigger"> <td><code translate="no" dir="ltr">on<wbr>File<wbr>Scope<wbr>Granted<wbr>Trigger</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#SlidesExtensionPoint">SlidesExtensionPoint</a></code>)</code></p> <p>Endpoint to execute when file scope authorization is granted for this document/user pair.</p> </td> </tr> <tr id="SlidesAddOnManifest.FIELDS.linkPreviewTriggers"> <td><code translate="no" dir="ltr">link<wbr>Preview<wbr>Triggers[]</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#LinkPreviewExtensionPoint">LinkPreviewExtensionPoint</a></code>)</code></p> <p>A list of extension points for previewing links in a Google Slides document. For details, see <a href="https://developers.google.com/workspace/add-ons/guides/preview-links-smart-chips">Preview links with smart chips</a>.</p> </td> </tr> </tbody> </table> </section> </section> <section id="SlidesExtensionPoint"> <h2 id="slidesextensionpoint" data-text="SlidesExtensionPoint" tabindex="-1">SlidesExtensionPoint</h2> <section id="SlidesExtensionPoint.description"> <p>Common format for declaring a Slides add-on's triggers.</p> </section> <section id="SlidesExtensionPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"runFunction"</span><span class="pun">: </span><span class="kwd">string</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="SlidesExtensionPoint.FIELDS"> <table class="properties responsive fixed" id="SlidesExtensionPoint.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="SlidesExtensionPoint.FIELDS.runFunction"> <td><code translate="no" dir="ltr">run<wbr>Function</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">string</code></p> <p>Required. The endpoint to execute when this extension point is activated.</p> </td> </tr> </tbody> </table> </section> </section> <section id="HttpOptions"> <h2 id="httpoptions" data-text="HttpOptions" tabindex="-1">HttpOptions</h2> <section id="HttpOptions.description"> <p>Options for sending requests to add-on <code translate="no" dir="ltr">HTTP</code> endpoints.</p> </section> <section id="HttpOptions.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded><span class="pun">{</span> <span class="str">"authorizationHeader"</span><span class="pun">: </span><span class="kwd">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HttpAuthorizationHeader">HttpAuthorizationHeader</a></code>)</span> <span class="pun">}</span></pre></devsite-code></td> </tr> </tbody> </table> </section> <section id="HttpOptions.FIELDS"> <table class="properties responsive fixed" id="HttpOptions.FIELDS-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <tbody> <tr id="HttpOptions.FIELDS.authorizationHeader"> <td><code translate="no" dir="ltr">authorization<wbr>Header</code></td> <td> <p><code class="apitype" translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments#HttpAuthorizationHeader">HttpAuthorizationHeader</a></code>)</code></p> <p>Configuration for the token sent in the <code translate="no" dir="ltr">HTTP</code> Authorization header.</p> </td> </tr> </tbody> </table> </section> </section> <section id="HttpAuthorizationHeader"> <h2 id="httpauthorizationheader" data-text="HttpAuthorizationHeader" tabindex="-1">HttpAuthorizationHeader</h2> <section id="HttpAuthorizationHeader.description"> <p>Authorization header sent in add-on <code translate="no" dir="ltr">HTTP</code> requests.</p> </section> <section id="HttpAuthorizationHeader.ENUM_VALUES"> <table class="constants responsive fixed" id="HttpAuthorizationHeader.ENUM_VALUES-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="HttpAuthorizationHeader.ENUM_VALUES.HTTP_AUTHORIZATION_HEADER_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">HTTP_AUTHORIZATION_HEADER_UNSPECIFIED</code></td> <td>Default value, equivalent to <code translate="no" dir="ltr">SYSTEM_ID_TOKEN</code>.</td> </tr> <tr id="HttpAuthorizationHeader.ENUM_VALUES.SYSTEM_ID_TOKEN"> <td><code class="apitype" translate="no" dir="ltr">SYSTEM_ID_TOKEN</code></td> <td>Send an ID token for the project-specific Google Workspace Add-on's system service account (default).</td> </tr> <tr id="HttpAuthorizationHeader.ENUM_VALUES.USER_ID_TOKEN"> <td><code class="apitype" translate="no" dir="ltr">USER_ID_TOKEN</code></td> <td>Send an ID token for the end user.</td> </tr> <tr id="HttpAuthorizationHeader.ENUM_VALUES.NONE"> <td><code class="apitype" translate="no" dir="ltr">NONE</code></td> <td>Do not send an Authentication header.</td> </tr> </tbody> </table> </section> </section> <section id="METHODS_SUMMARY"> <table class="methods responsive fixed" id="METHODS_SUMMARY-table"> <colgroup> <col width="25%"> <col> </colgroup> <thead> <tr> <th colspan="2"><h2 id="methods" data-text="Methods" tabindex="-1">Methods</h2></th> </tr> </thead> <tbody> <tr> <td> <h3 id="create" data-text="create" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/create">create</a></code></h3></td> <td> Creates a deployment with the specified name and configuration.</td> </tr> <tr> <td> <h3 id="delete" data-text="delete" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/delete">delete</a></code></h3></td> <td> Deletes the deployment with the given name.</td> </tr> <tr> <td> <h3 id="get" data-text="get" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/get">get</a></code></h3></td> <td> Gets the deployment with the specified name.</td> </tr> <tr> <td> <h3 id="getinstallstatus" data-text="getInstallStatus" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus">get<wbr>Install<wbr>Status</wbr></wbr></a></code></h3></td> <td> Gets the install status of a test deployment.</td> </tr> <tr> <td> <h3 id="install" data-text="install" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/install">install</a></code></h3></td> <td> Installs a deployment to your account for testing.</td> </tr> <tr> <td> <h3 id="list" data-text="list" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/list">list</a></code></h3></td> <td> Lists all deployments in a particular project.</td> </tr> <tr> <td> <h3 id="replacedeployment" data-text="replaceDeployment" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment">replace<wbr>Deployment</wbr></a></code></h3></td> <td> Creates or replaces a deployment with the specified name.</td> </tr> <tr> <td> <h3 id="uninstall" data-text="uninstall" tabindex="-1"><code translate="no" dir="ltr"><a href="/workspace/add-ons/reference/rest/v1/projects.deployments/uninstall">uninstall</a></code></h3></td> <td> Uninstalls a test deployment from the user’s account.</td> </tr> </tbody> </table> </section> </section> <devsite-hats-survey class="nocontent" hats-id="3KyAora5x0eGRuQsCn30V8okzuYm" listnr-id="717201"></devsite-hats-survey> </div> <devsite-thumb-rating position="footer"> </devsite-thumb-rating> <devsite-feedback position="footer" project-name="Google Workspace Add-ons" product-id="717201" bucket="add-ons" context="" version="t-devsite-webserver-20241114-r00-rc02.464922260396498922" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="footer" class="nocontent" project-feedback-url="https://issuetracker.google.com/issues/new?component=642720&template=1392206" project-icon="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/touchicon-180-new.png" project-support-url="https://developers.google.com/workspace/add-ons/workspace-support" > <button> Send feedback </button> </devsite-feedback> <div class="devsite-floating-action-buttons"> </div> </article> <devsite-content-footer class="nocontent"> <p>Except as otherwise noted, the content of this page is licensed under the <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 License</a>, and code samples are licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 License</a>. For details, see the <a href="https://developers.google.com/site-policies">Google Developers Site Policies</a>. Java is a registered trademark of Oracle and/or its affiliates.</p> <p>Last updated 2024-10-21 UTC.</p> </devsite-content-footer> <devsite-notification > </devsite-notification> <div class="devsite-content-data"> <template class="devsite-thumb-rating-feedback"> <devsite-feedback position="thumb-rating" project-name="Google Workspace Add-ons" product-id="717201" bucket="add-ons" context="" version="t-devsite-webserver-20241114-r00-rc02.464922260396498922" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="thumb-rating" class="nocontent" project-feedback-url="https://issuetracker.google.com/issues/new?component=642720&template=1392206" project-icon="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/touchicon-180-new.png" project-support-url="https://developers.google.com/workspace/add-ons/workspace-support" > <button> Need to tell us more? </button> </devsite-feedback> </template> <template class="devsite-content-data-template"> [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-21 UTC."],[],[]] </template> </div> </devsite-content> </main> <devsite-footer-promos class="devsite-footer"> <nav class="devsite-footer-promos nocontent" aria-label="Promotions"> <ul class="devsite-footer-promos-list"> <li class="devsite-footer-promo"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank" data-label="Promo - Google Workspace Developers Blog" data-category="Workspace Footer" > <picture> <img class="devsite-footer-promo-icon" src="https://www.gstatic.com/images/branding/product/2x/google_cloud_64dp.png" loading="lazy" alt="Blog"> </picture> <span class="devsite-footer-promo-label"> Blog </span> </a> <div class="devsite-footer-promo-description">Read the Google Workspace Developers blog</div> </li> <li class="devsite-footer-promo"> <a href="https://twitter.com/workspacedevs" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Promo - Google Workspace on X (Twitter)" target="_blank" data-category="Workspace Footer" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-x.svg" loading="lazy" alt="X (Twitter)"> </picture> <span class="devsite-footer-promo-label"> X (Twitter) </span> </a> <div class="devsite-footer-promo-description">Follow @workspacedevs on X (Twitter)</div> </li> <li class="devsite-footer-promo"> <a href="https://github.com/googleworkspace" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer" data-label="Promo - Google Workspace Github" target="_blank" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-github.svg" loading="lazy" alt="Code Samples"> </picture> <span class="devsite-footer-promo-label"> Code Samples </span> </a> <div class="devsite-footer-promo-description">Explore our sample apps or copy them to build your own</div> </li> <li class="devsite-footer-promo"> <a href="https://codelabs.developers.google.com/?product=googleworkspace" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Promo - Google Workspace Codelabs" data-category="Workspace Footer" target="_blank" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/developers-logo-color.svg" loading="lazy" alt="Codelabs"> </picture> <span class="devsite-footer-promo-label"> Codelabs </span> </a> <div class="devsite-footer-promo-description">Try a guided, hands-on coding experience</div> </li> <li class="devsite-footer-promo"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank" data-category="Workspace Footer" data-label="Promo - Google Workspace on YouTube" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-youtube.svg" loading="lazy" alt="Videos"> </picture> <span class="devsite-footer-promo-label"> Videos </span> </a> <div class="devsite-footer-promo-description">Subscribe to our YouTube channel</div> </li> </ul> </nav> </devsite-footer-promos> <devsite-footer-linkboxes class="devsite-footer"> <nav class="devsite-footer-linkboxes nocontent" aria-label="Footer links"> <ul class="devsite-footer-linkboxes-list"> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Google Workspace for Developers</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="/workspace" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Platform overview"data-category="Workspace Footer"> Platform overview </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/products" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Developer products"> Developer products </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/support" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Developer support"> Developer support </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/terms" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Terms of Service"> Terms of Service </a> </li> </ul> </li> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Tools</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="https://admin.google.com/" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Linkbox - Admin console"target="admin-console"data-category="Workspace Footer"> Admin console </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://script.google.com/" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" target="_blank"data-category="Workspace Footer"data-label="Linkbox - Apps Script Dashboard"> Apps Script Dashboard </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://console.cloud.google.com/workspace-api" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" target="console"data-label="Linkbox - Google Cloud console"data-category="Workspace Footer"> Google Cloud console </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/explore" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - APIs Explorer"> APIs Explorer </a> </li> </ul> </li> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Connect</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="https://developers.googleblog.com/search/?query=Google+Workspace" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Blog"target="_blank"> Blog </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/workspace/newsletters" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - Newsletter"> Newsletter </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://twitter.com/workspacedevs" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"data-label="Linkbox - X (Twitter)"target="_blank"> X (Twitter) </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://www.youtube.com/channel/UCUcg6az6etU_gRtZVAhBXaw" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-category="Workspace Footer"target="_blank"data-label="Linkbox - YouTube"> YouTube </a> </li> </ul> </li> </ul> </nav> </devsite-footer-linkboxes> <devsite-footer-utility class="devsite-footer"> <div class="devsite-footer-utility nocontent"> <nav class="devsite-footer-sites" aria-label="Other Google Developers websites"> <a href="https://developers.google.com/" class="devsite-footer-sites-logo-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google Developers Link"> <picture> <img class="devsite-footer-sites-logo" src="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/lockup-google-for-developers.svg" loading="lazy" alt="Google Developers"> </picture> </a> <ul class="devsite-footer-sites-list"> <li class="devsite-footer-sites-item"> <a href="//developer.android.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Android Link" > Android </a> </li> <li class="devsite-footer-sites-item"> <a href="//developer.chrome.com/home" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Chrome Link" > Chrome </a> </li> <li class="devsite-footer-sites-item"> <a href="//firebase.google.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Firebase Link" > Firebase </a> </li> <li class="devsite-footer-sites-item"> <a href="//cloud.google.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google Cloud Platform Link" > Google Cloud Platform </a> </li> <li class="devsite-footer-sites-item"> <a href="//ai.google.dev/" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google AI Link" > Google AI </a> </li> <li class="devsite-footer-sites-item"> <a href="/products" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer All products Link" > All products </a> </li> </ul> </nav> <nav class="devsite-footer-utility-links" aria-label="Utility links"> <ul class="devsite-footer-utility-list"> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="/terms/site-terms" data-category="Site-Wide Custom Events" data-label="Footer Terms link" > Terms </a> </li> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="//policies.google.com/privacy" data-category="Site-Wide Custom Events" data-label="Footer Privacy link" > Privacy </a> </li> <li class="devsite-footer-utility-item glue-cookie-notification-bar-control"> <a class="devsite-footer-utility-link gc-analytics-event" href="#" data-category="Site-Wide Custom Events" data-label="Footer Manage cookies link" aria-hidden="true" > Manage cookies </a> </li> <li class="devsite-footer-utility-item devsite-footer-utility-button"> <span class="devsite-footer-utility-description">Sign up for the Google for Developers newsletter</span> <a class="devsite-footer-utility-link gc-analytics-event" href="/newsletter/subscribe" data-category="Site-Wide Custom Events" data-label="Footer Subscribe link" > Subscribe </a> </li> </ul> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es" >Español</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> </nav> </div> </devsite-footer-utility> <devsite-panel></devsite-panel> <devsite-concierge data-info-panel data-ai-panel data-api-explorer-panel > </devsite-concierge> </section></section> <devsite-sitemask></devsite-sitemask> <devsite-snackbar></devsite-snackbar> <devsite-tooltip ></devsite-tooltip> <devsite-heading-link></devsite-heading-link> <devsite-analytics> <script type="application/json" analytics>[{"dimensions": {"dimension5": "en", "dimension4": "Google Workspace Add-ons", "dimension3": false, "dimension6": "en", "dimension11": false, "dimension1": "Signed out"}, "gaid": "UA-24532603-1", "metrics": {"ratings_count": "metric2", "ratings_value": "metric1"}, "purpose": 1}]</script> <script type="application/json" tag-management>{"at": "True", "ga4": [{"id": "G-272J68FCRF", "purpose": 1}, {"id": "G-YYP88VSJWR", "purpose": 0}], "ga4p": [{"id": "G-272J68FCRF", "purpose": 1}], "gtm": [], "parameters": {"internalUser": "False", "language": {"machineTranslated": "False", "requested": "en", "served": "en"}, "pageType": "reference", "projectName": "Google Workspace Add-ons", "signedIn": "False", "tenant": "developers", "recommendations": {"sourcePage": "", "sourceType": 0, "sourceRank": 0, "sourceIdenticalDescriptions": 0, "sourceTitleWords": 0, "sourceDescriptionWords": 0, "experiment": ""}, "experiment": {"ids": ""}}}</script> </devsite-analytics> <devsite-badger></devsite-badger> <script nonce="jIZLQH7KnOclAKXziUphXTtCFaLTdH"> (function(d,e,v,s,i,t,E){d['GoogleDevelopersObject']=i; t=e.createElement(v);t.async=1;t.src=s;E=e.getElementsByTagName(v)[0]; E.parentNode.insertBefore(t,E);})(window, document, 'script', 'https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/js/app_loader.js', '[1,"en",null,"/js/devsite_app_module.js","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers","https://developers-dot-devsite-v2-prod.appspot.com",null,null,["/_pwa/developers/manifest.json","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/images/video-placeholder.svg","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/favicon-new.png","https://fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"],1,null,[1,6,8,12,14,17,21,25,50,52,63,70,75,76,80,87,91,92,93,97,98,100,101,102,103,104,105,107,108,109,110,112,113,116,117,118,120,122,124,125,126,127,129,130,131,132,133,134,135,136,138,140,141,147,148,149,151,152,156,157,158,159,161,163,164,168,169,170,179,180,182,183,186,191,193,196],"AIzaSyAP-jjEJBzmIyKR4F-3XITp8yM9T1gEEI8","AIzaSyB6xiKGDR5O3Ak2okS4rLkauxGUG7XP0hg","developers.google.com","AIzaSyAQk0fBONSGUqCNznf6Krs82Ap1-NV6J4o","AIzaSyCCxcqdrZ_7QMeLCRY20bh_SXdAYqy70KY",null,null,null,["Profiles__enable_recognition_badges","Cloud__enable_cloudx_ping","Analytics__enable_clearcut_logging","Profiles__enable_page_saving","CloudShell__cloud_code_overflow_menu","MiscFeatureFlags__enable_project_variables","Search__enable_page_map","Cloud__enable_cloud_dlp_service","Cloud__enable_cloud_shell_fte_user_flow","EngEduTelemetry__enable_engedu_telemetry","Profiles__require_profile_eligibility_for_signin","TpcFeatures__enable_mirror_tenant_redirects","Profiles__enable_completecodelab_endpoint","Search__enable_ai_search_summaries_restricted","MiscFeatureFlags__developers_footer_image","Cloud__enable_cloud_shell","Profiles__enable_public_developer_profiles","Cloud__enable_llm_concierge_chat","Significatio__enable_by_tenant","MiscFeatureFlags__enable_view_transitions","Concierge__enable_concierge_restricted","BookNav__enable_tenant_cache_key","Concierge__enable_concierge","MiscFeatureFlags__emergency_css","MiscFeatureFlags__enable_firebase_utm","Cloud__enable_cloudx_experiment_ids","Profiles__enable_profile_collections","Search__enable_ai_search_summaries","Search__enable_ai_eligibility_checks","Search__enable_suggestions_from_borg","Profiles__enable_release_notes_notifications","MiscFeatureFlags__enable_explain_this_code","Cloud__enable_cloud_facet_chat","TpcFeatures__enable_required_headers","DevPro__enable_developer_subscriptions","Search__enable_dynamic_content_confidential_banner","Cloud__enable_legacy_calculator_redirect","CloudShell__cloud_shell_button","DevPro__enable_cloud_innovators_plus","MiscFeatureFlags__developers_footer_dark_image","Concierge__enable_pushui","Experiments__reqs_query_experiments","Profiles__enable_awarding_url","MiscFeatureFlags__enable_variable_operator","Profiles__enable_developer_profiles_callout","Profiles__enable_dashboard_curated_recommendations","Profiles__enable_complete_playlist_endpoint","Cloud__enable_free_trial_server_call"],null,null,"AIzaSyBLEMok-5suZ67qRPzx0qUtbnLmyT_kCVE","https://developerscontentserving-pa.clients6.google.com","AIzaSyCM4QpTRSqP5qI4Dvjt4OAScIN8sOUlO-k","https://developerscontentsearch-pa.clients6.google.com",1,4,null,"https://developerprofiles-pa.clients6.google.com",[1,"developers","Google for Developers","developers.google.com",null,"developers-dot-devsite-v2-prod.appspot.com",null,null,[1,1,[1],null,null,null,null,null,null,null,null,[1],null,null,null,null,null,null,[1],[1,null,null,[1,20],"/recommendations/information"],null,null,null,[1,1,1],[1,1,null,1,1]],null,[null,null,null,null,null,null,"/images/lockup-new.svg","/images/touchicon-180-new.png",null,null,null,null,1,null,null,null,null,null,null,null,null,1,null,null,null,"/images/lockup-dark-theme-new.svg",[]],[],null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,[6,1,14,15,20,22,23,29,32,36],null,[[null,null,null,[3,7,10,2,39,17,4,32,24,11,12,13,34,15,25],null,null,[1,[["docType","Choose a content type",[["Tutorial",null,null,null,null,null,null,null,null,"Tutorial"],["Guide",null,null,null,null,null,null,null,null,"Guide"],["Sample",null,null,null,null,null,null,null,null,"Sample"]]],["product","Choose a product",[["Android",null,null,null,null,null,null,null,null,"Android"],["ARCore",null,null,null,null,null,null,null,null,"ARCore"],["ChromeOS",null,null,null,null,null,null,null,null,"ChromeOS"],["Firebase",null,null,null,null,null,null,null,null,"Firebase"],["Flutter",null,null,null,null,null,null,null,null,"Flutter"],["Assistant",null,null,null,null,null,null,null,null,"Google Assistant"],["GoogleCloud",null,null,null,null,null,null,null,null,"Google Cloud"],["GoogleMapsPlatform",null,null,null,null,null,null,null,null,"Google Maps Platform"],["GooglePay",null,null,null,null,null,null,null,null,"Google Pay & Google Wallet"],["GooglePlay",null,null,null,null,null,null,null,null,"Google Play"],["Tensorflow",null,null,null,null,null,null,null,null,"TensorFlow"]]],["category","Choose a topic",[["AiAndMachineLearning",null,null,null,null,null,null,null,null,"AI and Machine Learning"],["Data",null,null,null,null,null,null,null,null,"Data"],["Enterprise",null,null,null,null,null,null,null,null,"Enterprise"],["Gaming",null,null,null,null,null,null,null,null,"Gaming"],["Mobile",null,null,null,null,null,null,null,null,"Mobile"],["Web",null,null,null,null,null,null,null,null,"Web"]]]]]],[1,1],null,1],[[["UA-24532603-1"],["UA-22084204-5"],null,null,["UA-24532603-5"],null,null,[["G-272J68FCRF"],null,null,[["G-272J68FCRF",2]]],[["UA-24532603-1",2]],null,[["UA-24532603-5",2]],null,1],[[3,2],[13,10],[11,8],[16,13],[1,1],[5,4],[4,3],[14,11],[15,12],[6,5],[12,9]],[[1,1],[2,2]]],null,4,null,null,null,null,null,null,null,null,null,null,null,null,null,"developers.devsite.google"],null,"pk_live_5170syrHvgGVmSx9sBrnWtA5luvk9BwnVcvIi7HizpwauFG96WedXsuXh790rtij9AmGllqPtMLfhe2RSwD6Pn38V00uBCydV4m"]') </script> <devsite-a11y-announce></devsite-a11y-announce> </body> </html>

CINXE.COM

REST Resource: projects.deployments | Google Workspace Add-ons | Google for Developers