אינדקס
-
CalendarClientActionMarkup(הודעה) -
CalendarClientActionMarkup.AddAttachmentsActionMarkup(הודעה) -
CalendarClientActionMarkup.AddAttachmentsActionMarkup.AddonAttachment(הודעה) -
CalendarClientActionMarkup.CalendarSubscriptionActionMarkup(הודעה) CalendarClientActionMarkup.CalendarSubscriptionActionMarkup.Operation(enum)-
CalendarClientActionMarkup.ConferenceDataMarkup(הודעה) -
CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup(הודעה) CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Feature(enum)CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Type(enum)-
CalendarClientActionMarkup.ConferenceDataMarkup.Error(הודעה) CalendarClientActionMarkup.ConferenceDataMarkup.Error.Type(enum)-
CalendarClientActionMarkup.ConferenceDataMarkup.Parameter(הודעה) -
CalendarClientActionMarkup.CreateConferenceDataActionMarkup(הודעה) -
CalendarClientActionMarkup.CreateConferenceSettingUrlActionMarkup(הודעה) -
CalendarClientActionMarkup.EditAttendeesActionMarkup(הודעה) -
CalendarClientActionMarkup.EditConferenceDataActionMarkup(הודעה) -
ChatClientDataSourceMarkup(הודעה) -
ChatClientDataSourceMarkup.SpaceDataSource(הודעה) -
ChatDataActionMarkup(הודעה) -
ChatDataActionMarkup.CreateMessageAction(הודעה) -
ChatDataActionMarkup.UpdateInlinePreviewAction(הודעה) -
ChatDataActionMarkup.UpdateMessageAction(הודעה) -
DriveClientActionMarkup(הודעה) -
DriveClientActionMarkup.RequestFileScope(הודעה) -
EditorClientActionMarkup(הודעה) -
EditorClientActionMarkup.RequestFileScopeForActiveDocument(הודעה) -
GmailClientActionMarkup(הודעה) -
GmailClientActionMarkup.AddonComposeUiActionMarkup(הודעה) GmailClientActionMarkup.AddonComposeUiActionMarkup.AddonComposeUiActionType(enum)-
GmailClientActionMarkup.OpenCreatedDraftActionMarkup(הודעה) -
GmailClientActionMarkup.TaskActionMarkup(הודעה) -
GmailClientActionMarkup.UpdateDraftActionMarkup(הודעה) -
GmailClientActionMarkup.UpdateDraftActionMarkup.Recipient(הודעה) -
GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBccRecipients(הודעה) -
GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody(הודעה) GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.ContentType(enum)GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.EmailMimeType(enum)-
GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.InsertContent(הודעה) GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.Type(enum)-
GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateCcRecipients(הודעה) -
GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateSubject(הודעה) -
GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateToRecipients(הודעה) -
HostAppActionMarkup(הודעה) -
HostAppDataActionMarkup(הודעה) -
HostAppDataSourceMarkup(הודעה) -
SheetsClientActionMarkup(הודעה) -
SheetsClientActionMarkup.CustomFunctionReturnValueMarkup(הודעה) -
WorkflowClientActionMarkup(הודעה) -
WorkflowClientActionMarkup.ResourceData(הודעה) -
WorkflowClientActionMarkup.ResourceFieldsDefinitionRetrievedAction(הודעה) -
WorkflowClientActionMarkup.ResourceFieldsDefinitionRetrievedAction.DynamicResourceDefinition(הודעה) -
WorkflowClientActionMarkup.ResourceFieldsDefinitionRetrievedAction.ResourceField(הודעה) -
WorkflowClientActionMarkup.ResourceRetrievedAction(הודעה) -
WorkflowClientActionMarkup.ReturnElementErrorAction(הודעה) WorkflowClientActionMarkup.ReturnElementErrorAction.ErrorActionability(enum)WorkflowClientActionMarkup.ReturnElementErrorAction.Retryability(enum)-
WorkflowClientActionMarkup.ReturnOutputVariablesAction(הודעה) -
WorkflowClientActionMarkup.SaveWorkflowAction(הודעה) -
WorkflowClientActionMarkup.SourceResourceReference(הודעה) -
WorkflowClientActionMarkup.SourceResourceType(הודעה) -
WorkflowClientActionMarkup.VariableData(הודעה) -
WorkflowClientActionMarkup.WorkflowValidationErrorAction(הודעה) WorkflowClientActionMarkup.WorkflowValidationErrorAction.Severity(enum)-
WorkflowDataSourceMarkup(הודעה) WorkflowDataSourceMarkup.Type(enum)-
WorkflowTextFormatMarkup(הודעה) -
WorkflowTextFormatMarkup.Chip(הודעה) -
WorkflowTextFormatMarkup.Icon(הודעה) -
WorkflowTextFormatMarkup.TextFormatElement(הודעה) -
WorkflowTextFormatMarkup.TextFormatElement.Hyperlink(הודעה) -
WorkflowTextFormatMarkup.TextFormatElement.ListContainer(הודעה) -
WorkflowTextFormatMarkup.TextFormatElement.ListContainer.ListItem(הודעה) WorkflowTextFormatMarkup.TextFormatElement.ListContainer.ListType(enum)-
WorkflowTextFormatMarkup.TextFormatElement.StyledText(הודעה) WorkflowTextFormatMarkup.TextFormatElement.StyledText.FontWeight(enum)WorkflowTextFormatMarkup.TextFormatElement.StyledText.Style(enum)WorkflowTextFormatMarkup.TextFormatElement.StyledText.WrapStyle(enum)
CalendarClientActionMarkup
| שדות | |
|---|---|
editAttendeesActionMarkup |
פעולה שמוסיפה משתתפים לאירוע ביומן Google. |
editConferenceDataActionMarkup |
פעולה שמוסיפה את נתוני שיחת הוועידה לאירוע ביומן Google. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script. |
addAttachmentsActionMarkup |
פעולה שמוסיפה קבצים מצורפים לאירוע ביומן Google. |
createConferenceDataActionMarkup |
פעולה שמאפשרת להציג את נתוני שיחת הוועידה כשיוצרים אירוע ביומן Google. |
createConferenceSettingUrlActionMarkup |
פעולה שיוצרת את כתובת ה-URL של ההגדרה createconference. |
calendarSubscriptionActionMarkup |
פעולה שקשורה לניהול מינוי ליומן. תומך ביצירת מינויים בתוספים של נקודות קצה (endpoints) של HTTP בלבד. לא רלוונטי לתוספים של Apps Script. |
AddAttachmentsActionMarkup
| שדות | |
|---|---|
addonAttachments[] |
|
AddonAttachment
| שדות | |
|---|---|
resourceUrl |
|
title |
שם הקובץ המצורף. |
mimeType |
סוג MIME של התוכן ב-resourceUrl. |
iconUrl |
קישור לסמל של המשאב. |
CalendarSubscriptionActionMarkup
פעולה שמנהלת מינוי ליומן של המשתמש הנוכחי.
יצירת מינוי היא פעולה אידמפוטנטית: אם המשתמש כבר מנוי ליומן שצוין בפריסת התוסף הזו, החזרת הפעולה הזו מבטיחה שהמינוי יישאר פעיל בלי ליצור מינויים כפולים או התראות לגבי אירועים כפולות. לא צריך לבדוק אם יש מינויים קיימים לפני החזרת הפעולה הזו.
תומך ביצירת מינויים בתוספים של נקודות קצה (endpoint) של HTTP בלבד. לא רלוונטי לתוספים של Apps Script.
| שדות | |
|---|---|
operation |
הפעולה שצריך לבצע. בשלב הזה יש תמיכה רק ב- |
calendarId |
מזהה היומן שרוצים להירשם אליו. |
פעולה
| טיפוסים בני מנייה (enum) | |
|---|---|
OPERATION_UNSPECIFIED |
|
CREATE |
|
ConferenceDataMarkup
תגי עיצוב שמגדירים את נתוני שיחת הוועידה שמשויכים לאירוע ביומן Google. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.
| שדות | |
|---|---|
conferenceId |
מזהה ייחודי של נתוני הוועידה. עד 512 תווים. |
entryPoints[] |
נקודות כניסה לשיחת הוועידה. אפשר להוסיף עד 300 נקודות כניסה. |
parameters[] |
פרמטרים נוספים של התוסף. אפשר להוסיף עד 300 פרמטרים. |
error |
אם הוא מוגדר, זה אומר שהייתה שגיאה במהלך יצירת השיחה. |
note |
הערות נוספות (כמו הוראות מהאדמין, הודעות משפטיות) שיוצגו למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2,048 תווים. |
conferenceSolutionId |
מזהה של הפתרון לשיחות ועידה. הערך חייב להתאים לערך בשדה |
EntryPointMarkup
דרך להצטרף לשיחת הוועידה. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.
| שדות | |
|---|---|
type |
סוג נקודת הכניסה. חובה. |
uri |
URI להצטרפות לשיחת הוועידה. השדה תומך ב-tel: וב-http(s): , והאורך שלו צריך להיות עד 1,300 תווים. חובה. |
label |
התווית של נקודת הכניסה שתוצג למשתמש. עד 512 תווים. |
meetingCode |
קוד פגישה כדי להצטרף לוועידה. עד 128 תווים. |
accessCode |
קוד גישה לשיחת הוועידה. עד 128 תווים. |
passcode |
קוד גישה לשיחת הוועידה. עד 128 תווים. |
password |
סיסמה לגישה לוועידה. עד 128 תווים. |
pin |
קוד אימות כדי להצטרף לשיחת הוועידה. עד 128 תווים. |
regionCode |
קוד האזור לפי CLDR/ISO 3166 של המדינה שמשויכת לנקודת הכניסה הזו. רלוונטי רק ל- |
features[] |
מאפיינים של נקודת הכניסה, כמו שיחת חינם או שיחה בתשלום. לנקודת כניסה אחת יכולות להיות כמה תכונות. |
תכונה
התכונות של נקודת הכניסה. יכול להיות שחלק מהתכונות יחולו רק על נקודות כניסה ספציפיות.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN_FEATURE |
תכונה לא ידועה. |
TOLL |
ההגדרה חלה על נקודת הכניסה PHONE. שיחה למספר בתשלום מחויבת בחשבון של המתקשר. מספר לא יכול להיות גם בתשלום וגם בחינם. |
TOLL_FREE |
ההגדרה חלה על נקודת כניסה אחת (PHONE). המתקשר לא משלם על שיחה למספר חינם. מספר לא יכול להיות גם בתשלום וגם בחינם. |
סוג
סוג נקודת הכניסה. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
סוג השיחה לא ידוע. |
VIDEO |
שיחת ועידה בווידאו. |
PHONE |
שיחת ועידה בטלפון. |
MORE |
משמש כדי לספק קישור למידע נוסף על הצטרפות לוועידה. |
SIP |
שיחת ועידה באמצעות Session Initiation Protocol |
שגיאה
מייצג שגיאה שאירעה במהלך יצירת השיחה. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.
| שדות | |
|---|---|
type |
סוג השגיאה. חובה. |
authenticationUrl |
אם סוג השגיאה הוא |
סוג
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
שגיאה לא ידועה. |
AUTHENTICATION |
שגיאת אימות. |
TEMPORARY |
שגיאה זמנית. |
PERMANENT |
שגיאה קבועה. |
PERMISSION_DENIED |
למשתמש אין הרשאה לבצע פעולה מסוימת במערכת של הצד השלישי לשיחות ועידה. |
CONFERENCE_SOLUTION_FORBIDDEN |
למשתמש אין הרשאה להשתמש בפתרון לשיחות ועידה שנבחר (אבל יכול להיות שיש לו הרשאה להשתמש בפתרונות אחרים שמוצעים בתוסף). |
פרמטר
פרמטרים ספציפיים לפתרון שנשמרים עם נתוני האירוע, ואם צריך לעדכן או למחוק, הם מועברים לתוסף. לדוגמה: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]
| שדות | |
|---|---|
key |
המפתח של הפרמטר. עד 50 תווים. חובה. |
value |
ערך הפרמטר. האורך המקסימלי הוא 1,024 תווים. חובה. |
CreateConferenceDataActionMarkup
| שדות | |
|---|---|
createConferenceData |
נתוני שיחת הוועידה שצריך להוסיף לאירוע ביומן Google כשיוצרים אותו. |
CreateConferenceSettingUrlActionMarkup
| שדות | |
|---|---|
settingsUrl |
ה-URI של דף הגדרות שנוצר על ידי התוסף. |
EditAttendeesActionMarkup
| שדות | |
|---|---|
addAttendeeEmails[] |
רשימת משתתפים שרוצים להוסיף לאירוע ביומן Google. |
EditConferenceDataActionMarkup
| שדות | |
|---|---|
שדה של איחוד הערך |
|
conferenceData |
נתוני הוועידה שצריך להוסיף לאירוע ביומן Google. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script. |
ChatClientDataSourceMarkup
לווידג'ט של שמשתמש בתפריט לבחירת כמה פריטים, מקור נתונים מ-Google Chat. מקור הנתונים מאכלס את הפריטים לבחירה בתפריט הבחירה המרובה. לדוגמה, משתמש יכול לבחור מרחבים משותפים ב-Google Chat שהוא חבר בהם.SelectionInput
זמינה לאפליקציות ל-Google Chat ולא זמינה לתוספים ל-Google Workspace.
| שדות | |
|---|---|
שדה של איחוד source. מקור הנתונים של Google Chat. הערך source יכול להיות רק אחד מהבאים: |
|
spaceDataSource |
מרחבים משותפים ב-Google Chat שהמשתמש חבר בהם. |
SpaceDataSource
מקור נתונים שמאכלס מרחבים משותפים ב-Google Chat כפריטים לבחירה בתפריט לבחירה מרובה. מאכלס רק מרחבים שהמשתמש חבר בהם.
זמינה לאפליקציות ל-Google Chat ולא זמינה לתוספים ל-Google Workspace.
| שדות | |
|---|---|
defaultToCurrentSpace |
אם הערך הוא |
ChatDataActionMarkup
יצירה או עדכון של הודעה ב-Google Chat. פרטים נוספים זמינים במאמר פיתוח ממשקים של Google Chat.
| שדות | |
|---|---|
שדה של איחוד action. פעולה ב-Google Chat. הערך action יכול להיות רק אחד מהבאים: |
|
createMessageAction |
שליחת הודעה כאפליקציית Chat ב-Google Chat. |
updateMessageAction |
עדכון הודעה באפליקציה ל-Google Chat. |
updateInlinePreviewAction |
כדי לראות תצוגה מקדימה של קישורים, מוסיפים כרטיס אחד או יותר להודעה של משתמש ב-Google Chat. |
CreateMessageAction
האפליקציה ל-Chat שולחת הודעה. פרטים נוספים מופיעים במאמר שליחת הודעות ב-Google Chat.
| שדות | |
|---|---|
message |
הודעת הצ'אט ב-Google Chat. |
UpdateInlinePreviewAction
אפליקציית הצ'אט מציגה תצוגה מקדימה של קישור בהודעה על ידי הוספה או עדכון של כרטיס אחד או יותר. פרטים נוספים זמינים במאמר תצוגה מקדימה של קישורים בהודעות צ'אט ב-Google Chat.
| שדות | |
|---|---|
cardsV2[] |
מערך של כרטיס אחד או יותר. |
UpdateMessageAction
אפליקציית הצ'אט מעדכנת את הטקסט או את הכרטיסים בהודעה. פרטים נוספים מופיעים במאמר שליחת הודעות ב-Google Chat.
| שדות | |
|---|---|
message |
ההודעה המעודכנת. |
DriveClientActionMarkup
| שדות | |
|---|---|
requestFileScope |
|
RequestFileScope
| שדות | |
|---|---|
itemId |
|
EditorClientActionMarkup
| שדות | |
|---|---|
שדה של איחוד הערך |
|
requestFileScopeForActiveDocument |
|
RequestFileScopeForActiveDocument
בסוג הזה אין שדות.
GmailClientActionMarkup
| שדות | |
|---|---|
שדה של איחוד הערך |
|
taskAction |
|
updateDraftActionMarkup |
|
openCreatedDraftActionMarkup |
|
addonComposeUiActionMarkup |
|
AddonComposeUiActionMarkup
| שדות | |
|---|---|
type |
|
AddonComposeUiActionType
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED |
ברירת מחדל. אם לא מציינים פעולה, לא מתבצעת שום פעולה. |
DISMISS |
סגירת ממשק המשתמש של התוסף לכתיבת הודעות. |
OpenCreatedDraftActionMarkup
| שדות | |
|---|---|
draftId |
המזהה של הטיוטה החדשה שנוצרה, בפורמט "r123". |
draftStorageId |
מזהה האחסון בשרת בפורמט הקסדצימלי, לדוגמה,"15e9fa622ce1029d". |
draftThreadServerPermId |
המזהה הקבוע בשרת של השרשור של הטיוטה. השדה הזה לא מוגדר בשום מקום, והמערכת מתעלמת ממנו כשהיא מעבדת את OpenCreatedDraftActionMarkup. במקום זאת, צריך לספק את draftThreadStorageId ולהשתמש בו. |
draftThreadId |
המזהה של השרשור שמכיל את הטיוטה החדשה שנוצרה, לדוגמה, "15e9fa622ce1029d". |
TaskActionMarkup
| שדות | |
|---|---|
reloadTasks |
|
UpdateDraftActionMarkup
| שדות | |
|---|---|
updateBody |
שדה שמכיל סדרה של פעולות עדכון שצריך לבצע בגוף הטיוטה שהמשתמש עורך כרגע. |
updateToRecipients |
אם היא מוגדרת, היא מחליפה את הנמענים הקיימים בשדה "אל" בטיוטה שהמשתמש עורך כרגע. |
updateCcRecipients |
אם ההגדרה הזו מופעלת, היא מחליפה את הנמענים הקיימים בשדה "עותק" בטיוטה שהמשתמש עורך כרגע. |
updateBccRecipients |
אם המדיניות מוגדרת, היא מחליפה את הנמענים הקיימים בעותק מוסתר בטיוטה שהמשתמש עורך כרגע. |
updateSubject |
אם מגדירים את הפרמטר, הוא מחליף את הנושא הקיים של הטיוטה שהמשתמש עורך כרגע. |
הנמענים
| שדות | |
|---|---|
email |
|
UpdateBccRecipients
| שדות | |
|---|---|
bccRecipients[] |
|
UpdateBody
| שדות | |
|---|---|
insertContents[] |
שדה חוזר שמכיל סדרה של תכנים להוספה לטיוטה שהמשתמש עורך כרגע. התוכן יכול להכיל תוכן HTML או תוכן בטקסט פשוט. |
type |
|
ContentType
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED_CONTENT_TYPE |
ערך ברירת המחדל כשלא מוגדר ContentType. |
TEXT |
מציין שהתוכן הוא טקסט פשוט. |
MUTABLE_HTML |
מציין שהתוכן הוא ב-HTML וניתן לשינוי (אפשר לערוך אותו). |
IMMUTABLE_HTML |
מציין שהתוכן הוא ב-HTML ואי אפשר לשנות אותו (לערוך אותו). |
EmailMimeType
המאפיין EmailMimeType הוצא משימוש. צריך להשתמש ב-ContentType.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED_EMAIL_MIME_TYPE |
ערך ברירת המחדל כשלא מוגדר ערך ל-EmailMimeType. |
PLAIN_TEXT |
מציין שהתוכן שנוסף הוא טקסט פשוט. |
HTML |
מציין שהתוכן שנוסף הוא ב-HTML. |
InsertContent
| שדות | |
|---|---|
content |
התוכן שרוצים להוסיף. |
mimeType |
|
contentType |
סוג התוכן שנוסף. |
סוג
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED_ACTION_TYPE |
ערך ברירת המחדל כשלא מוגדר סוג. |
IN_PLACE_INSERT |
מציין שהפעולה הזו היא הוספה במקום. כברירת מחדל, התוכן נוסף במיקום הנוכחי של הסמן. אם יש תוכן שנבחר, הוא מוחלף בתוכן החדש. |
INSERT_AT_START |
מציין שהפעולה הזו היא הוספה בתחילת גוף ההודעה. |
INSERT_AT_END |
מציין שהפעולה הזו היא הוספה בסוף גוף ההודעה. |
REPLACE |
מציין שהפעולה הזו תחליף את גוף ההודעה. |
UpdateCcRecipients
| שדות | |
|---|---|
ccRecipients[] |
|
UpdateSubject
| שדות | |
|---|---|
subject |
|
UpdateToRecipients
| שדות | |
|---|---|
toRecipients[] |
|
HostAppActionMarkup
פעולות שמטופלות על ידי אפליקציות מארחות ספציפיות.
| שדות | |
|---|---|
שדה של איחוד הערך |
|
gmailAction |
פעולות שמטופלות על ידי Gmail. |
calendarAction |
פעולות שמטופלות על ידי היומן. |
driveAction |
פעולות שמטופלות על ידי Drive. |
editorAction |
פעולות שמטופלות על ידי Docs, Sheets או Slides. |
sheetsAction |
פעולות שמטופלות על ידי Sheets. |
workflowAction |
פעולות שמטופלות על ידי Workspace Studio. |
HostAppDataActionMarkup
מגדירה איך לעדכן את הנתונים ב-Google Workspace.
| שדות | |
|---|---|
שדה של איחוד action. פעולת התוסף לאפליקציה מארחת נתונה של Google Workspace. הערך action יכול להיות רק אחד מהבאים: |
|
chatDataAction |
פעולה ב-Google Chat שיוצרת או מעדכנת טקסט או כרטיסים בהודעה. |
HostAppDataSourceMarkup
מקור נתונים מאפליקציה של Google Workspace. מקור הנתונים מאכלס את הפריטים הזמינים לווידג'ט.
| שדות | |
|---|---|
שדה של איחוד data_source. אפליקציית Google Workspace שמאכלסת את הפריטים הזמינים לווידג'ט. הערך data_source יכול להיות רק אחד מהבאים: |
|
chatDataSource |
מקור נתונים מ-Google Chat. |
workflowDataSource |
מקור נתונים מ-Google Workflow. |
SheetsClientActionMarkup
המזהה הבא: 5.
| שדות | |
|---|---|
שדה של איחוד הערך |
|
customFunctionReturnValueMarkup |
|
CustomFunctionReturnValueMarkup
התוצאה של הפעלת פונקציה מותאמת אישית על ידי משתמש.
| שדות | |
|---|---|
שדה של איחוד result. התוצאה של הפעלת הפונקציה המותאמת אישית. הערך result יכול להיות רק אחד מהבאים: |
|
value |
הערך שנוצר כתוצאה מהפעלת הפונקציה המותאמת אישית. |
errorMessage |
הודעת השגיאה שתוצג למשתמש אם משהו השתבש. |
WorkflowClientActionMarkup
פעולות של לקוחות בתוספים ל-Workspace Studio.
| שדות | |
|---|---|
שדה של איחוד הערך |
|
saveWorkflowAction |
פעולה לשמירת תהליך העבודה. |
returnOutputVariablesAction |
פעולה שמכילה משתני פלט שנוצרו על ידי פעולה שהופעלה בתהליך העבודה. |
resourceRetrievedAction |
פעולה שמכילה משאב שאוחזר. |
resourceFieldsDefinitionRetrievedAction |
פעולה שמכילה את הגדרת השדות של משאב. |
returnElementErrorAction |
פעולה שמציינת שאירעה שגיאה במהלך הפעלת הרכיב. |
workflowValidationErrorAction |
פעולה שמציינת שגיאה באימות של תהליך העבודה. |
ResourceData
ערך המשאב הספציפי לאפליקציה.
| שדות | |
|---|---|
fields |
מפה של שדות המשאבים, עם מפתחות לפי שם השדה. |
sourceResourceReference |
הוצא משימוש. במקום זאת, צריך להשתמש ב-VariableData.variable_source_data. |
ResourceFieldsDefinitionRetrievedAction
מכיל את ההגדרה של כל שדה שנתמך על ידי משאב.
| שדות | |
|---|---|
dynamicResourceDefinitions[] |
הגדרות דינמיות של משאבים. |
DynamicResourceDefinition
מכיל את ההגדרה של כל שדה שנתמך על ידי משאב דינמי.
| שדות | |
|---|---|
resourceId |
המזהה הייחודי של סוג המשאב הדינמי. לדוגמה, "FORM_RESPONSE_VALUES" |
fields[] |
רשימת השדות שנתמכים על ידי המשאב הדינמי הזה. |
ResourceField
| שדות | |
|---|---|
selector |
מפתח העזר של השדה שמשמש לאחזור הערך שמשויך אליו. |
displayText |
התיאור הקריא לאנשים של השדה שמוצג למשתמש הקצה במהלך בחירת המשתנה. |
dataType |
סוג הנתונים של השדה. |
cardinality |
העוצמה (cardinality) של השדה. |
ResourceRetrievedAction
מכיל את המשאב שהוחזר.
| שדות | |
|---|---|
resourceData |
נתונים בהתאמה אישית בפורמט פרוטו. |
ReturnElementErrorAction
מציין שאירעה שגיאה במהלך הפעלת הרכיב.
| שדות | |
|---|---|
developerErrorMessage |
הודעת שגיאה שמוצגת למפתחים. |
errorLog |
הודעת השגיאה הקריאה לאנשים שתוצג למשתמש הקצה. |
errorActionability |
האם המשתמש יכול לפתור את השגיאה. |
retryability |
אם אפשר לנסות שוב או לא. |
ErrorActionability
אם המשתמש יכול לנסות לתקן את השגיאה.
| טיפוסים בני מנייה (enum) | |
|---|---|
ERROR_ACTIONABILITY_UNSPECIFIED |
פעולה אפשרית לשגיאה לא מזוהה. אין להשתמש בו. |
ACTIONABLE |
המשתמש יכול לנסות לתקן את השגיאה. |
NOT_ACTIONABLE |
המשתמש לא יכול לתקן את השגיאה. |
אפשרות לניסיון חוזר
אם אפשר לנסות שוב או לא.
| טיפוסים בני מנייה (enum) | |
|---|---|
RETRYABILITY_UNSPECIFIED |
לא צוינה אפשרות לניסיון חוזר. אין להשתמש בו. |
RETRYABLE |
אפשר לנסות שוב. |
NOT_RETRYABLE |
אי אפשר לנסות שוב. |
ReturnOutputVariablesAction
מכיל משתני פלט שנוצרו על ידי פעולת תהליך העבודה שהופעלה.
| שדות | |
|---|---|
variables |
מפה של משתנים עם מפתח לפי מזהה משתנה. |
log |
יומן של פעולת תהליך העבודה שבוצעה. |
SaveWorkflowAction
בסוג הזה אין שדות.
מציין שהכלי ליצירת תהליכי עבודה צריך להתחיל לשמור את תהליך העבודה.
SourceResourceReference
הפניה למופע ספציפי של משאב ב-Workspace
| שדות | |
|---|---|
sourceResourceType |
סוג המשאב של המקור. |
resourceId |
המזהה הייחודי של המשאב (למשל, מזהה הקובץ ב-Drive, מזהה ההודעה ב-Gmail). |
SourceResourceType
סוג המשאב של המקור. הוא משמש לזיהוי סוג המשאב וחבילת תהליך העבודה שאליה שייך סוג המשאב.
| שדות | |
|---|---|
workflowBundleId |
המזהה של חבילת תהליך העבודה שהמשאב הזה שייך אליה. |
resourceDefinitionId |
המזהה של הגדרת המשאב בתוך החבילה (למשל, "spreadsheet", "gmailMessage"). |
VariableData
מייצג נתונים משתנים, שיכולים להכיל כמה ערכים מסוגים שונים.
| שדות | |
|---|---|
booleanValues[] |
ערכים בוליאניים. |
integerValues[] |
ערכים של מספרים שלמים. |
stringValues[] |
ערכי מחרוזת. |
timestampValues[] |
ערכים של חותמות זמן. |
resourceReferences[] |
רשימה של מזהי משאבים (למשל, "spaces/123"). |
resourceDataValues[] |
נתוני משאבים. |
emailAddressValues[] |
ערכים של כתובות אימייל. |
googleUserValues[] |
ערכי משתמשים של Google בפורמט |
textFormatValues[] |
ערכי פורמט הטקסט של תהליך העבודה. |
WorkflowValidationErrorAction
מציין שהאימות של רכיב תהליך העבודה נכשל ברמת החומרה שצוינה.
| שדות | |
|---|---|
severity |
חומרת שגיאת האימות. |
מידת החומרה
| טיפוסים בני מנייה (enum) | |
|---|---|
SEVERITY_UNSPECIFIED |
לא צוינה רמת חומרה. אין להשתמש בו. |
WARNING |
השגיאה לא קריטית ולא מונעת את הפרסום. |
CRITICAL |
השגיאה קריטית וצריך לתקן אותה לפני הפרסום. |
WorkflowDataSourceMarkup
* נתמך רק על ידי Google Workspace Workflow, ולא על ידי אפליקציות ל-Google Chat או תוספים ל-Google Workspace.
בווידג'ט או TextInput מסוג MULTI_SELECT או בווידג'ט SelectionInput, צריך לספק מקור נתונים מ-Google.DateTimePicker
| שדות | |
|---|---|
includeVariables |
אם לכלול משתנים מהשלב הקודם במקור הנתונים. |
type |
סוג מקור הנתונים. |
סוג
enum שמייצג את הסוג של מקור הנתונים של תהליך העבודה.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNKNOWN |
ערך ברירת המחדל. אל תשתמשו בהם. |
USER |
משתמשי Google Workspace. המשתמש יכול לראות ולבחור רק משתמשים מהארגון שלו ב-Google Workspace. |
SPACE |
מרחבים משותפים ב-Google Chat שהמשתמש חבר בהם. |
USER_WITH_FREE_FORM |
המשתמשים יכולים לבחור לראות ולבחור חברים קיימים מהארגון שלהם ב-Google Workspace, או להזין ידנית כתובת אימייל או דומיין חוקי. |
WorkflowTextFormatMarkup
בלוק טקסט עם אפשרויות עיצוב עשירות, כולל סגנונות, היפר-קישורים ורכיבים אינטראקטיביים.
| שדות | |
|---|---|
textFormatElements[] |
אוסף של רכיבים לעיצוב טקסט. |
Chip
צ'יפ בפורמט טקסט שאפשר ללחוץ עליו.
| שדות | |
|---|---|
icon |
הסמל שמוצג בצ'יפ. |
label |
הטקסט שמוצג בצ'יפ. |
url |
כתובת ה-URL שאליה מועברים כשלוחצים על הצ'יפ. |
סמל
סמל בצ'יפ.
| שדות | |
|---|---|
שדה של איחוד icons. הסמל שמוצג בצ'יפ. הערך icons יכול להיות רק אחד מהבאים: |
|
iconUrl |
להציג סמל מותאם אישית שמתארח בכתובת URL מסוג HTTPS. לדוגמה: סוגי הקבצים הנתמכים כוללים את |
materialIconName |
שם הסמל שמוגדר ב-סמל של material של Google, לדוגמה, |
TextFormatElement
רכיב יחיד בהודעת WorkflowTextFormatMarkup, שיכול להיות צ'יפ, טקסט מעוצב, היפר-קישור או מאגר רשימות.
| שדות | |
|---|---|
שדה של איחוד element. רכיב שמייצג אחד מכמה רכיבים אפשריים של פורמט טקסט. הערך element יכול להיות רק אחד מהבאים: |
|
text |
טקסט בפורמט טקסט. |
chip |
צ'יפ שאפשר ללחוץ עליו בפורמט של טקסט. |
styledText |
טקסט מעוצב בפורמט הטקסט. |
hyperlink |
היפר-קישור בפורמט של טקסט. |
listContainer |
רשימת מאגרים בפורמט טקסט. |
Hyperlink
רכיב היפר-קישור עם טקסט וקישור.
| שדות | |
|---|---|
link |
כתובת היעד של ההיפר-קישור. |
text |
הטקסט של ההיפר-קישור. |
ListContainer
קונטיינר לפריטים ברשימה, שכל אחד מהם יכול להכיל כמה רכיבי TextFormatElement.
| שדות | |
|---|---|
listNestLevel |
רמת הדירוג של הרשימה. הערך מתחיל מ-0 ברמה העליונה, וגדל ב-1 בכל רשימה בת. |
listType |
סוג הרשימה. |
listItems[] |
אוסף של פריטים ברשימה. |
ListItem
פריט ברשימה.
| שדות | |
|---|---|
textFormatElements[] |
אוסף של רכיבים לעיצוב טקסט. |
ListType
Enum for different list types.
| טיפוסים בני מנייה (enum) | |
|---|---|
LIST_TYPE_UNSPECIFIED |
לא צוין סוג רשימה. |
ORDERED |
רשימה ממוינת. |
UNORDERED |
רשימה לא ממוינת. |
BLOCKQUOTE |
רשימת ציטוטים. |
StyledText
רכיב טקסט עם סגנונות כמו הדגשה, כתב נטוי וצבע.
| שדות | |
|---|---|
text |
התוכן העיקרי של הטקסט. |
styles[] |
אוסף של סגנונות שחלים על הטקסט. |
fontWeight |
עובי הגופן של הטקסט. |
color |
הצבע של הטקסט. |
wrapStyle |
סגנון הגלישה של הטקסט. |
FontWeight
Enum למשקלי גופן שונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
משקל סטנדרטי עם עובי רגיל. |
LIGHT |
קל ודק יותר. |
MEDIUM |
עובי בינוני בין דק למודגש. |
BOLD |
משקל כבד יותר ועובי גדול יותר. |
סגנון
Enum לסגנונות טקסט שונים כמו נטוי, קו תחתון וכו'.
| טיפוסים בני מנייה (enum) | |
|---|---|
STYLE_UNSPECIFIED |
לא הוחל סגנון. |
ITALIC |
סגנון נטוי. |
UNDERLINE |
סגנון קו תחתון. |
STRIKETHROUGH |
סגנון קו חוצה. |
LINE_BREAK |
מעבר שורה. |
UPPERCASE |
סגנון אותיות רישיות. |
CODE |
לתכנת. |
CODE_BLOCK |
בלוק קוד. |
WrapStyle
טיפוסים בני מנייה (enum) של סגנונות גלישה שונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
לא צוין סגנון גלישה. |
NO_WRAP |
אין סגנון גלישה. |