Package apps.extensions.markup

אינדקס

CalendarClientActionMarkup

שדות
editAttendeesActionMarkup

EditAttendeesActionMarkup

פעולה שמוסיפה משתתפים לאירוע ביומן Google.

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

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

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

פעולה שמוסיפה קבצים מצורפים לאירוע ביומן Google.

createConferenceDataActionMarkup

CreateConferenceDataActionMarkup

פעולה שמציגה את פרטי הוועידה כשיוצרים אירוע ביומן Google.

createConferenceSettingUrlActionMarkup

CreateConferenceSettingUrlActionMarkup

פעולה שיוצרת כתובת URL להגדרת יצירת ועידה.

calendarSubscriptionActionMarkup

CalendarSubscriptionActionMarkup

פעולה שמנהלת מינוי ליומן. תומך ביצירת מינויים רק בתוספים של נקודות קצה (endpoint) של HTTP. לא רלוונטי לתוספים של Apps Script.

AddAttachmentsActionMarkup

שדות
addonAttachments[]

AddonAttachment

AddonAttachment

שדות
resourceUrl

string

title

string

שם הקובץ המצורף.

mimeType

string

סוג ה-MIME של התוכן ב-resourceUrl.

iconUrl

string

קישור לסמל המשאב.

CalendarSubscriptionActionMarkup

שדות
operation

Operation

הפעולה לביצוע. בשלב הזה יש תמיכה רק בפעולה CREATE.

calendarId

string

מזהה היומן שאליו רוצים להירשם.

פעולה

טיפוסים בני מנייה (enum)
OPERATION_UNSPECIFIED
CREATE

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 תווים. חובה.

CreateConferenceDataActionMarkup

שדות
createConferenceData

ConferenceDataMarkup

נתוני שיחת הוועידה שצריך להוסיף לאירוע ביומן Google כשיוצרים אותו.

CreateConferenceSettingUrlActionMarkup

שדות
settingsUrl

string

ה-URI של דף ההגדרות שנוצר על ידי התוסף.

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, בתפריט הבחירה מרובת האפשרויות נבחר כברירת מחדל המרחב הנוכחי ב-Chat כפריט.

ChatDataActionMarkup

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

שדות
שדה איחוד action. פעולה ב-Google Chat. הערך action יכול להיות רק אחד מהבאים:
createMessageAction

CreateMessageAction

שליחת הודעה כאפליקציית צ'אט ב-Google Chat.

updateMessageAction

UpdateMessageAction

עדכון הודעה של אפליקציית Google Chat.

updateInlinePreviewAction

UpdateInlinePreviewAction

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

CreateMessageAction

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

שדות
message

Message

ההודעה ב-Google Chat.

UpdateInlinePreviewAction

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

שדות
cardsV2[]

CardWithId

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

UpdateMessageAction

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

שדות
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

אם ההגדרה הזו מוגדרת, היא מחליפה את הנמענים הקיימים להעתק של הטיוטה שהמשתמש עורך כרגע.

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

פעולות שמבוצעות ביומן.

driveAction

DriveClientActionMarkup

פעולות שמטופלות על ידי Drive.

editorAction

EditorClientActionMarkup

פעולות שמבוצעות ב-Docs, ב-Sheets או ב-Slides.

sheetsAction

SheetsClientActionMarkup

פעולות שמטופלות על ידי Sheets.

HostAppDataActionMarkup

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

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

ChatDataActionMarkup

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

HostAppDataSourceMarkup

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

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

ChatClientDataSourceMarkup

מקור נתונים מ-Google Chat.

SheetsClientActionMarkup

המזהה הבא: 5.

שדות

שדה איחוד action.

הערך action יכול להיות רק אחד מהבאים:

customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

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

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

Value

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

errorMessage

string

הודעת השגיאה שתוצג למשתמש אם משהו השתבש.