Package google.apps.script.type

Index

AddOnWidgetSet

Sous-ensemble de widgets utilisé par un module complémentaire.

Champs
usedWidgets[]

WidgetType

Liste des widgets utilisés dans un module complémentaire.

WidgetType

Type de widget. WIDGET_TYPE_UNSPECIFIED est l'ensemble de widgets de base.

Enums
WIDGET_TYPE_UNSPECIFIED Ensemble de widgets par défaut.
DATE_PICKER Sélecteur de date.
STYLED_BUTTONS Les boutons stylisés incluent les boutons remplis et les boutons désactivés.
PERSISTENT_FORMS Les formulaires persistants permettent de conserver les valeurs des formulaires lors des actions.
UPDATE_SUBJECT_AND_RECIPIENTS Modifiez l'objet et les destinataires d'un brouillon.
GRID_WIDGET Widget Grille.
ADDON_COMPOSE_UI_ACTION Action de module complémentaire Gmail qui s'applique à l'UI de rédaction du module complémentaire.

CommonAddOnManifest

Configuration du module complémentaire partagée entre toutes les applications hôtes de modules complémentaires.

Champs
name

string

Obligatoire. Nom à afficher du module complémentaire.
logoUrl

string

Obligatoire. URL de l'image du logo affichée dans la barre d'outils du module complémentaire.
layoutProperties

LayoutProperties

Propriétés de mise en page courantes pour les cartes de modules complémentaires.
addOnWidgetSet

AddOnWidgetSet

Widgets utilisés dans le module complémentaire. Si ce champ n'est pas spécifié, l'ensemble par défaut est utilisé.
useLocaleFromApp

bool

Indique si les informations sur les paramètres régionaux doivent être transmises depuis l'application hôte.
homepageTrigger

HomepageExtensionPoint

Définit un point de terminaison qui sera exécuté dans n'importe quel contexte et sur n'importe quel hôte. Toutes les fiches générées par cette fonction seront toujours disponibles pour l'utilisateur, mais elles peuvent être éclipsées par du contenu contextuel lorsque ce module complémentaire déclare des déclencheurs plus ciblés.
universalActions[]

UniversalActionExtensionPoint

Définit une liste de points d'extension dans le menu d'actions universel, qui sert de menu de paramètres pour le module complémentaire. Le point d'extension peut être une URL à ouvrir ou un point de terminaison à exécuter en tant qu'envoi de formulaire.
openLinkUrlPrefixes

ListValue

Une action OpenLink ne peut utiliser qu'une URL avec un schéma HTTPS, MAILTO ou TEL. Pour les liens HTTPS, l'URL doit également correspondre à l'un des préfixes spécifiés dans la liste d'autorisation. Si le préfixe omet le schéma, HTTPS est utilisé. Les liens HTTP sont automatiquement réécrits en liens HTTPS.

CreateActionExtensionPoint

Configuration d'un déclencheur qui se déclenche lorsqu'un utilisateur appelle le workflow de création de ressources dans une application Google Workspace. Pour en savoir plus, consultez Créer des ressources tierces à partir du menu @.

Champs
id

string

Obligatoire. Identifiant unique permettant de différencier ce point d'extension. L'ID peut comporter jusqu'à 64 caractères et doit être au format [a-zA-Z0-9-]+.
labelText

string

Obligatoire. Texte qui s'affiche à côté d'une icône pour le point d'entrée de création de ressource, par exemple Create support case. Ce texte est statique et s'affiche avant que les utilisateurs n'exécutent le module complémentaire.
localizedLabelText

map<string, string>

Facultatif. Carte de labelText à localiser dans d'autres langues. Indiquez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant par un tiret -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, il voit la version localisée de labelText.
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsqu'un workflow de création de ressources est déclenché pour créer un lien.
logoUrl

string

Facultatif. Icône affichée pour le point d'entrée de création de ressources. Si cet élément n'est pas spécifié, le menu utilise l'icône de la barre d'outils de votre module complémentaire, logoUrl.

GranularOauthPermissionSupport

Indique si le module complémentaire a activé le consentement OAuth granulaire.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Valeur par défaut, ne doit pas être utilisée.
OPT_IN Le module complémentaire est activé pour le consentement OAuth granulaire.
OPT_OUT Le module complémentaire est désactivé pour le consentement OAuth granulaire.

HomepageExtensionPoint

Format courant pour déclarer la vue de la page d'accueil d'un module complémentaire.

Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.
enabled

BoolValue

Facultatif. Si la valeur est définie sur false, la vue de la page d'accueil est désactivée dans ce contexte.

La valeur par défaut est true si elle n'est pas définie.

Si la vue personnalisée de la page d'accueil d'un module complémentaire est désactivée, une fiche d'aperçu générique est fournie aux utilisateurs à la place.

HttpAuthorizationHeader

En-tête d'autorisation envoyé dans les requêtes HTTP du module complémentaire.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Valeur par défaut, équivalente à SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Envoyez un jeton d'identification pour le compte de service système du module complémentaire Google Workspace spécifique au projet (par défaut).
USER_ID_TOKEN Envoyez un jeton d'identité pour l'utilisateur final.
NONE N'envoyez pas d'en-tête d'authentification.

HttpOptions

Options permettant d'envoyer des requêtes aux points de terminaison HTTP du module complémentaire.

Champs
authorizationHeader

HttpAuthorizationHeader

Configuration du jeton envoyé dans l'en-tête d'autorisation HTTP.
granularOauthPermissionSupport

GranularOauthPermissionSupport

Indique si le module complémentaire a activé le consentement OAuth granulaire.

LayoutProperties

Propriétés de mise en page des cartes partagées entre toutes les applications hôtes de modules complémentaires.

Champs
primaryColor

string

Couleur principale du module complémentaire. Elle définit la couleur de la barre d'outils. Si aucune couleur primaire n'est définie, la valeur par défaut fournie par le framework est utilisée.
secondaryColor

string

Couleur secondaire du module complémentaire. Elle définit la couleur des boutons. Si la couleur principale est définie, mais pas la couleur secondaire, la couleur secondaire est identique à la couleur principale. Si aucune couleur primaire ni secondaire n'est définie, la valeur par défaut fournie par le framework est utilisée.
useNewMaterialDesign
(deprecated)

bool

Active le Material Design pour les cartes.

LinkPreviewExtensionPoint

Configuration d'un déclencheur qui se déclenche lorsqu'un utilisateur saisit ou colle un lien provenant d'un service tiers ou non Google dans un fichier Google Docs, Sheets ou Slides.

Champs
labelText

string

Obligatoire. Texte d'un exemple de chip intelligent qui invite les utilisateurs à prévisualiser le lien, tel que Example: Support case. Ce texte est statique et s'affiche avant que les utilisateurs n'exécutent le module complémentaire.
localizedLabelText

map<string, string>

Facultatif. Carte de labelText à localiser dans d'autres langues. Indiquez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant par un tiret -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, il voit la version localisée de labelText.
patterns[]

UriPattern

Obligatoire. Tableau de formats d'URL qui déclenchent l'aperçu des liens par le module complémentaire.
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsqu'un aperçu de lien est déclenché.
logoUrl

string

Facultatif. Icône qui s'affiche dans le chip intelligent et la fiche d'aperçu. En cas d'omission, le module complémentaire utilise son icône de barre d'outils, logoUrl.

Format courant pour déclarer un élément de menu ou un bouton qui s'affiche dans une application hôte.

Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.
label

string

Obligatoire. Texte visible par l'utilisateur décrivant l'action effectuée en activant ce point d'extension. Par exemple, "Insérer une facture".
logoUrl

string

URL de l'image du logo affichée dans la barre d'outils du module complémentaire.

Si ce champ n'est pas défini, l'URL du logo principal du module complémentaire est utilisée par défaut.

UniversalActionExtensionPoint

Format pour déclarer un point d'extension d'élément de menu d'action universel.

Champs
label

string

Obligatoire. Texte visible par l'utilisateur qui décrit l'action effectuée en activant ce point d'extension (par exemple, "Ajouter un contact").
Champ d'union action_type. Obligatoire. Type d'action compatible avec un élément de menu d'action universel. Il peut s'agir d'un lien à ouvrir ou d'un point de terminaison à exécuter. action_type ne peut être qu'un des éléments suivants :
runFunction

string

Point de terminaison à exécuter par UniversalAction.

UriPattern

Configuration de chaque format d'URL qui déclenche un aperçu du lien.

Champs
hostPattern

string

Obligatoire pour chaque format d'URL à prévisualiser. Domaine du format d'URL. Le module complémentaire prévisualise les liens qui contiennent ce domaine dans l'URL. Pour prévisualiser les liens d'un sous-domaine spécifique, comme subdomain.example.com, incluez le sous-domaine. Pour prévisualiser les liens pour l'ensemble du domaine, spécifiez un caractère générique avec un astérisque (*) comme sous-domaine.

Par exemple, *.example.com correspond à subdomain.example.com et another.subdomain.example.com.
pathPrefix

string

Facultatif. Chemin d'accès qui ajoute le domaine de hostPattern.

Par exemple, si le format d'hôte de l'URL est support.example.com, saisissez cases pour faire correspondre les URL des demandes hébergées sur support.example.com/cases/.

Pour faire correspondre toutes les URL du domaine du format d'hôte, laissez pathPrefix vide.