AddOns Response Service

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

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

שיעורים

שם	תיאור קצר
Action	פעולה שתוספים ל-Google Workspace שמורחבים על ידי Google Workspace Studio יכולים להשתמש בה כדי להציג כרטיס חדש.
AddOnsResponseService	‫AddOnsResponseService מאפשר ליצור תשובות לתוספים של Google Workspace שמרחיבים את Google Workspace Studio.
BasicDataType	סוג enum שמייצג את סוגי הנתונים הגנריים הבסיסיים.
Color	אובייקט Color שמייצג צבע במרחב הצבעים RGBA.
DataType	המאפיין DataType משמש להגדרת הסוג של משתנה.
DynamicResourceDefinition	האובייקט DynamicResourceDefinition הוא אבן בניין של ResourceFieldsDefinitionRetrievedAction, והוא יכול להכיל מספר אחד או יותר של ResourceField כדי להגדיר באופן דינמי את מספר משתני הפלט שמוצגים בשלב ב-Google Workspace Studio.
ErrorActionability	סוג Enum שמייצג את הפעולה שאפשר לבצע בעקבות השגיאה.
ErrorRetryability	סוג Enum שמייצג את האפשרות לנסות שוב להפעיל את הפעולה כשיש שגיאה.
FontWeight	סוג enum שמייצג את עובי הגופן של הטקסט המעוצב.
HostAppAction	HostAppAction הוא סוג של פעולה שמטופלת על ידי אפליקציות מארחות בודדות.
Hyperlink	רכיב היפר-קישור שמשמש ב-TextFormatElement.
InsertSection	אובייקט Builder ליצירת אובייקטים מהטיפוס InsertSection.
InsertWidget	כלי ליצירת אובייקטים של InsertWidget.
Link	אובייקט הקישור ממקור של צד שלישי שהומר לצ'יפ חכם באפליקציית המארח.
ListContainer	קונטיינר לפריטים ברשימה, שכל אחד מהם יכול להכיל כמה תגי TextFormatElement.
ListItem	פריט ברשימה, כאשר כל פריט ברשימה יכול להכיל כמה תגי TextFormatElement.
ListType	סוג enum שמייצג את סוג הרשימה.
ModifyCard	כלי ליצירת אובייקטים מסוג ModifyCard שמשנה ומעדכן את הממשק של כרטיס קיים על ידי העברת אובייקט מסוג ModifyCard אל Action.
Navigation	אובייקט עזר ששולט בניווט בכרטיס.
RemoveSection	אובייקט builder ל-RemoveSection.
RemoveWidget	כלי ליצירת אובייקטים של RemoveWidget.
RenderAction	הפונקציה מעבדת או מעדכנת כרטיס על ידי ביצוע Action בתגובה לאינטראקציה של משתמש.
RenderActionBuilder	אובייקט builder ל-RenderAction.
ResourceData	מייצג נתוני משאב ספציפיים לאפליקציה. נתוני משאב מכילים אוסף של צמדי מפתח-ערך של שמות משתנים ושל VariableData.
ResourceField	ResourceField הוא אבן בניין בסיסית של DynamicResourceDefinition, וכל ResourceField תואם למשתנה פלט של השלב הנוכחי.
ResourceFieldsDefinitionRetrievedAction	ResourceFieldsDefinitionRetrievedAction הוא סוג של ResourceFieldsDefinitionRetrievedAction שמשמש לאחזור ההגדרה של רשימת שדות משאבים באמצעות פונקציית dynamicResourceDefinitionProvider שצוינה במניפסט.
ResourceRetrievedAction	משתמשים ב-ResourceRetrievedAction כדי לאחזר תוכן של משאב מותאם אישית כשצריך, כאשר השדה של המשאב המותאם אישית מוגדר ב-ResourceData.
ResourceType	סוג משאב ספציפי לאפליקציה, למזהה הייחודי של סוג המשאב צריכה להיות WorkflowResourceDefinition תואמת.
ReturnElementErrorAction	‫ReturnElementErrorAction מציין שהתרחשה שגיאה במהלך הפעלת הרכיב.
ReturnOutputVariablesAction	מכיל משתני פלט שנוצרו על ידי הפעולה שהופעלה ב-Google Workspace Studio.
SaveWorkflowAction	הפעולה הזו מציינת שאפליקציית המארח (Google Workspace Studio) צריכה לשמור את הסוכן.
StyledText	רכיב טקסט עם סגנונות כמו הדגשה, נטייה וצבע.
TextFormatChip	צ'יפ שאפשר ללחוץ עליו בפורמט טקסט.
TextFormatElement	רכיב של עיצוב טקסט, שיכול להיות TextFormatChip, StyledText, Hyperlink או ListContainer.
TextFormatIcon	סמל שמוצג בתוך TextFormatChip.
TextStyle	סוג enum שמייצג את הסגנון של הטקסט המעוצב.
TimeStamp	מייצג אובייקט של חותמת זמן שאפשר להוסיף ל-VariableData.
UpdateWidget	אובייקט builder ל-UpdateWidget.
ValidationErrorSeverity	סוג enum שמייצג את חומרת שגיאת האימות.
ValueMetadata	‫valueMetadata מכיל מידע על הערכים הפוטנציאליים של משתנה.
VariableData	מייצג נתונים משתנים שיכולים להכיל אוסף של ערכים מסוגים שונים.
WorkflowAction	WorkflowAction הוא סוג של HostAppAction שמשמש לביצוע פעולה ספציפית ב-Google Workspace Studio.
WorkflowTextFormat	בלוק טקסט עם אפשרויות עיצוב עשירות, כולל סגנונות, היפר-קישורים ואלמנטים אינטראקטיביים שהוגדרו ב-TextFormatElement.
WorkflowValidationErrorAction	הפעולה הזו מציינת שאפליקציית המארח (Google Workspace Studio) צריכה להציג שגיאת אימות.

Action

Methods

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

AddOnsResponseService

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
newAction()	Action	יוצרת Action חדש.
newNavigation()	Navigation	יוצרת Navigation חדש.
newRenderActionBuilder()	RenderActionBuilder	יוצרת RenderActionBuilder חדש.

BasicDataType

מאפיינים

נכס	סוג	תיאור
BASIC_TYPE_UNSPECIFIED	Enum	ערך ברירת המחדל.
STRING	Enum	מחרוזת של תווים.
INTEGER	Enum	ערך של מספר שלם.
FLOAT	Enum	מספר נקודה צפה.
TIMESTAMP	Enum	חותמת זמן בפורמט ISO 8601.
BOOLEAN	Enum	ערך בוליאני.
EMAIL_ADDRESS	Enum	מחרוזת בפורמט של כתובת אימייל.
GOOGLE_USER	Enum	משתמש בשירותי Google, בפורמט users/encoded_GAIA_ID
FILE	Enum	סוג הקובץ.
FORMATTED_TEXT	Enum	טקסט עם עיצוב עשיר.

Color

Methods

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

DataType

Methods

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

DynamicResourceDefinition

Methods

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

ErrorActionability

מאפיינים

נכס	סוג	תיאור
ERROR_ACTIONABILITY_UNSPECIFIED	Enum	לא צוין.
NOT_ACTIONABLE	Enum	המשתמש לא יכול לתקן את השגיאה באמצעות כרטיס ההגדרה.
ACTIONABLE	Enum	המשתמש יכול לתקן את השגיאה באמצעות כרטיס ההגדרה.

ErrorRetryability

מאפיינים

נכס	סוג	תיאור
RETRYABILITY_UNSPECIFIED	Enum	לא צוין.
NOT_RETRYABLE	Enum	אי אפשר לנסות שוב לתקן את השגיאה, התהליך מסתיים אחרי הניסיון הראשון.
RETRYABLE	Enum	אפשר לנסות שוב לבצע את הפעולה. תהליך העבודה ינסה לבצע את השלב עד 5 פעמים.

FontWeight

מאפיינים

נכס	סוג	תיאור
FONT_WEIGHT_UNSPECIFIED	Enum	משקל רגיל עם עובי רגיל.
LIGHT	Enum	משקל קל יותר ועובי מופחת.
MEDIUM	Enum	משקל ביניים בין light ל-bold.
BOLD	Enum	משקל כבד יותר עם עובי מוגדל.

HostAppAction

Methods

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

Hyperlink

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 שיוכנס.

Link

Methods

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

ListContainer

Methods

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

ListItem

Methods

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

ListType

מאפיינים

נכס	סוג	תיאור
LIST_TYPE_UNSPECIFIED	Enum	ערך ברירת המחדל.
ORDERED	Enum	רשימה ממוינת.
UNORDERED	Enum	רשימה לא ממוינת.

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 לאובייקט הכרטיס הזה של שינוי.

Navigation

Methods

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

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	הגדרת יומן השגיאות כך שיוצג למשתמש הקצה בפיד הפעילות של Workflow.
setErrorRetryability(errorRetryability)	ReturnElementErrorAction	מגדיר את האפשרות לנסות שוב במקרה של שגיאה. התהליך מסתיים אחרי הניסיון הראשון אם השגיאה לא מאפשרת ניסיון חוזר.

ReturnOutputVariablesAction

Methods

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

SaveWorkflowAction

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 שמוגדר ב-Google Material Icons.

TextStyle

מאפיינים

נכס	סוג	תיאור
STYLE_UNSPECIFIED	Enum	לא הוחל סגנון.
ITALIC	Enum	סגנון נטוי.
UNDERLINE	Enum	סגנון קו תחתון.
STRIKETHROUGH	Enum	סגנון קו חוצה.
LINE_BREAK	Enum	מעבר שורה.
UPPERCASE	Enum	סגנון אותיות רישיות.
CODE	Enum	סגנון הקוד.
CODE_BLOCK	Enum	סגנון בלוק הקוד.

TimeStamp

Methods

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

UpdateWidget

Methods

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

ValidationErrorSeverity

מאפיינים

נכס	סוג	תיאור
SEVERITY_UNSPECIFIED	Enum	לא צוין.
CRITICAL	Enum	קריטית, השגיאה קריטית וחובה לתקן אותה לפני הפרסום.
WARNING	Enum	אזהרה, השגיאה לא קריטית ולא מונעת פרסום.

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	הגדרת דרגת החומרה של שגיאת האימות.