AddOns Response Service

Service de réponse aux modules complémentaires

Ce service permet aux scripts de configurer et de créer des modules complémentaires Google Workspace qui étendent Google Workspace Studio.

Classes

Nom	Brève description
Action	Action que les modules complémentaires Google Workspace qui étendent Google Workspace Studio peuvent utiliser pour afficher une nouvelle fiche.
AddOnsResponseService	AddOnsResponseService permet de créer des réponses pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio.
BasicDataType	Énumération qui représente les types de données génériques de base.
Color	Objet Color représentant une couleur dans l'espace colorimétrique RVBA.
DataType	Un DataType est utilisé pour définir le type d'une variable.
DynamicResourceDefinition	Une DynamicResourceDefinition est un élément de base pour un ResourceFieldsDefinitionRetrievedAction. Elle peut contenir un ou plusieurs nombres de ResourceField pour définir de manière dynamique le nombre de variables de sortie fournies par une étape dans Google Workspace Studio.
ErrorActionability	Énumération représentant l'actionnabilité de l'erreur.
ErrorRetryability	Énumération qui représente la possibilité de réessayer l'appel d'action en cas d'erreur.
FontWeight	Énumération représentant l'épaisseur de la police du texte stylisé.
HostAppAction	HostAppAction est un type d'action géré par des applications hôtes individuelles.
Hyperlink	Élément Hyperlink utilisé dans TextFormatElement.
InsertSection	Compilateur pour les objets InsertSection.
InsertWidget	Compilateur pour les objets InsertWidget.
Link	Objet de lien provenant d'une ressource tierce qui est converti en chip intelligent dans l'application hôte.
ListContainer	Conteneur pour les éléments de liste, où chaque élément de liste peut contenir plusieurs TextFormatElement.
ListItem	Élément de liste, où chaque élément peut contenir plusieurs TextFormatElement.
ListType	Énumération représentant le type de liste.
ModifyCard	Générateur d'objets ModifyCard qui modifie et met à jour l'interface d'une fiche existante en transmettant l'objet ModifyCard à un Action.
Navigation	Objet d'assistance qui contrôle la navigation dans les cartes.
RemoveSection	Compilateur pour les objets RemoveSection.
RemoveWidget	Compilateur pour les objets RemoveWidget.
RenderAction	Affiche ou met à jour une fiche en effectuant une Action en réponse à une interaction de l'utilisateur.
RenderActionBuilder	Compilateur pour les objets RenderAction.
ResourceData	Représente des données de ressources spécifiques à une application. Les données de ressources contiennent une collection de paires clé/valeur de noms de variables et VariableData.
ResourceField	Un ResourceField est un élément de base d'un DynamicResourceDefinition. Chaque champ de ressource correspond à une variable de sortie de l'étape actuelle.
ResourceFieldsDefinitionRetrievedAction	Un ResourceFieldsDefinitionRetrievedAction est un type de ResourceFieldsDefinitionRetrievedAction qui permet de récupérer la définition d'une liste de champs de ressources via la fonction dynamicResourceDefinitionProvider spécifiée dans le fichier manifeste.
ResourceRetrievedAction	Une ResourceRetrievedAction permet de récupérer le contenu d'une ressource personnalisée si nécessaire, lorsque le champ de ressource personnalisée est défini dans ResourceData.
ResourceType	Type de ressource spécifique à une application. L'identifiant unique du type de ressource doit avoir une WorkflowResourceDefinition correspondante.
ReturnElementErrorAction	Une ReturnElementErrorAction indique qu'une erreur s'est produite lors de l'appel d'un élément.
ReturnOutputVariablesAction	Contient les variables de sortie générées par l'action exécutée dans Google Workspace Studio.
SaveWorkflowAction	Cette action indique que l'application hôte (Google Workspace Studio) doit enregistrer l'agent.
StyledText	Élément de texte avec des styles tels que le gras, l'italique et la couleur.
TextFormatChip	Un chip cliquable au format texte.
TextFormatElement	Élément de format de texte, qui peut être TextFormatChip, StyledText, Hyperlink ou ListContainer.
TextFormatIcon	Icône affichée dans un TextFormatChip.
TextStyle	Énumération représentant le style du texte mis en forme.
TimeStamp	Représente un objet d'horodatage qui peut être ajouté à un VariableData.
UpdateWidget	Compilateur pour les objets UpdateWidget.
ValidationErrorSeverity	Énumération représentant la gravité de l'erreur de validation.
ValueMetadata	Un objet valueMetadata contient des informations sur les valeurs potentielles d'une variable.
VariableData	Représente des données variables pouvant contenir une collection de valeurs de différents types.
WorkflowAction	WorkflowAction est un type de HostAppAction utilisé pour effectuer une action spécifique dans Google Workspace Studio.
WorkflowTextFormat	Bloc de texte avec des options de mise en forme enrichie, y compris des styles, des liens hypertextes et des éléments interactifs définis dans TextFormatElement.
WorkflowValidationErrorAction	Cette action indique que l'application hôte (Google Workspace Studio) doit afficher une erreur de validation.

Action

Méthodes

Méthode	Type renvoyé	Brève description
addModifyCard(modifyCard)	Action	Ajoute une opération ModifyCard à l'action.
addNavigation(navigation)	Action	Ajoute une navigation par carte à l'action.

AddOnsResponseService

Méthodes

Méthode	Type renvoyé	Brève description
newAction()	Action	crée un objet Action ;
newNavigation()	Navigation	crée un objet Navigation ;
newRenderActionBuilder()	RenderActionBuilder	crée un objet RenderActionBuilder ;

BasicDataType

Propriétés

Propriété	Type	Description
BASIC_TYPE_UNSPECIFIED	Enum	Valeur par défaut.
STRING	Enum	Chaîne de caractères.
INTEGER	Enum	Valeur entière.
FLOAT	Enum	Nombre à virgule flottante.
TIMESTAMP	Enum	Code temporel au format ISO 8601.
BOOLEAN	Enum	Une valeur booléenne.
EMAIL_ADDRESS	Enum	Chaîne au format d'une adresse e-mail.
GOOGLE_USER	Enum	Utilisateur des services Google, au format "users/encoded_GAIA_ID"
FILE	Enum	Type de fichier.
FORMATTED_TEXT	Enum	Texte avec une mise en forme enrichie.

Color

Méthodes

Méthode	Type renvoyé	Brève description
setAlpha(alpha)	Color	Définit le composant alpha de la couleur.
setBlue(blue)	Color	Définit le composant bleu de la couleur.
setGreen(green)	Color	Définit le composant vert de la couleur.
setRed(red)	Color	Définit le composant rouge de la couleur.

DataType

Méthodes

Méthode	Type renvoyé	Brève description
setBasicDataType(basicDataType)	DataType	Définit le type de données sur l'un des BasicDataType compatibles.
setResourceType(resourceType)	DataType	Définit le type de données sur un ResourceType personnalisé.
setValueMetadata(valueMetadata)	DataType	Définit le ValueMetadata, qui contient des informations liées au type de la variable.

DynamicResourceDefinition

Méthodes

Méthode	Type renvoyé	Brève description
addResourceField(resourceField)	DynamicResourceDefinition	Ajoute un champ de ressource à la définition de ressource dynamique.
setResourceId(resourceId)	DynamicResourceDefinition	Définit l'ID de la définition de ressource dynamique. Cet ID correspond à workflowResourceDefinitionId dans le fichier manifeste.

ErrorActionability

Propriétés

Propriété	Type	Description
ERROR_ACTIONABILITY_UNSPECIFIED	Enum	Non spécifié.
NOT_ACTIONABLE	Enum	L'utilisateur ne peut pas résoudre l'erreur à l'aide de la fiche de configuration.
ACTIONABLE	Enum	L'utilisateur peut corriger l'erreur à l'aide de la fiche de configuration.

ErrorRetryability

Propriétés

Propriété	Type	Description
RETRYABILITY_UNSPECIFIED	Enum	Non spécifié.
NOT_RETRYABLE	Enum	L'erreur ne peut pas être corrigée. Le flux se termine après la première tentative.
RETRYABLE	Enum	L'erreur est récupérable. Le workflow va essayer d'exécuter l'étape jusqu'à cinq fois.

FontWeight

Propriétés

Propriété	Type	Description
FONT_WEIGHT_UNSPECIFIED	Enum	Poids standard avec une épaisseur normale.
LIGHT	Enum	Plus léger et moins épais.
MEDIUM	Enum	Poids intermédiaire entre le style clair et le style gras.
BOLD	Enum	Poids plus élevé et épaisseur accrue.

HostAppAction

Méthodes

Méthode	Type renvoyé	Brève description
setWorkflowAction(workflowAction)	HostAppAction	Définit l'action de l'application hôte sur l'action de workflow.

Hyperlink

Méthodes

Méthode	Type renvoyé	Brève description
setLink(link)	Hyperlink	Définit l'URL de destination du lien hypertexte.
setText(text)	Hyperlink	Définit le texte du lien hypertexte.

InsertSection

Méthodes

Méthode	Type renvoyé	Brève description
insertAtTop(onCardTop)	InsertSection	Définit l'indicateur onCardTop, qui indique si la nouvelle section doit être insérée en haut de la carte.
insertBelowSection(sectionId)	InsertSection	Définit l'ID de la section. La nouvelle section est insérée en dessous.
setSection(section)	InsertSection	Définit la section de carte à insérer.

InsertWidget

Méthodes

Méthode	Type renvoyé	Brève description
insertAboveWidget(widgetId)	InsertWidget	Définit l'ID du widget. Le nouveau widget est inséré au-dessus du widget portant l'ID spécifié.
insertBelowWidget(widgetId)	InsertWidget	Définit l'ID du widget. Le nouveau widget est inséré sous le widget portant l'ID spécifié.
setWidget(widget)	InsertWidget	Définit le Widget à insérer.

Link

Méthodes

Méthode	Type renvoyé	Brève description
setTitle(title)	Link	Définit le titre du lien.
setUrl(url)	Link	Définit l'URL du lien.

ListContainer

Méthodes

Méthode	Type renvoyé	Brève description
addListItem(listItem)	ListContainer	Ajoute un élément de liste au conteneur de liste.
setListNestLevel(listLevel)	ListContainer	Définit le niveau de la liste. La valeur est de 0 pour le niveau supérieur et augmente de 1 pour chaque liste imbriquée.
setListType(listType)	ListContainer	Définit le type de liste (ordonnée ou non ordonnée).

ListItem

Méthodes

Méthode	Type renvoyé	Brève description
addTextFormatElement(textFormatElement)	ListItem	Ajoute un TextFormatElement à l'élément de liste.

ListType

Propriétés

Propriété	Type	Description
LIST_TYPE_UNSPECIFIED	Enum	Valeur par défaut.
ORDERED	Enum	Liste ordonnée.
UNORDERED	Enum	Liste non triée.

ModifyCard

Méthodes

Méthode	Type renvoyé	Brève description
setInsertSection(insertSection)	ModifyCard	Définit le InsertSection pour cet objet de fiche de modification.
setInsertWidget(insertWidget)	ModifyCard	Définit le InsertWidget pour cet objet de fiche de modification.
setRemoveSection(removeSection)	ModifyCard	Définit le RemoveSection pour cet objet de fiche de modification.
setRemoveWidget(removeWidget)	ModifyCard	Définit le RemoveWidget pour cet objet de fiche de modification.
setReplaceSection(replacementSection)	ModifyCard	Définit le CardSection de remplacement pour cet objet de modification de carte. La section de remplacement doit avoir le même ID qu'une section de carte existante.
setReplaceWidget(replacementWidget)	ModifyCard	Définit le widget de remplacement pour cet objet de carte de modification. Le widget de remplacement doit avoir le même ID qu'un widget existant.
setUpdateWidget(updateWidget)	ModifyCard	Définit le UpdateWidget pour cet objet de fiche de modification.

Navigation

Méthodes

Méthode	Type renvoyé	Brève description
printJson()	String	Affiche la représentation JSON de cet objet.
pushCard(card)	Navigation	Transfère la carte donnée sur la pile.

RemoveSection

Méthodes

Méthode	Type renvoyé	Brève description
setSectionId(sectionId)	RemoveSection	Définit l'ID de la section à supprimer.

RemoveWidget

Méthodes

Méthode	Type renvoyé	Brève description
setWidgetId(widgetId)	RemoveWidget	Définit l'ID du widget à supprimer.

RenderAction

Méthodes

Méthode	Type renvoyé	Brève description
printJson()	String	Affiche la représentation JSON de cet objet.

RenderActionBuilder

Méthodes

Méthode	Type renvoyé	Brève description
build()	RenderAction	Crée l'action de rendu actuelle et la valide.
setAction(action)	RenderActionBuilder	Définit l'action que les modules complémentaires peuvent utiliser pour mettre à jour l'UI sur l'action de rendu.
setHostAppAction(hostAppAction)	RenderActionBuilder	Définit les HostAppAction gérés par les applications hôtes individuelles sur l'action de rendu.

ResourceData

Méthodes

Méthode	Type renvoyé	Brève description
addVariableData(key, value)	ResourceData	Ajoute un VariableData identifié par son nom de variable. Si la clé existe déjà, la valeur est remplacée.
setVariableDataMap(fields)	ResourceData	Définit la carte des données de variables associées aux noms de variables.

ResourceField

Méthodes

Méthode	Type renvoyé	Brève description
setDataType(dataType)	ResourceField	Définit le type de données du champ et permet aux autres étapes de filtrer les variables par type lors de la sélection.
setDisplayText(displayText)	ResourceField	Définit la description du champ qui s'affiche pour l'utilisateur final lors de la sélection des variables dans les étapes suivantes.
setSelector(selector)	ResourceField	Définit une clé pour que la fonction de fournisseur fournisse la valeur lors de l'exécution de l'étape.

ResourceFieldsDefinitionRetrievedAction

Méthodes

Méthode	Type renvoyé	Brève description
addDynamicResourceDefinition(dynamicResourceDefinition)	ResourceFieldsDefinitionRetrievedAction	Ajoute un DynamicResourceDefinition à l'action de récupération de la définition des champs de ressource.

ResourceRetrievedAction

Méthodes

Méthode	Type renvoyé	Brève description
setResourceData(resourceData)	ResourceRetrievedAction	Définit ResourceData sur l'action de récupération de la ressource pour fournir des valeurs aux champs de ressources dynamiques ou aux champs de ressources personnalisés.

ResourceType

Méthodes

Méthode	Type renvoyé	Brève description
setWorkflowResourceDefinitionId(resourceType)	ResourceType	Définit l'ID de définition de ressource de workflow.

ReturnElementErrorAction

Méthodes

Méthode	Type renvoyé	Brève description
setErrorActionability(errorActionability)	ReturnElementErrorAction	Définit l'actionnabilité de l'erreur. Une erreur doit être actionable si elle peut être résolue en reconfigurant l'étape.
setErrorLog(log)	ReturnElementErrorAction	Définit le journal des erreurs à afficher à l'utilisateur final dans le flux d'activité du workflow.
setErrorRetryability(errorRetryability)	ReturnElementErrorAction	Définit la possibilité de nouvelle tentative en cas d'erreur. Le flux se termine après la première tentative si une erreur ne peut pas faire l'objet d'une nouvelle tentative.

ReturnOutputVariablesAction

Méthodes

Méthode	Type renvoyé	Brève description
addVariableData(key, value)	ReturnOutputVariablesAction	Ajoute une variable de données indexée par son nom de variable. Une valeur est écrasée si la clé existe déjà.
setLog(log)	ReturnOutputVariablesAction	Définit le journal de l'action de workflow exécutée pour l'utilisateur final dans le flux d'activité du workflow.
setVariableDataMap(variables)	ReturnOutputVariablesAction	Définit le mappage des données de variables identifiées par le nom de la variable. Une valeur est écrasée si la clé existe déjà.

SaveWorkflowAction

StyledText

Méthodes

Méthode	Type renvoyé	Brève description
addStyle(style)	StyledText	Définit le style du texte stylisé. Plusieurs styles peuvent être appliqués à un même texte stylisé.
setColor(color)	StyledText	Définit la couleur du texte stylisé.
setFontWeight(fontWeight)	StyledText	Définit l'épaisseur de la police du texte stylisé.
setText(text)	StyledText	Définit le contenu principal du texte stylisé.

TextFormatChip

Méthodes

Méthode	Type renvoyé	Brève description
setLabel(label)	TextFormatChip	Définit le texte affiché dans le chip.
setTextFormatIcon(icon)	TextFormatChip	Définit l'icône affichée dans le chip.
setUrl(url)	TextFormatChip	Définit l'URL vers laquelle rediriger l'utilisateur lorsqu'il clique sur le chip.

TextFormatElement

Méthodes

Méthode	Type renvoyé	Brève description
setHyperlink(hyperlink)	TextFormatElement	Définit l'élément de format de texte comme Hyperlink.
setListContainer(listContainer)	TextFormatElement	Définit l'élément de format de texte comme ListContainer.
setStyledText(styledText)	TextFormatElement	Définit l'élément de format de texte comme StyledText.
setText(text)	TextFormatElement	Définit l'élément de format de texte en tant que chaîne de texte.
setTextFormatChip(chip)	TextFormatElement	Définit l'élément de format de texte comme TextFormatChip.

TextFormatIcon

Méthodes

Méthode	Type renvoyé	Brève description
setIconUrl(iconUrl)	TextFormatIcon	Définit l'URL de l'icône.
setMaterialIconName(materialIconName)	TextFormatIcon	Définit le nom de l'icône Material défini dans Google Material Icons.

TextStyle

Propriétés

Propriété	Type	Description
STYLE_UNSPECIFIED	Enum	Aucun style appliqué.
ITALIC	Enum	Style italique.
UNDERLINE	Enum	Style de soulignement.
STRIKETHROUGH	Enum	Style barré.
LINE_BREAK	Enum	Saut de ligne.
UPPERCASE	Enum	Style en majuscules.
CODE	Enum	Style de code.
CODE_BLOCK	Enum	Style du bloc de code.

TimeStamp

Méthodes

Méthode	Type renvoyé	Brève description
setNanos(nanos)	TimeStamp	Définit les nanosecondes du code temporel. Il s'agit du nombre de nanosecondes dans la seconde actuelle.
setSeconds(seconds)	TimeStamp	Définit les secondes du code temporel. Il représente le nombre de secondes écoulées depuis l'époque Unix(1er janvier 1970, 00:00:00 UTC).

UpdateWidget

Méthodes

Méthode	Type renvoyé	Brève description
addSuggestion(text, value, selected, startIconUri, bottomText)	UpdateWidget	Ajoute un nouvel élément pouvant être sélectionné pour les menus à sélection multiple.

ValidationErrorSeverity

Propriétés

Propriété	Type	Description
SEVERITY_UNSPECIFIED	Enum	Non spécifié.
CRITICAL	Enum	Critique : l'erreur est critique et doit être corrigée avant la publication.
WARNING	Enum	Avertissement : l'erreur n'est pas critique et n'empêche pas la publication.

ValueMetadata

Méthodes

Méthode	Type renvoyé	Brève description
addCastableType(dataType)	ValueMetadata	Ajoute des types autorisés facultatifs qui peuvent être convertis dynamiquement pour les données d'une variable à ces métadonnées de valeur.
addEnumValue(enumValue)	ValueMetadata	Ajoute une valeur de chaîne facultative aux valeurs d'énumération autorisées d'une variable. Ce champ ne peut être défini que si DataType est défini sur le type "String".
setDefaultValue(defaultValue)	ValueMetadata	Définit la valeur par défaut facultative de la variable. Par exemple, si le type de variable est booléen, defaultValue peut être défini sur "true" ou "false".

VariableData

Méthodes

Méthode	Type renvoyé	Brève description
addBooleanValue(value)	VariableData	Ajoute une valeur booléenne aux données de la variable.
addEmailAddress(emailAddress)	VariableData	Ajoute une adresse e-mail aux données de variable.
addFloatValue(value)	VariableData	Ajoute une valeur float aux données de la variable.
addGoogleUser(googleUser)	VariableData	Ajoute un utilisateur Google aux données de la variable.
addIntegerValue(value)	VariableData	Ajoute une valeur entière aux données de la variable.
addResourceData(resourceData)	VariableData	Ajoute une valeur ResourceData aux données de la variable.
addResourceReference(resourceReference)	VariableData	Ajoute un ID de référence de ressource aux données de la variable.
addStringValue(value)	VariableData	Ajoute une valeur de chaîne aux données de la variable.
addTimestampValue(value)	VariableData	Ajoute une valeur TimeStamp aux données de la variable.
addWorkflowTextFormat(workflowTextFormat)	VariableData	Ajoute une valeur WorkflowTextFormat aux données de la variable.

WorkflowAction

WorkflowTextFormat

Méthodes

Méthode	Type renvoyé	Brève description
addTextFormatElement(textFormatElement)	WorkflowTextFormat	Ajoute un TextFormatElement au format texte du workflow.

WorkflowValidationErrorAction

Méthodes

Méthode	Type renvoyé	Brève description
setSeverity(severity)	WorkflowValidationErrorAction	Définit la gravité de l'erreur de validation.