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 (הודעה)
• ChatClientActionMarkup (הודעה)
• ChatClientDataSourceMarkup (הודעה)
• ChatClientDataSourceMarkup.SpaceDataSource (הודעה)
• 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 (הודעה)
• 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.

ChatClientActionMarkup

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

פעולות שמטופלות על ידי לקוחות Chat.

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 ייבחר כברירת מחדל.

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	ערך ברירת המחדל כשלא מוגדר שום סוג עבור 'סוג'.
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.
chatAction	ChatClientActionMarkup פעולות שמטופלות ב-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 הודעת השגיאה שתוצג למשתמש אם משהו השתבש.