AddOns Response Service

הוספת שירות תגובה שלתוספים

השירות הזה מאפשר לסקריפטים להגדיר ולבנות תוספים ל-Google Workspace.

שיעורים

שםתיאור קצר
AccessoryWidget
Actionפעולה שתוספים ל-Google Workspace שמורחבים על ידי Google Workspace Studio יכולים להשתמש בה כדי להציג כרטיס חדש.
ActionResponse
ActionResponseBuilder
AddOnsResponseServiceAddOnsResponseService מאפשר ליצור תגובות לתוספים של Google Workspace.
AddonComposeUiActionResponse
AddonComposeUiActionResponseBuilder
AddonComposeUiActionType
Attachment
BasicDataTypeסוג enum שמייצג את סוגי הנתונים הגנריים הבסיסיים.
CalendarEventActionResponse
CalendarEventActionResponseBuilder
ChatDataActionsResponseBuilder
ChatMessage
Colorאובייקט Color שמייצג צבע במרחב הצבעים RGBA.
ComposeActionResponse
ComposeActionResponseBuilder
ComposedEmailType
ContentType
CreateMessageAction
DataActionsResponse
DataTypeהמאפיין DataType משמש להגדרת סוג המשתנה.
DriveItemsSelectedActionResponse
DriveItemsSelectedActionResponseBuilder
DynamicResourceDefinition‫DynamicResourceDefinition הוא אבן בניין של ResourceFieldsDefinitionRetrievedAction, והוא יכול להכיל מספר אחד או יותר של ResourceField כדי להגדיר באופן דינמי את מספר משתני הפלט שמוצגים בשלב ב-Google Workspace Studio.
EditorFileScopeActionResponse
EditorFileScopeActionResponseBuilder
EndNavigation
ErrorActionabilityסוג Enum שמייצג את האפשרות לטפל בשגיאה.
ErrorRetryabilityסוג Enum שמייצג את האפשרות לנסות שוב להפעיל פעולה כשיש שגיאה.
FontWeightסוג enum שמייצג את עובי הגופן של הטקסט המעוצב.
HostAppActionHostAppAction הוא סוג של פעולה שמטופלת על ידי אפליקציות מארחות בודדות.
Hyperlinkרכיב היפר-קישור שמשמש ב-TextFormatElement.
InsertSectionאובייקט builder של InsertSection.
InsertWidgetאובייקט builder של InsertWidget.
Linkאובייקט הקישור ממקור של צד שלישי שהומר לצ'יפ חכם באפליקציית המארח.
LinkPreview
ListContainerקונטיינר של פריטים ברשימה, שכל אחד מהם יכול להכיל כמה רכיבי TextFormatElement.
ListItemפריט ברשימה, כאשר כל פריט ברשימה יכול להכיל כמה תגי TextFormatElement.
ListTypeערך enum שמייצג את סוג הרשימה.
ModifyCardכלי ליצירת אובייקטים מסוג ModifyCard שמשנה ומעדכן את הממשק של כרטיס קיים על ידי העברת אובייקט מסוג ModifyCard אל Action.
Navigationאובייקט עזר ששולט בניווט בכרטיס.
Notification
OnClose
OpenAs
OpenLink
RemoveSection‫Builder לאובייקטים מסוג RemoveSection.
RemoveWidgetכלי ליצירת אובייקטים של RemoveWidget.
RenderActionמבצע רינדור או עדכון של כרטיס על ידי הפעלת Action בתגובה לאינטראקציה של משתמש.
RenderActionBuilder‫Builder לאובייקטים מסוג RenderAction.
ResourceDataמייצג נתוני משאב ספציפיים לאפליקציה. נתוני משאב מכילים אוסף של צמדי מפתח-ערך של שמות משתנים ושל VariableData.
ResourceFieldResourceField הוא אבן בניין בסיסית של DynamicResourceDefinition, וכל ResourceField תואם למשתנה פלט של השלב הנוכחי.
ResourceFieldsDefinitionRetrievedActionResourceFieldsDefinitionRetrievedAction הוא סוג של ResourceFieldsDefinitionRetrievedAction שמשמש לאחזור ההגדרה של רשימת שדות משאבים באמצעות פונקציית dynamicResourceDefinitionProvider שצוינה במניפסט.
ResourceRetrievedActionמשתמשים ב-ResourceRetrievedAction כדי לאחזר תוכן של משאב מותאם אישית כשצריך, כאשר השדה של המשאב המותאם אישית מוגדר ב-ResourceData.
ResourceTypeסוג משאב ספציפי לאפליקציה, למזהה הייחודי של סוג המשאב צריכה להיות WorkflowResourceDefinition תואמת.
ReturnElementErrorAction‫ReturnElementErrorAction מציין שהתרחשה שגיאה במהלך הפעלת הרכיב.
ReturnOutputVariablesActionמכיל משתני פלט שנוצרו על ידי הפעולה שהופעלה ב-Google Workspace Studio.
SaveWorkflowActionהפעולה הזו מציינת שאפליקציית המארח (Google Workspace Studio) צריכה לשמור את הסוכן.
SendStatus
StyledTextרכיב טקסט עם סגנונות כמו הדגשה, נטייה וצבע.
TextFormatChipצ'יפ שאפשר ללחוץ עליו בפורמט טקסט.
TextFormatElementרכיב של עיצוב טקסט, שיכול להיות TextFormatChip, StyledText, Hyperlink או ListContainer.
TextFormatIconסמל שמוצג בתוך TextFormatChip.
TextStyleערך enum שמייצג את הסגנון של הטקסט המעוצב.
TimeStampמייצג אובייקט של חותמת זמן שאפשר להוסיף ל-VariableData.
UniversalActionResponse
UniversalActionResponseBuilder
UpdateDraftActionResponse
UpdateDraftActionResponseBuilder
UpdateDraftBccRecipientsAction
UpdateDraftBodyAction
UpdateDraftBodyType
UpdateDraftCcRecipientsAction
UpdateDraftSubjectAction
UpdateDraftToRecipientsAction
UpdateInlinePreviewAction
UpdateMessageAction
UpdateWidget‫Builder לאובייקטים מסוג UpdateWidget.
ValidationErrorSeverityסוג enum שמייצג את חומרת שגיאת האימות.
ValueMetadata‫valueMetadata מכיל מידע על הערכים הפוטנציאליים של משתנה.
VariableDataמייצג נתונים משתנים שיכולים להכיל אוסף של ערכים מסוגים שונים.
WorkflowActionWorkflowAction הוא סוג של HostAppAction שמשמש לביצוע פעולה ספציפית ב-Google Workspace Studio.
WorkflowTextFormatבלוק טקסט עם אפשרויות עיצוב עשירות, כולל סגנונות, היפר-קישורים ואלמנטים אינטראקטיביים שהוגדרו ב-TextFormatElement.
WorkflowValidationErrorActionהפעולה הזו מציינת שאפליקציית המארח (Google Workspace Studio) צריכה להציג שגיאת אימות.

AccessoryWidget

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addWidget(widget)AccessoryWidgetהגדרת הווידג'ט לפעולה הזו.

Action

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addModifyCard(modifyCard)Actionהפעולה מוסיפה פעולה מסוג ModifyCard.
addNavigation(navigation)Actionהוספת ניווט בכרטיסים לפעולה.

ActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

ActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addModifyCard(modifyCard)ActionResponseBuilderהגדרת פעולת שינוי הכרטיס לפעולה.
build()ActionResponseיוצר את התגובה לפעולה הנוכחית ומאמת אותה.
setLinkPreview(linkPreview)ActionResponseBuilderמגדיר את התצוגה המקדימה של הקישור לפעולה.
setNavigation(navigation)ActionResponseBuilderהגדרת התגובה לפעולה Navigation.
setNotification(notification)ActionResponseBuilderהגדרת ההתראה שתוצג כשהפעולה תופעל.
setOpenLink(openLink)ActionResponseBuilderהגדרת כתובת ה-URL שאליה יועבר המשתמש כשהפעולה תופעל.
setStateChanged(stateChanged)ActionResponseBuilderהפעולה הזו מגדירה דגל כדי לציין שהיא שינתה את מצב הנתונים הקיים.

AddOnsResponseService

מאפיינים

נכססוגתיאור
AddonComposeUiActionTypeAddonComposeUiActionTypeהספירה AddonComposeUiActionType.
ComposedEmailTypeComposedEmailTypeהספירה ComposedEmailType.
ContentTypeContentTypeהספירה ContentType.
EndNavigationEndNavigationהספירה EndNavigation.
OnCloseOnCloseהספירה OnClose.
OpenAsOpenAsהספירה OpenAs.
SendStatusSendStatusהספירה SendStatus.
UpdateDraftBodyTypeUpdateDraftBodyTypeהספירה UpdateDraftBodyType.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
newAccessoryWidget()AccessoryWidgetיוצרת AccessoryWidget חדש.
newAction()Actionיוצרת Action חדש.
newActionResponseBuilder()ActionResponseBuilderיצירת ActionResponseBuilder.
newAddonComposeUiActionResponseBuilder()AddonComposeUiActionResponseBuilderיצירת AddonComposeUiActionResponseBuilder.
newAttachment()Attachmentיצירת Attachment.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderיצירת CalendarEventActionResponseBuilder.
newChatDataActionBuilder()ChatDataActionsResponseBuilderיצירת ChatDataActionsResponseBuilder.
newChatMessage()ChatMessageיצירת ChatMessage.
newComposeActionResponseBuilder()ComposeActionResponseBuilderיצירת ComposeActionResponseBuilder.
newCreateMessageAction()CreateMessageActionיצירת CreateMessageAction.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderיצירת DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderיצירת EditorFileScopeActionResponseBuilder.
newLinkPreview()LinkPreviewיצירת LinkPreview.
newNavigation()Navigationיצירת Navigation.
newNotification()Notificationיצירת Notification.
newOpenLink()OpenLinkיצירת OpenLink.
newRenderActionBuilder()RenderActionBuilderיוצרת RenderActionBuilder חדש.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderיצירת UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderיצירת UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionיוצר UpdateDraftBccRecipientsAction;
newUpdateDraftBodyAction()UpdateDraftBodyActionיצירת UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionיצירת UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionיצירת UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionיצירת UpdateDraftToRecipientsAction.
newUpdateInlinePreviewAction()UpdateInlinePreviewActionיצירת UpdateInlinePreviewAction.
newUpdateMessageAction()UpdateMessageActionיצירת UpdateMessageAction.

AddonComposeUiActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

AddonComposeUiActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()AddonComposeUiActionResponseיוצר את התגובה הנוכחית לפעולת ממשק המשתמש של התוסף ומאמת אותה.
setType(type)AddonComposeUiActionResponseBuilderהגדרת שדה enum שקובע את פעולת ממשק המשתמש של התוסף.

AddonComposeUiActionType

מאפיינים

נכססוגתיאור
DISMISSEnumברירת מחדל.

Attachment

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setIconUrl(iconUrl)Attachmentהגדרת כתובת ה-URL של הסמל של הקובץ המצורף.
setMimeType(mimeType)Attachmentמגדיר את סוג ה-MIME של הקובץ המצורף.
setResourceUrl(resourceUrl)Attachmentהגדרת כתובת ה-URL של המשאב עבור הקובץ המצורף.
setTitle(title)Attachmentמגדיר את השם של הקובץ המצורף.

BasicDataType

מאפיינים

נכססוגתיאור
BASIC_TYPE_UNSPECIFIEDEnumערך ברירת המחדל.
STRINGEnumמחרוזת של תווים.
INTEGEREnumערך של מספר שלם.
FLOATEnumמספר נקודה צפה.
TIMESTAMPEnumחותמת זמן בפורמט ISO 8601.
BOOLEANEnumערך בוליאני.
EMAIL_ADDRESSEnumמחרוזת בפורמט של כתובת אימייל.
GOOGLE_USEREnumמשתמש בשירותי Google, בפורמט users/encoded_GAIA_ID
FILEEnumסוג הקובץ.
FORMATTED_TEXTEnumטקסט עם עיצוב עשיר.

CalendarEventActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

CalendarEventActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addAttachments(attachments)CalendarEventActionResponseBuilderמציין שהתשובה צריכה להוסיף את הקבצים המצורפים לאירוע ביומן כשמבצעים את פעולת ממשק המשתמש המשויכת.
addAttendees(emails)CalendarEventActionResponseBuilderמציין שהתשובה צריכה להוסיף את המשתתפים שצוינו לאירוע ביומן כשמבצעים את פעולת ממשק המשתמש המשויכת.
build()CalendarEventActionResponseיוצר את התגובה הנוכחית לפעולה של אירוע ביומן ומאמת אותה.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderמציין שהתגובה צריכה להגדיר את נתוני הוועידה שצוינו לאירוע ביומן כשמבצעים את פעולת ממשק המשתמש המשויכת.

ChatDataActionsResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()DataActionsResponseיוצר את התגובה לפעולה הנוכחית.
setCreateChatMessageAction(createMessageAction)ChatDataActionsResponseBuilderמגדירה את ה-CreateMessageAction של ה-DataActionsResponse הזה.
setUpdateChatMessageAction(updateMessageAction)ChatDataActionsResponseBuilderמגדירה את ה-UpdateMessageAction של ה-DataActionsResponse הזה.
setUpdateInlinePreviewAction(updateInlinePreviewAction)ChatDataActionsResponseBuilderמגדירה את ה-UpdateInlinePreviewAction של ה-DataActionsResponse הזה.

ChatMessage

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addAccessoryWidget(accessoryWidget)ChatMessageמגדיר את accessoryWidget לפעולה הזו.
addCardWithId(cardWithId)ChatMessageהגדרת הכרטיס של ההודעה.
setText(text)ChatMessageהגדרת הטקסט של ההודעה.

Color

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setAlpha(alpha)Colorהגדרת רכיב האלפא של הצבע.
setBlue(blue)Colorהגדרת הרכיב הכחול של הצבע.
setGreen(green)Colorהגדרת הרכיב הירוק של הצבע.
setRed(red)Colorהגדרת הרכיב האדום של הצבע.

ComposeActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

ComposeActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()ComposeActionResponseיוצר את התגובה של פעולת הכתיבה הנוכחית ומאמת אותה.
setGmailDraft(draft)ComposeActionResponseBuilderמגדירה את הטיוטה GmailMessage שנוצרה באמצעות GmailMessage.createDraftReply(body) או פונקציות דומות.

ComposedEmailType

מאפיינים

נכססוגתיאור
REPLY_AS_DRAFTEnumטיוטה שהיא תשובה להודעה אחרת.
STANDALONE_DRAFTEnumטיוטה שהיא הודעה עצמאית.

ContentType

מאפיינים

נכססוגתיאור
TEXTEnumמציין שהתוכן שנוצר הוא טקסט פשוט.
MUTABLE_HTMLEnumמציין שהתוכן שנוצר מעוצב כ-HTML.
IMMUTABLE_HTMLEnumמציין שהתוכן שנוצר מעוצב כ-HTML, אבל אי אפשר לערוך את התוכן הזה אחרי שהוא נוצר.

CreateMessageAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setMessage(message)CreateMessageActionמגדיר את ההודעה לפעולה הזו.

DataActionsResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

DataType

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setBasicDataType(basicDataType)DataTypeמגדיר את סוג הנתונים לאחד מסוגי הנתונים הנתמכים BasicDataType.
setResourceType(resourceType)DataTypeהגדרת סוג הנתונים ל-ResourceType מוגדר בהתאמה אישית.
setValueMetadata(valueMetadata)DataTypeמגדיר את ValueMetadata, שמכיל מידע שקשור לסוג המשתנה.

DriveItemsSelectedActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

DriveItemsSelectedActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()DriveItemsSelectedActionResponseיוצר את התגובה לפעולה הנוכחית ב-Drive.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderמציין שהתשובה מבקשת היקף קובץ עבור הפריט הרלוונטי להקשר ב-Drive.

DynamicResourceDefinition

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addResourceField(resourceField)DynamicResourceDefinitionהוספת שדה משאב להגדרת המשאב הדינמי.
setResourceId(resourceId)DynamicResourceDefinitionמגדיר את המזהה להגדרת המשאב הדינמי. המזהה הזה תואם ל-workflowResourceDefinitionId במניפסט.

EditorFileScopeActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

EditorFileScopeActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()EditorFileScopeActionResponseיוצר את התגובה הנוכחית לפעולה בכלי העריכה.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderמבקש את היקף ההרשאות drive.file למסמך הפעיל הנוכחי בכלי העריכה.

EndNavigation

מאפיינים

נכססוגתיאור
ACTION_UNSPECIFIEDEnumלא צוינה פעולה.
CLOSE_DIALOGEnumסגירה של תיבת דו-שיח.
CLOSE_DIALOG_AND_EXECUTEEnumסוגר תיבת דו-שיח ומרענן את הכרטיס שממנו נפתחה תיבת הדו-שיח.

ErrorActionability

מאפיינים

נכססוגתיאור
ERROR_ACTIONABILITY_UNSPECIFIEDEnumלא צוין.
NOT_ACTIONABLEEnumהמשתמש לא יכול לתקן את השגיאה באמצעות כרטיס ההגדרה.
ACTIONABLEEnumהמשתמש יכול לתקן את השגיאה באמצעות כרטיס ההגדרה.

ErrorRetryability

מאפיינים

נכססוגתיאור
RETRYABILITY_UNSPECIFIEDEnumלא צוין.
NOT_RETRYABLEEnumאי אפשר לנסות שוב לתקן את השגיאה, התהליך מסתיים אחרי הניסיון הראשון.
RETRYABLEEnumאפשר לנסות שוב לבצע את הפעולה. תהליך העבודה ינסה לבצע את השלב עד 5 פעמים.

FontWeight

מאפיינים

נכססוגתיאור
FONT_WEIGHT_UNSPECIFIEDEnumמשקל רגיל עם עובי רגיל.
LIGHTEnumמשקל קל יותר ועובי מופחת.
MEDIUMEnumמשקל ביניים בין light ל-bold.
BOLDEnumמשקל כבד יותר עם עובי מוגדל.

HostAppAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setWorkflowAction(workflowAction)HostAppActionהגדרת הפעולה של אפליקציית המארח כפעולה של תהליך העבודה.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setLink(link)Hyperlinkהגדרת כתובת היעד של ההיפר-קישור.
setText(text)Hyperlinkהגדרת הטקסט של ההיפר-קישור.

InsertSection

Methods

שיטהסוג הערך שמוחזרתיאור קצר
insertAtTop(onCardTop)InsertSectionההגדרה קובעת את הדגל onCardTop, שמציין אם הקטע החדש צריך להיות מוכנס בחלק העליון של הכרטיס.
insertBelowSection(sectionId)InsertSectionמגדיר את מזהה הקטע, והקטע החדש מוכנס מתחתיו.
setSection(section)InsertSectionמגדיר את קטע הכרטיס שיוכנס.

InsertWidget

Methods

שיטהסוג הערך שמוחזרתיאור קצר
insertAboveWidget(widgetId)InsertWidgetמגדיר את מזהה הווידג'ט, והווידג'ט החדש מוכנס מעל הווידג'ט עם המזהה שצוין.
insertBelowWidget(widgetId)InsertWidgetמגדיר את מזהה הווידג'ט, והווידג'ט החדש מוכנס מתחת לווידג'ט עם המזהה שצוין.
setWidget(widget)InsertWidgetמגדירה את ה-Widget שיוכנס.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setTitle(title)Linkמגדיר את הכותרת של הקישור.
setUrl(url)Linkהגדרת כתובת ה-URL של הקישור.

LinkPreview

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את הייצוג של האובייקט ב-JSON.
setLinkPreviewTitle(title)LinkPreviewהגדרת הכותרת שמוצגת בתצוגה המקדימה של הקישור מעל כרטיס התצוגה המקדימה.
setPreviewCard(previewCard)LinkPreviewהגדרה של הכרטיס שבו מוצג מידע על קישור משירות של צד שלישי או משירות שאינו של Google.
setTitle(title)LinkPreviewמגדיר את הכותרת שמוצגת בצ'יפ החכם של התצוגה המקדימה של הקישור.

ListContainer

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addListItem(listItem)ListContainerהוספת פריט לרשימה למאגר הרשימה.
setListNestLevel(listLevel)ListContainerמגדיר את הרמה של הרשימה, מתחיל מ-0 לרמה העליונה ועולה ב-1 לכל רשימה מוטמעת.
setListType(listType)ListContainerמגדירה את סוג הרשימה: ממוספרת או לא ממוספרת.

ListItem

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addTextFormatElement(textFormatElement)ListItemמוסיף TextFormatElement לפריט ברשימה.

ListType

מאפיינים

נכססוגתיאור
LIST_TYPE_UNSPECIFIEDEnumערך ברירת המחדל.
ORDEREDEnumרשימה ממוינת.
UNORDEREDEnumרשימה לא ממוינת.

ModifyCard

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setInsertSection(insertSection)ModifyCardהגדרת InsertSection לאובייקט הכרטיס הזה של שינוי.
setInsertWidget(insertWidget)ModifyCardהגדרת InsertWidget לאובייקט הכרטיס הזה של שינוי.
setRemoveSection(removeSection)ModifyCardהגדרת RemoveSection לאובייקט הכרטיס הזה של שינוי.
setRemoveWidget(removeWidget)ModifyCardהגדרת RemoveWidget לאובייקט הכרטיס הזה של שינוי.
setReplaceSection(replacementSection)ModifyCardמגדירים את ההחלפה CardSection לאובייקט הזה של כרטיס לשינוי. לקטע ההחלפה צריך להיות אותו מזהה כמו לקטע קיים בכרטיס.
setReplaceWidget(replacementWidget)ModifyCardמגדיר את הווידג'ט להחלפה לאובייקט הזה של שינוי הכרטיס. לווידג'ט להחלפה צריך להיות אותו מזהה כמו לווידג'ט קיים.
setUpdateWidget(updateWidget)ModifyCardהגדרת UpdateWidget לאובייקט הכרטיס הזה של שינוי.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()Stringהפונקציה מדפיסה את הייצוג של האובייקט ב-JSON.
pushCard(card)Navigationדוחף את הכרטיס הנתון אל הערימה.
setEndNavigation(endNavigation)Navigationהגדרת פעולת הניווט לסיום.
updateCard(card)Navigationהחלפה במקום של הכרטיס הנוכחי.

Notification

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setText(text)Notificationהגדרת הטקסט שיוצג בהתראה.

OnClose

מאפיינים

נכססוגתיאור
NOTHINGEnumלא לעשות כלום כשסוגרים.
RELOADEnumהתוסף נטען מחדש כשהחלון נסגר.

OpenAs

מאפיינים

נכססוגתיאור
FULL_SIZEEnumפתיחה בחלון מלא או בכרטיסייה מלאה.
OVERLAYEnumפתיחה כשכבת-על, כמו חלון קופץ.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setOnClose(onClose)OpenLinkהגדרת אופן הפעולה של כתובת ה-URL כשסוגרים את החלון או הכרטיסייה של כתובת ה-URL.
setOpenAs(openAs)OpenLinkהגדרת אופן הפעולה של כתובת URL כשפותחים אותה.
setUrl(url)OpenLinkמגדיר את כתובת ה-URL שתיפתח.

RemoveSection

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setSectionId(sectionId)RemoveSectionמגדירה את מזהה הקטע של הקטע שיוסר.

RemoveWidget

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setWidgetId(widgetId)RemoveWidgetמגדירה את מזהה הווידג'ט של הווידג'ט שרוצים להסיר.

RenderAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

RenderActionBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()RenderActionיוצר את פעולת העיבוד הנוכחית ומאמת אותה.
setAction(action)RenderActionBuilderמגדיר את הפעולה שתוספים יכולים להשתמש בה כדי לעדכן את ממשק המשתמש לפעולת הרינדור.
setHostAppAction(hostAppAction)RenderActionBuilderהגדרת הפעולה render לטיפול ב-HostAppAction באפליקציות מארחות נפרדות.

ResourceData

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addVariableData(key, value)ResourceDataמוסיף VariableData עם מפתח לפי שם המשתנה. אם המפתח כבר קיים, הערך מוחלף.
setVariableDataMap(fields)ResourceDataהגדרת המיפוי של נתוני המשתנים לפי שמות המשתנים.

ResourceField

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setDataType(dataType)ResourceFieldמגדיר את סוג הנתונים של השדה, ומאפשר לשלבים אחרים לסנן את המשתנים לפי סוג בזמן הבחירה.
setDisplayText(displayText)ResourceFieldמגדיר את תיאור השדה שמוצג למשתמש הקצה במהלך בחירת המשתנה בשלבים הבאים.
setSelector(selector)ResourceFieldמגדיר מפתח לפונקציית הספק כדי לספק את הערך במהלך ההפעלה של השלב.

ResourceFieldsDefinitionRetrievedAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionמוסיף DynamicResourceDefinition להגדרה של שדות המשאבים בפעולה שאוחזרה.

ResourceRetrievedAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setResourceData(resourceData)ResourceRetrievedActionהמדיניות הזו מגדירה את הפעולה ResourceData למשאב שאוחזר כדי לספק ערכים לשדות דינמיים של משאבים או לשדות מותאמים אישית של משאבים.

ResourceType

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setWorkflowResourceDefinitionId(resourceType)ResourceTypeמגדיר את המזהה של הגדרת משאב של תהליך העבודה.

ReturnElementErrorAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setErrorActionability(errorActionability)ReturnElementErrorActionהגדרה של האפשרות לביצוע פעולה בעקבות שגיאה. שגיאה צריכה לאפשר ביצוע פעולה אם אפשר לפתור אותה על ידי הגדרה מחדש של השלב.
setErrorLog(log)ReturnElementErrorActionההגדרה קובעת שיוצג יומן שגיאות למשתמש הקצה בפיד הפעילות של זרימת העבודה.
setErrorRetryability(errorRetryability)ReturnElementErrorActionהגדרה של האפשרות לנסות שוב במקרה של שגיאה. התהליך מסתיים אחרי הניסיון הראשון אם השגיאה לא מאפשרת ניסיון חוזר.

ReturnOutputVariablesAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addVariableData(key, value)ReturnOutputVariablesActionמוסיף נתונים של משתנה שמקבלים מפתח לפי שם המשתנה. אם המפתח כבר קיים, הערך שלו מוחלף.
setLog(log)ReturnOutputVariablesActionההגדרה הזו קובעת שהיומן של פעולת תהליך העבודה שבוצעה יוצג למשתמש הקצה בפיד הפעילות של תהליך העבודה.
setVariableDataMap(variables)ReturnOutputVariablesActionמגדיר את המפה של נתוני המשתנים לפי שם המשתנה. אם המפתח כבר קיים, הערך יוחלף.

SaveWorkflowAction

SendStatus

מאפיינים

נכססוגתיאור
NOT_SENDEnumברירת מחדל.
CONTINUE_SENDEnumלהמשיך לשלוח את האימייל אחרי עדכון הטיוטה.

StyledText

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addStyle(style)StyledTextהמאפיין הזה מגדיר את הסגנון של הטקסט המעוצב, ואפשר להחיל כמה סגנונות על טקסט מעוצב אחד.
setColor(color)StyledTextהגדרת הצבע של הטקסט המעוצב.
setFontWeight(fontWeight)StyledTextהגדרת משקל הגופן של הטקסט המעוצב.
setText(text)StyledTextמגדיר את התוכן העיקרי של הטקסט המעוצב.

TextFormatChip

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setLabel(label)TextFormatChipהגדרת הטקסט שיוצג בצ'יפ.
setTextFormatIcon(icon)TextFormatChipהגדרה של הסמל שיוצג בצ'יפ.
setUrl(url)TextFormatChipמגדיר את כתובת ה-URL שאליה המשתמש יועבר כשהוא ילחץ על הצ'יפ.

TextFormatElement

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setHyperlink(hyperlink)TextFormatElementהגדרת רכיב פורמט הטקסט כ-Hyperlink.
setListContainer(listContainer)TextFormatElementהגדרת רכיב פורמט הטקסט כ-ListContainer.
setStyledText(styledText)TextFormatElementהגדרת רכיב פורמט הטקסט כ-StyledText.
setText(text)TextFormatElementמגדיר את רכיב פורמט הטקסט כמחרוזת טקסט.
setTextFormatChip(chip)TextFormatElementהגדרת רכיב פורמט הטקסט כ-TextFormatChip.

TextFormatIcon

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setIconUrl(iconUrl)TextFormatIconמגדיר את כתובת ה-URL של הסמל.
setMaterialIconName(materialIconName)TextFormatIconמגדיר את שם הסמל של Material שמוגדר בסמלי Material של Google.

TextStyle

מאפיינים

נכססוגתיאור
STYLE_UNSPECIFIEDEnumלא הוחל סגנון.
ITALICEnumסגנון נטוי.
UNDERLINEEnumסגנון קו תחתון.
STRIKETHROUGHEnumסגנון קו חוצה.
LINE_BREAKEnumמעבר שורה.
UPPERCASEEnumסגנון אותיות רישיות.
CODEEnumסגנון הקוד.
CODE_BLOCKEnumסגנון בלוק הקוד.

TimeStamp

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setNanos(nanos)TimeStampהגדרה של הננו-שניות של חותמת הזמן. הערך מייצג את מספר הננו-שניות בתוך השנייה הנוכחית.
setSeconds(seconds)TimeStampמגדיר את השניות בחותמת הזמן. הערך מייצג את מספר השניות מאז ראשית זמן יוניקס(1 בינואר 1970, 00:00:00 UTC).

UniversalActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

UniversalActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()UniversalActionResponseיוצר את התגובה הנוכחית לפעולה אוניברסלית ומאמת אותה.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderהתוסף מוצג עם הכרטיסים שצוינו.
setOpenLink(openLink)UniversalActionResponseBuilderמגדירה את כתובת ה-URL שתיפתח כשבוחרים את הפעולה האוניברסלית.

UpdateDraftActionResponse

Methods

שיטהסוג הערך שמוחזרתיאור קצר
printJson()Stringהפונקציה מדפיסה את ייצוג ה-JSON של האובייקט הזה.

UpdateDraftActionResponseBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()UpdateDraftActionResponseיוצר את התגובה של פעולת הטיוטה הנוכחית לעדכון ומאמת אותה.
setSendStatus(sendStatus)UpdateDraftActionResponseBuilderהגדרה של שדה enum שקובע אם האימייל יישלח אחרי פעולת העדכון.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderמגדירה פעולה לעדכון הנמענים שיקבלו עותק מוסתר של טיוטה של אימייל.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderמגדירים פעולה לעדכון תוכן האימייל של טיוטה.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderמגדירה פעולה שמעדכנת את הנמענים בעותק של טיוטה.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderהגדרת פעולה לעדכון שורת הנושא של טיוטה.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderמגדירה פעולה שמעדכנת את הנמענים של טיוטה.

UpdateDraftBccRecipientsAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionמעדכן את הנמענים בשדה 'עותק מוסתר' בטיוטה של הודעת אימייל.

UpdateDraftBodyAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addUpdateContent(content, contentType)UpdateDraftBodyActionמוסיפה את התוכן שצוין לגוף הטיוטה.
setUpdateType(updateType)UpdateDraftBodyActionמגדיר את UpdateDraftBodyType של פעולת העדכון הזו בגוף הטיוטה.

UpdateDraftBodyType

מאפיינים

נכססוגתיאור
IN_PLACE_INSERTEnumברירת מחדל.
INSERT_AT_STARTEnumפעולות העדכון מוסיפות תוכן בתחילת גוף ההודעה.
INSERT_AT_ENDEnumפעולות העדכון מוסיפות תוכן בסוף גוף ההודעה.

UpdateDraftCcRecipientsAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionמעדכן את הנמענים בשדה 'עותק' בטיוטה של הודעת אימייל.

UpdateDraftSubjectAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addUpdateSubject(subject)UpdateDraftSubjectActionמעדכן את שורת הנושא של טיוטת אימייל.

UpdateDraftToRecipientsAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionמעדכן את הנמענים בשדה 'אל' בטיוטה של אימייל.

UpdateInlinePreviewAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addCardWithId(cardWithId)UpdateInlinePreviewActionהוספת הכרטיס לפעולה הזו.
addExpiration(ttl)UpdateInlinePreviewActionהוספת תאריך התפוגה לפעולה הזו.

UpdateMessageAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setMessage(message)UpdateMessageActionמגדיר את ההודעה לפעולה הזו.

UpdateWidget

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetמוסיף פריט חדש שאפשר לבחור בו, לתפריטים עם אפשרות לבחירה מרובה.

ValidationErrorSeverity

מאפיינים

נכססוגתיאור
SEVERITY_UNSPECIFIEDEnumלא צוין.
CRITICALEnumקריטית, השגיאה קריטית וחובה לתקן אותה לפני הפרסום.
WARNINGEnumאזהרה, השגיאה לא קריטית ולא מונעת פרסום.

ValueMetadata

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addCastableType(dataType)ValueMetadataמוסיף סוגים אופציונליים מותרים שאפשר להמיר באופן דינמי לנתוני משתנה למטא-נתונים של הערך הזה.
addEnumValue(enumValue)ValueMetadataמוסיפים ערך מחרוזת אופציונלי לערכי ה-enum המותרים של משתנה. אפשר להגדיר את השדה הזה רק אם DataType מוגדר כסוג String.
setDefaultValue(defaultValue)ValueMetadataהגדרת ערך ברירת המחדל האופציונלי של המשתנה. לדוגמה, אם סוג המשתנה הוא בוליאני, אפשר להגדיר את defaultValue כ-true או כ-false.

VariableData

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addBooleanValue(value)VariableDataהפעולה מוסיפה ערך בוליאני לנתוני המשתנה.
addEmailAddress(emailAddress)VariableDataהוספת כתובת אימייל לנתוני המשתנה.
addFloatValue(value)VariableDataהוספת ערך מסוג float לנתוני המשתנה.
addGoogleUser(googleUser)VariableDataהתג מוסיף משתמש Google לנתוני המשתנה.
addIntegerValue(value)VariableDataהוספת ערך של מספר שלם לנתוני המשתנה.
addResourceData(resourceData)VariableDataמוסיפים ערך ResourceData לנתוני המשתנה.
addResourceReference(resourceReference)VariableDataהוספת מזהה הפניה למשאב לנתוני המשתנה.
addStringValue(value)VariableDataהוספת ערך מחרוזת לנתוני המשתנה.
addTimestampValue(value)VariableDataמוסיפים ערך TimeStamp לנתוני המשתנה.
addWorkflowTextFormat(workflowTextFormat)VariableDataמוסיפים ערך WorkflowTextFormat לנתוני המשתנה.

WorkflowAction

WorkflowTextFormat

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addTextFormatElement(textFormatElement)WorkflowTextFormatהוספת TextFormatElement לפורמט הטקסט של תהליך העבודה.

WorkflowValidationErrorAction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
setSeverity(severity)WorkflowValidationErrorActionהגדרת דרגת החומרה של שגיאת האימות.