Package apps.extensions.markup

אינדקס

CalendarClientActionMarkup

שדות
editAttendeesActionMarkup

EditAttendeesActionMarkup

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

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

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

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

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

AddAttachmentsActionMarkup

שדות
addonAttachments[]

AddonAttachment

AddonAttachment

שדות
resourceUrl

string

title

string

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

mimeType

string

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

iconUrl

string

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

ConferenceDataMarkup

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

שדות
conferenceId

string

המזהה הייחודי של הנתונים של שיחת הוועידה. באורך של 512 תווים לכל היותר.

entryPoints[]

EntryPointMarkup

נקודות הכניסה לכנס. אפשר להוסיף עד 300 נקודות כניסה.

parameters[]

Parameter

פרמטרים נוספים של תוספים. אפשר להוסיף עד 300 פרמטרים.

error

Error

אם היא מוגדרת, המשמעות היא שאירעה שגיאה במהלך יצירת שיחת הוועידה.

note

string

הערות נוספות (כגון הוראות מהאדמין, הודעות משפטיות) שצריך להציג למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2,048 תווים.

conferenceSolutionId

string

המזהה של פתרון שיחות הוועידה. חייב להתאים לערך מהשדה calendar.conferenceSolution.id של הפריסה.

EntryPointMarkup

דרך להצטרף לשיחת הוועידה.

שדות
type

Type

הסוג של נקודת הכניסה. חובה.

uri

string

URI להצטרפות לשיחת הוועידה. תומך בטלפון: וב-http(s): וצריך להיות באורך של 1300 תווים לכל היותר. חובה.

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

תכונות של נקודת הכניסה, כמו שיחת חינם או שיחת חינם. לנקודת כניסה אחת יכולות להיות כמה תכונות.

התכונה

תכונות של נקודת הכניסה. יכול להיות שחלק מהתכונות יהיו רלוונטיות רק לנקודות כניסה מסוימות.

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

סוג

הסוג של נקודת הכניסה.

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

שגיאה

מייצג שגיאה שאירעה במהלך יצירת שיחת הוועידה.

שדות
type

Type

סוג השגיאה. חובה.

authenticationUrl

string

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

סוג

טיפוסים בני מנייה (enums)
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.

ChatClientActionMarkup

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

פעולות שטופלו על ידי לקוחות צ'אט.

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

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

OpenCreatedDraftActionMarkup

שדות
draftId

string

המזהה של הטיוטה החדשה שנוצרה בטופס "r123".

draftStorageId

string

מזהה האחסון של השרת בפורמט הקסדצימלי, לדוגמה,'15e9fa622ce1029d'.

draftThreadServerPermId

string

המזהה הקבוע של השרת של שרשור הטיוטה. השדה הזה לא מוגדר בשום מקום, והמערכת מתעלמת ממנו במהלך העיבוד של OpenCreated draftActionMarkup. צריך לספק את הנתונים ולהשתמש ב-draftStorageId במקום זאת.

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

טיפוסים בני מנייה (enums)
UNSPECIFIED_CONTENT_TYPE ערך ברירת המחדל כשלא מוגדר שום דבר עבור ContentType.
TEXT מציין שהתוכן כתוב בטקסט פשוט.
MUTABLE_HTML מציינת שהתוכן ב-HTML וניתן לשינוי (ניתן לעריכה).
IMMUTABLE_HTML מציינת שהתוכן הוא ב-HTML ואי אפשר לשנות אותו (לא ניתן לערוך אותו).

EmailMimeType

השימוש ב-EmailMimeType הוצא משימוש. יש להשתמש ב-ContentType.

טיפוסים בני מנייה (enums)
UNSPECIFIED_EMAIL_MIME_TYPE ערך ברירת המחדל כשלא מוגדר שום דבר עבור EmailMimeType.
PLAIN_TEXT מציינת שהתוכן שנוסף הוא בטקסט פשוט.
HTML המדיניות הזו מציינת שהתוכן המוכנס הוא ב-HTML.

InsertContent

שדות
content

string

התוכן להוספה.

mimeType
(deprecated)

EmailMimeType

contentType

ContentType

סוג התוכן שנוסף.

סוג

טיפוסים בני מנייה (enums)
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

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