Package apps.extensions.markup

אינדקס

• CalendarClientActionMarkup (הודעה)
• CalendarClientActionMarkup.AddAttachmentsActionMarkup (הודעה)
• CalendarClientActionMarkup.AddAttachmentsActionMarkup.AddonAttachment (הודעה)
• 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.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 (הודעה)

CalendarClientActionMarkup

שדות
editAttendeesActionMarkup	EditAttendeesActionMarkup פעולה שמוסיפה משתתפים לאירוע ביומן Google.
editConferenceDataActionMarkup	EditConferenceDataActionMarkup פעולה שמוסיפה את נתוני הכנס לאירוע ביומן Google. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.
addAttachmentsActionMarkup	AddAttachmentsActionMarkup פעולה שמוסיפה קבצים מצורפים לאירוע ביומן Google.

AddAttachmentsActionMarkup

שדות
addonAttachments[]	AddonAttachment

AddonAttachment

שדות
resourceUrl	string
title	string כותרת הקובץ המצורף.
mimeType	string סוג ה-MIME של התוכן ב-resourceUrl.
iconUrl	string קישור לסמל המשאב.

ConferenceDataMarkup

סימון שמגדיר את נתוני הכנס שמשויכים לאירוע ביומן Google. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.

שדות
conferenceId	string מזהה ייחודי של נתוני הכנס הזה. האורך המקסימלי הוא 512 תווים.
entryPoints[]	EntryPointMarkup נקודות כניסה לוועידה. מותר להוסיף עד 300 נקודות כניסה.
parameters[]	Parameter פרמטרים נוספים של התוסף. אפשר להוסיף עד 300 פרמטרים.
error	Error אם הערך מוגדר, סימן שאירעה שגיאה במהלך יצירת שיחת הוועידה.
note	string הערות נוספות (כמו הוראות מהאדמין, הודעות משפטיות) שיוצגו למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2048 תווים.
conferenceSolutionId	string מזהה של פתרון לשיחות ועידה. חייב להתאים לערך בשדה calendar.conferenceSolution.id של הפריסה.

EntryPointMarkup

דרך להצטרף לוועידה. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.

שדות
type	Type הסוג של נקודת הכניסה. חובה.
uri	string URI להצטרפות לוועידה. התווית תומכת ב-tel: וב-http(s): והיא יכולה להיות באורך של עד 1,300 תווים. חובה.
label	string התווית של נקודת הכניסה שרוצים להציג למשתמש. האורך המקסימלי הוא 512 תווים.
meetingCode	string קוד פגישה כדי לגשת לוועידה. האורך המקסימלי הוא 128 תווים.
accessCode	string קוד גישה לצורך כניסה לוועידה. האורך המקסימלי הוא 128 תווים.
passcode	string קוד גישה כדי להצטרף לוועידה. האורך המקסימלי הוא 128 תווים.
password	string סיסמה לגישה לוועידה. האורך המקסימלי הוא 128 תווים.
pin	string קוד גישה לצורך גישה לוועידה. האורך המקסימלי הוא 128 תווים.
regionCode	string קוד האזור במאגר CLDR/ISO 3166 של המדינה שמשויכת לנקודת הכניסה הזו. רלוונטי רק ל-Type.PHONE.
features[]	Feature מאפיינים של נקודת הכניסה, כמו חיוב או חיוב חינם. לנקודת כניסה אחת יכולות להיות כמה תכונות.

תכונה

התכונות של נקודת הכניסה. יכול להיות שחלק מהתכונות חלות רק על נקודות כניסה ספציפיות.

טיפוסים בני מנייה (enum)
UNKNOWN_FEATURE	תכונה לא ידועה.
TOLL	רלוונטי לנקודת הכניסה PHONE. שיחה למספר בחיוג בתשלום מחויבת על המתקשר. אי אפשר להגדיר מספר כמספר בתשלום וכמספר בחיוג חינם בו-זמנית.
TOLL_FREE	רלוונטי לנקודת הכניסה PHONE. השיחה למספר חינם היא ללא תשלום עבור מבצע השיחה. אי אפשר להגדיר מספר כמספר בתשלום וכמספר בחיוג חינם בו-זמנית.

סוג

הסוג של נקודת הכניסה. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.

טיפוסים בני מנייה (enum)
UNKNOWN	סוג הפגישה לא ידוע.
VIDEO	שיחת ועידה בווידאו.
PHONE	שיחת ועידה.
MORE	משמש כדי לספק קישור למידע נוסף על הצטרפות לפגישה.
SIP	ועידה באמצעות Session Initiation Protocol

שגיאה

מייצג שגיאה שהתרחשה במהלך יצירת הכינוס. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.

שדות
type	Type סוג השגיאה. חובה.
authenticationUrl	string אם סוג השגיאה הוא AUTHENTICATION, התוסף יכול לספק כתובת URL שמאפשרת למשתמשים להתחבר. האורך המקסימלי הוא 1,300 תווים.

סוג

טיפוסים בני מנייה (enum)
UNKNOWN	שגיאה לא ידועה.
AUTHENTICATION	שגיאת אימות.
TEMPORARY	שגיאה זמנית.
PERMANENT	שגיאה קבועה.
PERMISSION_DENIED	למשתמש אין הרשאה לבצע פעולה מסוימת במערכת הווידאו של הצד השלישי.
CONFERENCE_SOLUTION_FORBIDDEN	למשתמש אין הרשאה להשתמש בפתרון לשיחות ועידה שנבחר (אבל יכול להיות שתהיה לו הרשאה להשתמש בפתרונות אחרים שמוצעים על ידי התוסף).

פרמטר

פרמטרים ספציפיים לפתרון שנשמרים עם נתוני האירוע, ואם יש צורך בעדכון או מחיקה, הם מועברים לתוסף. לדוגמה: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

שדות
key	string המפתח של הפרמטר. האורך המקסימלי הוא 50 תווים. חובה.
value	string הערך של הפרמטר. האורך המקסימלי הוא 1,024 תווים. חובה.

EditAttendeesActionMarkup

שדות
addAttendeeEmails[]	string רשימת המשתתפים שרוצים להוסיף לאירוע ביומן Google.

EditConferenceDataActionMarkup

שדות
שדה האיחוד conference. הערך של conference יכול להיות רק אחת מהאפשרויות הבאות:
conferenceData	ConferenceDataMarkup נתוני הכנס שרוצים להוסיף לאירוע ביומן Google. אפשר ליצור תוספים של צד שלישי לשיחות ועידה רק ב-Apps Script.

ChatClientDataSourceMarkup

בווידג'ט SelectionInput שמשתמש בתפריט לבחירת מספר פריטים, מקור נתונים מ-Google Chat. מקור הנתונים מאכלס את הפריטים לבחירה בתפריט הבחירה בכמה פריטים. לדוגמה, משתמש יכול לבחור מרחבים משותפים ב-Google Chat שהוא חבר בהם.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות
שדה האיחוד source. מקור הנתונים של Google Chat. הערך של source יכול להיות רק אחת מהאפשרויות הבאות:
spaceDataSource	SpaceDataSource מרחבים משותפים ב-Google Chat שהמשתמש חבר בהם.

SpaceDataSource

מקור נתונים שמאכלס מרחבים משותפים ב-Google Chat כפריטי בחירה בתפריט לבחירה מרובה. הרשימה מאוכלסת רק במרחבים משותפים שהמשתמש חבר בהם.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות
defaultToCurrentSpace	bool אם ההגדרה היא true, המרחב המשותף הנוכחי ב-Google Chat ייכלל בתפריט הבחירה בכמה פריטים כברירת מחדל.

ChatDataActionMarkup

יצירת הודעה או עדכון הודעה ב-Google Chat. מידע נוסף זמין במאמר פיתוח ממשקים של Google Chat.

גרסת Developer Preview: זמינה כחלק מתוכנית Developer Preview של Google Workspace, שמעניקה גישה מוקדמת לתכונות מסוימות.

שדות
שדה האיחוד action. פעולה ב-Google Chat. הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
createMessageAction	CreateMessageAction שליחת הודעה כאפליקציה של Google Chat.
updateMessageAction	UpdateMessageAction עדכון של הודעה באפליקציית Google Chat.
updateInlinePreviewAction	UpdateInlinePreviewAction כדי להציג תצוגה מקדימה של קישורים, מוסיפים כרטיס אחד או יותר להודעה של משתמש ב-Google Chat.

CreateMessageAction

אפליקציית Chat שולחת הודעה. מידע נוסף זמין במאמר שליחת הודעות ב-Google Chat.

גרסת Developer Preview: זמינה כחלק מתוכנית Developer Preview של Google Workspace, שמעניקה גישה מוקדמת לתכונות מסוימות.

שדות
message	Message ההודעה ב-Google Chat.

UpdateInlinePreviewAction

כדי להציג תצוגה מקדימה של קישור בהודעה באפליקציית Chat, מוסיפים או מעדכנים כרטיס אחד או יותר. פרטים נוספים זמינים במאמר תצוגה מקדימה של קישורים בהודעות ב-Google Chat.

גרסת Developer Preview: זמינה כחלק מתוכנית Developer Preview של Google Workspace, שמעניקה גישה מוקדמת לתכונות מסוימות.

שדות
cardsV2[]	CardWithId מערך של כרטיס אחד או יותר.

UpdateMessageAction

אפליקציית Chat מעדכנת את הטקסט או את הכרטיסים בהודעה. מידע נוסף זמין במאמר שליחת הודעות ב-Google Chat.

גרסת Developer Preview: זמינה כחלק מתוכנית Developer Preview של Google Workspace, שמעניקה גישה מוקדמת לתכונות מסוימות.

שדות
message	Message ההודעה המעודכנת.

DriveClientActionMarkup

שדות
requestFileScope	RequestFileScope

RequestFileScope

שדות
itemId	string

EditorClientActionMarkup

שדות
שדה האיחוד action. הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
requestFileScopeForActiveDocument	RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

אין שדות לסוג הזה.

GmailClientActionMarkup

שדות
שדה האיחוד type. הערך של type יכול להיות רק אחת מהאפשרויות הבאות:
taskAction	TaskActionMarkup
updateDraftActionMarkup	UpdateDraftActionMarkup
openCreatedDraftActionMarkup	OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup	AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

שדות
type	AddonComposeUiActionType

AddonComposeUiActionType

טיפוסים בני מנייה (enum)
UNSPECIFIED	ברירת מחדל. אם לא צוין ערך, לא ננקטת שום פעולה.
DISMISS	סגירת ממשק המשתמש ליצירת הודעות בתוסף.

OpenCreatedDraftActionMarkup

שדות
draftId	string המזהה של הטיוטה החדשה שנוצרה בפורמט 'r123'.
draftStorageId	string מזהה האחסון של השרת בפורמט הקסדצימלי, לדוגמה, 15e9fa622ce1029d.
draftThreadServerPermId	string המזהה הקבוע של השרת לשרשור של הטיוטה. השדה הזה לא מוגדר בשום מקום, והמערכת מתעלמת ממנו במהלך העיבוד של OpenCreatedDraftActionMarkup. במקום זאת, צריך לספק את הערך של draftThreadStorageId ולהשתמש בו.
draftThreadId	string המזהה של השרשור שמכיל את הטיוטה החדשה שנוצרה, לדוגמה, '15e9fa622ce1029d'.

TaskActionMarkup

שדות
reloadTasks	bool

UpdateDraftActionMarkup

שדות
updateBody	UpdateBody שדה שמכיל סדרה של פעולות עדכון שצריך לבצע בגוף טיוטת המסמך שהמשתמש עורך כרגע.
updateToRecipients	UpdateToRecipients אם ההגדרה הזו מוגדרת, היא מחליפה את הנמענים הקיימים בשדה 'אל' בטיוטה שהמשתמש עורך כרגע.
updateCcRecipients	UpdateCcRecipients אם ההגדרה הזו מוגדרת, היא מחליפה את הנמענים הקיימים ב-Cc של הטיוטה שהמשתמש עורך כרגע.
updateBccRecipients	UpdateBccRecipients אם ההגדרה הזו מוגדרת, היא מחליפה את הנמענים הקיימים בשדה 'עותק מוסתר' בטיוטה שהמשתמש עורך כרגע.
updateSubject	UpdateSubject אם ההגדרה הזו מוגדרת, היא תחליף את הנושא הקיים של הטיוטה שהמשתמש עורך כרגע.

נמען

שדות
email	string

UpdateBccRecipients

שדות
bccRecipients[]	Recipient

UpdateBody

שדות
insertContents[]	InsertContent שדה חוזר שמכיל סדרה של תוכן שרוצים להוסיף לטיוטה שהמשתמש עורך כרגע. התוכן יכול להכיל תוכן HTML או תוכן טקסט פשוט.
type	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	string התוכן שרוצים להוסיף.
mimeType (deprecated)	EmailMimeType הפריט הזה הוצא משימוש!
contentType	ContentType סוג התוכן שנוסף.

סוג

טיפוסים בני מנייה (enum)
UNSPECIFIED_ACTION_TYPE	ערך ברירת המחדל כשלא מוגדר ערך בשדה Type.
IN_PLACE_INSERT	מציין שהפעולה הזו מיועדת להוספה במקום. כברירת מחדל, התוכן מוכנס למיקום הסמן הנוכחי. אם יש תוכן שנבחר, הוא מחליף את התוכן שנבחר.
INSERT_AT_START	מציין שהפעולה הזו היא להוספה בתחילת גוף ההודעה.
INSERT_AT_END	מציין שהפעולה הזו היא להוספה בסוף גוף ההודעה.
REPLACE	מציין שהפעולה הזו מיועדת להחליף את גוף ההודעה.

UpdateCcRecipients

שדות
ccRecipients[]	Recipient

UpdateSubject

שדות
subject	string

UpdateToRecipients

שדות
toRecipients[]	Recipient

HostAppActionMarkup

פעולות שמנוהלות על ידי אפליקציות מארח ספציפיות.

שדות
שדה האיחוד action. הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
gmailAction	GmailClientActionMarkup פעולות שמטופלות על ידי Gmail.
calendarAction	CalendarClientActionMarkup פעולות שמטופלות על ידי יומן Google.
driveAction	DriveClientActionMarkup פעולות שמטופלות על ידי Drive.
editorAction	EditorClientActionMarkup פעולות שמטופלות על ידי Docs,‏ Sheets או Slides.
sheetsAction	SheetsClientActionMarkup פעולות שמטופלות על ידי Sheets.

HostAppDataActionMarkup

הגדרת האופן שבו מתבצע עדכון הנתונים ב-Google Workspace.

גרסת Developer Preview: זמינה כחלק מתוכנית Developer Preview של Google Workspace, שמעניקה גישה מוקדמת לתכונות מסוימות.

שדות
שדה האיחוד action. הפעולה של התוסף באפליקציית מארח נתונה ב-Google Workspace. הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
chatDataAction	ChatDataActionMarkup פעולה ב-Google Chat שיוצרת או מעדכנת טקסט או כרטיסים בהודעה.

HostAppDataSourceMarkup

בווידג'ט SelectionInput שמשתמש בתפריט לבחירת מספר פריטים, מקור נתונים מאפליקציה של Google Workspace. מקור הנתונים מאכלס את הפריטים לבחירה בתפריט הבחירה בכמה פריטים.

התכונה זמינה באפליקציות של Google Chat ולא זמינה בתוספים של Google Workspace.

שדות
שדה האיחוד data_source. אפליקציית Google Workspace שמאכלסת פריטים לתפריט עם אפשרות לבחירת כמה פריטים. הערך של data_source יכול להיות רק אחת מהאפשרויות הבאות:
chatDataSource	ChatClientDataSourceMarkup מקור נתונים מ-Google Chat.

SheetsClientActionMarkup

שדות
customFunctionReturnValueMarkup	CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

התוצאה של משתמש שמפעיל פונקציה בהתאמה אישית.

שדות
שדה האיחוד result. התוצאה של הפעלת הפונקציה בהתאמה אישית. הערך של result יכול להיות רק אחת מהאפשרויות הבאות:
value	Value הערך שהתקבל כתוצאה מהרצת הפונקציה בהתאמה אישית.
errorMessage	string הודעת השגיאה שמוצגת למשתמש אם משהו השתבש.