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 comportent des boutons remplis et des boutons désactivés.
PERSISTENT_FORMS Les formulaires persistants permettent de conserver des valeurs de formulaire pendant les actions.
UPDATE_SUBJECT_AND_RECIPIENTS Modifiez l'objet et les destinataires d'un brouillon.
GRID_WIDGET Le widget Grille
ADDON_COMPOSE_UI_ACTION Action du module complémentaire Gmail qui s'applique à l'interface utilisateur de rédaction du module complémentaire.

CommonAddOnManifest

Configuration du module complémentaire partagée entre toutes les applications hôtes des 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 des fiches 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 s'il faut transmettre les informations sur les paramètres régionaux à partir de l'application hôte.

homepageTrigger

HomepageExtensionPoint

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

universalActions[]

UniversalActionExtensionPoint

Définit la liste des 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 de lien à ouvrir ou un point de terminaison à exécuter pour l'envoi d'un 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é. HTTP liens sont automatiquement transformés en liens HTTPS.

CreateActionExtensionPoint

Configuration d'un déclencheur qui s'active 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 la 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. Formatez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant par un trait d'union -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, l'utilisateur 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 qui s'affiche pour le point d'entrée de création de la ressource. En cas d'omission, le menu utilise l'icône de la barre d'outils de votre module complémentaire logoUrl.

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 false, désactive la vue de la page d'accueil dans ce contexte.

Si cette règle n'est pas configurée, la valeur par défaut est true.

Si l'affichage personnalisé de la page d'accueil d'un module complémentaire est désactivé, une fiche récapitulative générique s'affiche à la place.

HttpAuthorizationHeader

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

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Valeur par défaut, équivalente à SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Envoyer un jeton d'ID 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'ID pour l'utilisateur final.
NONE N'envoyez pas d'en-tête "Authentication".

HttpOptions

Options d'envoi de requêtes aux points de terminaison HTTP des modules complémentaires.

Champs
authorizationHeader

HttpAuthorizationHeader

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

LayoutProperties

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

Champs
primaryColor

string

Couleur principale du module complémentaire. Elle définit la couleur de la barre d'outils. Si aucune couleur principale 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 qu'aucune couleur secondaire n'est définie, la couleur secondaire est identique à la couleur principale. Si aucune couleur principale ni de couleur secondaire n'est définie, la valeur par défaut fournie par le framework est utilisée.

useNewMaterialDesign

bool

Active Material Design pour les cartes.

LinkPreviewExtensionPoint

Configuration d'un déclencheur qui s'active lorsqu'un utilisateur saisit ou colle un lien d'un service tiers ou autre que 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 (Example: Support case, par exemple). 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. Formatez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant par un trait d'union -. Par exemple, en-US.

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

patterns[]

UriPattern

Obligatoire. Tableau de formats d'URL qui déclenchent l'envoi d'un lien d'aperçu 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 l'icône de sa barre d'outils : logoUrl.

Format courant pour déclarer un élément de menu ou un bouton qui apparaît 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 qui décrit l'action entreprise 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 cette règle n'est pas configurée, l'URL principale du logo du module complémentaire est utilisée par défaut.

UniversalActionExtensionPoint

Format permettant de déclarer un point d'extension d'élément de menu d'actions universel.

Champs
label

string

Obligatoire. Texte visible par l'utilisateur qui décrit l'action entreprise 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'actions 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 affiche un aperçu des liens qui contiennent ce domaine dans l'URL. Pour prévisualiser les liens d'un sous-domaine spécifique, tel que subdomain.example.com, incluez-le. Pour prévisualiser des liens sur 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'URL d'hôte est support.example.com, saisissez cases pour correspondre aux 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.