Package apps.extensions.markup

فهرست

• CalendarClientActionMarkup (پیام)
• CalendarClientActionMarkup.AddAttachmentsActionMarkup (پیام)
• CalendarClientActionMarkup.AddAttachmentsActionMarkup.AddonAttachment (پیام)
• CalendarClientActionMarkup.CalendarSubscriptionActionMarkup (پیام)
• تابع (enum) CalendarClientActionMarkup.CalendarSubscriptionActionMarkup.Operation
• CalendarClientActionMarkup.ConferenceDataMarkup (پیام)
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup (پیام)
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Feature (شمارشی)
• نوع CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Type (شمارشی)
• CalendarClientActionMarkup.ConferenceDataMarkup.Error (پیام)
• نوع خطا (شمارشی) CalendarClientActionMarkup.ConferenceDataMarkup.Error.Type
• 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
• GmailClientActionMarkup.OpenCreatedDraftActionMarkup (پیام)
• GmailClientActionMarkup.TaskActionMarkup (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup.Recipient (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBccRecipients (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.ContentType (شمارشی)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.EmailMimeType (شمارشی)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.InsertContent (پیام)
• نوع GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.Type (شمارشی)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateCcRecipients (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateSubject (پیام)
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateToRecipients (پیام)
• HostAppActionMarkup (پیام)
• HostAppDataActionMarkup (پیام)
• HostAppDataSourceMarkup (پیام)
• SheetsClientActionMarkup (پیام)
• SheetsClientActionMarkup.CustomFunctionReturnValueMarkup (پیام)

CalendarClientActionنشانه‌گذاری

فیلدها
editAttendeesActionMarkup	EditAttendeesActionMarkup عملی که شرکت‌کنندگان را به رویداد تقویم گوگل اضافه می‌کند.
editConferenceDataActionMarkup	EditConferenceDataActionMarkup عملی که داده‌های کنفرانس را به رویداد تقویم گوگل اضافه می‌کند. افزونه‌های کنفرانس شخص ثالث فقط می‌توانند در Apps Script ساخته شوند.
addAttachmentsActionMarkup	AddAttachmentsActionMarkup عملی که پیوست‌هایی را به رویداد تقویم گوگل اضافه می‌کند.
createConferenceDataActionMarkup	CreateConferenceDataActionMarkup عملی که هنگام ایجاد یک رویداد در تقویم گوگل، داده‌های کنفرانس را نشان می‌دهد.
createConferenceSettingUrlActionMarkup	CreateConferenceSettingUrlActionMarkup عملی که آدرس اینترنتی تنظیمات createconference را ایجاد می‌کند.
calendarSubscriptionActionMarkup	CalendarSubscriptionActionMarkup عملی که اشتراک تقویم را مدیریت می‌کند. فقط از ایجاد اشتراک در افزونه‌های HTTP endpoints پشتیبانی می‌کند. برای افزونه‌های Apps Script قابل اجرا نیست.

افزودن پیوست‌ها اقدام نشانه‌گذاری

فیلدها
addonAttachments[]	AddonAttachment

افزونه پیوست

فیلدها
resourceUrl	string
title	string عنوان پیوست.
mimeType	string نوع MIME محتوا در resourceUrl.
iconUrl	string به آیکون منبع لینک دهید.

تقویم، اشتراک، اقدام، نشانه‌گذاری

فیلدها
operation	Operation عملیاتی که باید انجام شود. در حال حاضر فقط CREATE پشتیبانی می‌شود.
calendarId	string شناسه تقویم برای اشتراک.

عملیات

انوم‌ها
OPERATION_UNSPECIFIED
CREATE

ConferenceDataMarkup

نشانه‌گذاری که داده‌های کنفرانس مرتبط با یک رویداد تقویم گوگل را تعریف می‌کند. افزونه‌های کنفرانس شخص ثالث فقط می‌توانند در Apps Script ساخته شوند.

فیلدها
conferenceId	string شناسه منحصر به فرد برای داده‌های این کنفرانس. حداکثر ۵۱۲ کاراکتر.
entryPoints[]	EntryPointMarkup نقاط ورود به کنفرانس. حداکثر ۳۰۰ نقطه ورود مجاز است.
parameters[]	Parameter پارامترهای اضافی اضافی. حداکثر ۳۰۰ پارامتر مجاز است.
error	Error اگر تنظیم شود، به این معنی است که هنگام ایجاد کنفرانس خطایی رخ داده است.
note	string یادداشت‌های اضافی (مانند دستورالعمل‌های مدیر، اطلاعیه‌های قانونی) برای نمایش به کاربر. می‌تواند شامل HTML باشد. حداکثر طول ۲۰۴۸ کاراکتر.
conferenceSolutionId	string شناسه‌ای برای راهکار کنفرانس. باید با مقداری از فیلد calendar.conferenceSolution.id مربوط به استقرار مطابقت داشته باشد.

ورود به سیستم

راهی برای پیوستن به کنفرانس. افزونه‌های کنفرانس شخص ثالث فقط می‌توانند در Apps Script ساخته شوند.

فیلدها
type	Type نوع نقطه ورود. الزامی.
uri	string یک آدرس اینترنتی (URI) برای پیوستن به کنفرانس. از tel: و http(s): پشتیبانی می‌کند و باید حداکثر ۱۳۰۰ کاراکتر داشته باشد. الزامی است.
label	string برچسب نقطه ورودی که به کاربر نمایش داده می‌شود. حداکثر ۵۱۲ کاراکتر.
meetingCode	string یک کد جلسه برای دسترسی به کنفرانس. حداکثر ۱۲۸ کاراکتر.
accessCode	string یک کد دسترسی برای دسترسی به کنفرانس. حداکثر ۱۲۸ کاراکتر.
passcode	string یک کد عبور برای دسترسی به کنفرانس. حداکثر ۱۲۸ کاراکتر.
password	string رمز عبور برای دسترسی به کنفرانس. حداکثر ۱۲۸ کاراکتر.
pin	string یک پین برای دسترسی به کنفرانس. حداکثر ۱۲۸ کاراکتر.
regionCode	string کد منطقه CLDR/ISO 3166 برای کشور مرتبط با این نقطه ورود. فقط برای Type.PHONE قابل اجرا است.
features[]	Feature ویژگی‌های نقطه ورود، مانند عوارض‌دار یا رایگان بودن. یک نقطه ورود می‌تواند چندین ویژگی داشته باشد.

ویژگی

ویژگی‌های نقطه ورود. برخی از ویژگی‌ها ممکن است فقط در نقاط ورود خاصی اعمال شوند.

انوم‌ها
UNKNOWN_FEATURE	ویژگی ناشناخته.
TOLL	مربوط به نقطه ورود PHONE است. تماس با یک شماره تلفن عوارضی برای طرف تماس گیرنده هزینه دارد. یک شماره نمی‌تواند همزمان هم عوارضی و هم رایگان باشد.
TOLL_FREE	مربوط به نقطه ورود PHONE است. برای طرف تماس گیرنده، تماس با شماره رایگان رایگان است. یک شماره نمی‌تواند همزمان هم رایگان و هم با هزینه باشد.

نوع

نوع نقطه ورود. افزونه‌های کنفرانس شخص ثالث فقط می‌توانند در Apps Script ساخته شوند.

انوم‌ها
UNKNOWN	نوع کنفرانس نامشخص.
VIDEO	یک کنفرانس ویدیویی.
PHONE	یک کنفرانس تلفنی.
MORE	برای ارائه پیوندی به اطلاعات بیشتر در مورد پیوستن به کنفرانس استفاده می‌شود.
SIP	کنفرانسی با استفاده از پروتکل شروع جلسه

خطا

نشان‌دهنده خطایی است که هنگام ایجاد کنفرانس رخ داده است. افزونه‌های کنفرانس شخص ثالث فقط می‌توانند در Apps Script ساخته شوند.

فیلدها
type	Type نوع خطا. الزامی.
authenticationUrl	string اگر نوع خطا AUTHENTICATION باشد، افزونه می‌تواند یک URL ارائه دهد که به کاربران اجازه ورود می‌دهد. حداکثر ۱۳۰۰ کاراکتر.

نوع

انوم‌ها
UNKNOWN	خطای ناشناخته.
AUTHENTICATION	خطای احراز هویت.
TEMPORARY	یک خطای موقت.
PERMANENT	یک خطای دائمی.
PERMISSION_DENIED	کاربر مجاز به انجام برخی اقدامات در سیستم کنفرانس شخص ثالث نیست.
CONFERENCE_SOLUTION_FORBIDDEN	کاربر مجاز به استفاده از راهکار کنفرانس انتخاب‌شده نیست (اما ممکن است مجاز به استفاده از سایر راهکارهای ارائه‌شده توسط افزونه باشد).

پارامتر

پارامترهای مختص راهکار که در داده‌های رویداد ذخیره می‌شوند و در صورت نیاز به به‌روزرسانی یا حذف، به افزونه منتقل می‌شوند. برای مثال: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

فیلدها
key	string کلید پارامتر. حداکثر ۵۰ کاراکتر. الزامی.
value	string مقدار پارامتر. حداکثر ۱۰۲۴ کاراکتر. الزامی.

CreateConferenceDataActionMarkup

فیلدها
createConferenceData	ConferenceDataMarkup داده‌های کنفرانسی که هنگام ایجاد رویداد تقویم گوگل به آن اضافه می‌شود.

ایجادکنفرانستنظیماتآدرسآکشنمارک‌آپ

فیلدها
settingsUrl	string آدرس اینترنتی (url) صفحه تنظیمات تولید شده توسط افزونه.

ویرایششرکت‌کنندگاناکشنمارک‌آپ

فیلدها
addAttendeeEmails[]	string فهرستی از شرکت‌کنندگان برای اضافه کردن به رویداد تقویم گوگل.

ویرایشConferenceDataActionMarkup

فیلدها
conference میدانی اتحادیه conference فقط می‌تواند یکی از موارد زیر باشد:
conferenceData	ConferenceDataMarkup داده‌های کنفرانس برای افزودن به رویداد تقویم گوگل. افزونه‌های کنفرانس شخص ثالث فقط می‌توانند در Apps Script ساخته شوند.

ChatClientDataSourceMarkup

برای یک ویجت SelectionInput که از یک منوی چند انتخابی استفاده می‌کند، یک منبع داده از Google Chat. منبع داده، آیتم‌های انتخابی را برای منوی چند انتخابی پر می‌کند. برای مثال، یک کاربر می‌تواند فضاهای Google Chat را که عضو آن است، انتخاب کند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
source فیلد Union. منبع داده Google Chat. source می‌تواند فقط یکی از موارد زیر باشد:
spaceDataSource	SpaceDataSource فضاهای چت گوگل که کاربر عضو آن است.

منبع داده فضایی

منبع داده‌ای که فضاهای Google Chat را به عنوان آیتم‌های انتخابی برای یک منوی چندگزینه‌ای پر می‌کند. فقط فضاهایی را که کاربر عضو آنهاست، پر می‌کند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
defaultToCurrentSpace	bool اگر روی true تنظیم شود، منوی چندگزینه‌ای به‌طور پیش‌فرض فضای فعلی چت گوگل را به‌عنوان یک آیتم انتخاب می‌کند.

ChatDataActionMarkup

پیامی را در Google Chat ایجاد یا به‌روزرسانی می‌کند. برای جزئیات بیشتر، به ساخت رابط‌های Google Chat مراجعه کنید.

فیلدها
action میدانی اتحادیه. یک اقدام گوگل چت . action می‌تواند فقط یکی از موارد زیر باشد:
createMessageAction	CreateMessageAction به عنوان یک برنامه چت گوگل، پیام ارسال می‌کند.
updateMessageAction	UpdateMessageAction پیام برنامه چت گوگل را به‌روزرسانی می‌کند.
updateInlinePreviewAction	UpdateInlinePreviewAction برای پیش‌نمایش پیوندها ، یک یا چند کارت به پیام کاربر Google Chat اضافه می‌کند.

ایجاد پیام اقدام

برنامه چت یک پیام ارسال می‌کند. برای جزئیات بیشتر، به ارسال پیام‌های گوگل چت مراجعه کنید.

فیلدها
message	Message پیام گوگل چت.

پیش‌نمایش درون‌خطی به‌روزرسانی

برنامه چت با اضافه کردن یا به‌روزرسانی یک یا چند کارت، پیش‌نمایشی از لینک موجود در پیام را نمایش می‌دهد. برای جزئیات بیشتر، به پیش‌نمایش لینک‌ها در پیام‌های چت گوگل مراجعه کنید.

فیلدها
cardsV2[]	CardWithId مجموعه‌ای از یک یا چند کارت.

به‌روزرسانی پیام‌رسان

برنامه چت، متن یا کارت‌های موجود در یک پیام را به‌روزرسانی می‌کند. برای جزئیات بیشتر، به ارسال پیام‌های Google Chat مراجعه کنید.

فیلدها
message	Message پیام به‌روزرسانی‌شده.

DriveClientActionMarkup

فیلدها
requestFileScope	RequestFileScope

درخواست دامنه فایل

فیلدها
itemId	string

ویرایشگرکاربرعملکردنشانه‌گذاری

فیلدها
action میدانی اتحادیه. action می‌تواند فقط یکی از موارد زیر باشد:
requestFileScopeForActiveDocument	RequestFileScopeForActiveDocument

درخواست دامنه فایل برای سند فعال

این نوع هیچ فیلدی ندارد.

GmailClientActionMarkup

فیلدها
type فیلد اتحادیه. type فقط می‌تواند یکی از موارد زیر باشد:
taskAction	TaskActionMarkup
updateDraftActionMarkup	UpdateDraftActionMarkup
openCreatedDraftActionMarkup	OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup	AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

فیلدها
type	AddonComposeUiActionType

AddonComposeUiActionType

انوم‌ها
UNSPECIFIED	پیش‌فرض. وقتی مشخص نشود، هیچ اقدامی انجام نمی‌شود.
DISMISS	رابط کاربری نوشتن افزونه را غیرفعال می‌کند.

OpenCreatedDraftActionMarkup

فیلدها
draftId	string شناسه پیش‌نویس تازه ایجاد شده به شکل "r123".
draftStorageId	string شناسه ذخیره‌سازی سرور در قالب هگز، برای مثال، "15e9fa622ce1029d".
draftThreadServerPermId	string شناسه دائمی سرور برای رشته‌ی پیش‌نویس. این فیلد در هیچ جایی تنظیم نشده است و هنگام پردازش OpenCreatedDraftActionMarkup نادیده گرفته می‌شود. به جای آن، draftThreadStorageId را وارد و استفاده کنید.
draftThreadId	string شناسه‌ی رشته‌ای که پیش‌نویس تازه ایجاد شده در آن قرار دارد، برای مثال، "15e9fa622ce1029d".

نشانه‌گذاری وظیفه

فیلدها
reloadTasks	bool

به‌روزرسانیپیش‌نویسعملمارک‌آپ

فیلدها
updateBody	UpdateBody فیلدی که شامل مجموعه‌ای از اقدامات به‌روزرسانی برای انجام روی متن پیش‌نویسی است که کاربر در حال ویرایش آن است.
updateToRecipients	UpdateToRecipients در صورت تنظیم، جایگزین گیرنده‌های موجود برای پیش‌نویسی می‌شود که کاربر در حال ویرایش آن است.
updateCcRecipients	UpdateCcRecipients در صورت تنظیم، جایگزین گیرندگان رونوشت موجود از پیش‌نویسی می‌شود که کاربر در حال ویرایش آن است.
updateBccRecipients	UpdateBccRecipients در صورت تنظیم، گیرنده‌های Bcc موجود در پیش‌نویسی که کاربر در حال ویرایش آن است را جایگزین می‌کند.
updateSubject	UpdateSubject در صورت تنظیم، جایگزین موضوع موجود پیش‌نویسی می‌شود که کاربر در حال حاضر در حال ویرایش آن است.

گیرنده

فیلدها
email	string

به‌روزرسانیBccگیرندگان

فیلدها
bccRecipients[]	Recipient

به‌روزرسانی بدنه

فیلدها
insertContents[]	InsertContent یک فیلد تکراری که شامل مجموعه‌ای از محتوا برای درج در پیش‌نویسی است که کاربر در حال ویرایش آن است. این محتوا می‌تواند شامل محتوای HTML یا متن ساده باشد.
type	Type

نوع محتوا

انوم‌ها
UNSPECIFIED_CONTENT_TYPE	مقدار پیش‌فرض زمانی که چیزی برای ContentType تنظیم نشده باشد.
TEXT	مشخص می‌کند که محتوا به صورت متن ساده است.
MUTABLE_HTML	مشخص می‌کند که محتوا به صورت HTML است و قابل تغییر (قابل ویرایش) می‌باشد.
IMMUTABLE_HTML	مشخص می‌کند که محتوا به صورت HTML است و تغییرناپذیر (غیرقابل ویرایش) است.

نوع مایم ایمیل

EmailMimeType منسوخ شده است. لطفاً از ContentType استفاده کنید.

انوم‌ها
UNSPECIFIED_EMAIL_MIME_TYPE	مقدار پیش‌فرض زمانی که چیزی برای EmailMimeType تنظیم نشده باشد.
PLAIN_TEXT	مشخص می‌کند که محتوای وارد شده به صورت متن ساده است.
HTML	مشخص می‌کند که محتوای درج شده به صورت HTML است.

درج محتوا

فیلدها
content	string محتوایی که قرار است درج شود.
mimeType (deprecated)	EmailMimeType این کالا منسوخ شده است!
contentType	ContentType نوع محتوای درج شده.

نوع

انوم‌ها
UNSPECIFIED_ACTION_TYPE	مقدار پیش‌فرض زمانی که چیزی برای Type تنظیم نشده باشد.
IN_PLACE_INSERT	نشان می‌دهد که این عمل برای انجام یک درج درجا است. به طور پیش‌فرض محتوا در موقعیت فعلی مکان‌نما درج می‌شود، اگر محتوای انتخاب شده‌ای وجود داشته باشد، جایگزین محتوای انتخاب شده می‌شود.
INSERT_AT_START	نشان می‌دهد که این عمل، درج را در ابتدای بدنه پیام انجام می‌دهد.
INSERT_AT_END	نشان می‌دهد که این عمل، درج در انتهای بدنه پیام را انجام می‌دهد.
REPLACE	نشان می‌دهد که این اقدام، جایگزین کردن متن پیام است.

به‌روزرسانی دریافت‌کنندگان

فیلدها
ccRecipients[]	Recipient

موضوع به‌روزرسانی

فیلدها
subject	string

به‌روزرسانی برای گیرندگان

فیلدها
toRecipients[]	Recipient

HostAppActionMarkup

اقداماتی که توسط برنامه‌های میزبان منفرد انجام می‌شوند.

فیلدها
action میدانی اتحادیه. action می‌تواند فقط یکی از موارد زیر باشد:
gmailAction	GmailClientActionMarkup اقداماتی که توسط Gmail انجام می‌شوند.
calendarAction	CalendarClientActionMarkup اقداماتی که توسط تقویم انجام می‌شوند.
driveAction	DriveClientActionMarkup اقداماتی که توسط Drive انجام می‌شوند.
editorAction	EditorClientActionMarkup اقداماتی که توسط سندنگار، برگه‌نگار یا اسلایدنگار انجام می‌شوند.
sheetsAction	SheetsClientActionMarkup اقداماتی که توسط Sheets انجام می‌شوند.

HostAppDataActionMarkup

نحوه به‌روزرسانی داده‌های Google Workspace را تعریف می‌کند.

فیلدها
action میدانی اتحادیه. اقدام افزونه برای یک برنامه میزبان Google Workspace مشخص. action می‌تواند فقط یکی از موارد زیر باشد:
chatDataAction	ChatDataActionMarkup یک عملکرد گوگل چت که متن یا کارت‌ها را در یک پیام ایجاد یا به‌روزرسانی می‌کند.

نشانه‌گذاری HostAppDataSource

یک منبع داده از برنامه Google Workspace. این منبع داده، آیتم‌های موجود برای یک ویجت را پر می‌کند.

فیلدها
فیلد Union data_source . برنامه Google Workspace که موارد موجود برای یک ویجت را پر می‌کند. data_source فقط می‌تواند یکی از موارد زیر باشد:
chatDataSource	ChatClientDataSourceMarkup منبع داده از گوگل چت.

SheetsClientActionMarkup

شناسه بعدی: ۵.

فیلدها
action میدانی اتحادیه. action می‌تواند فقط یکی از موارد زیر باشد:
customFunctionReturnValueMarkup	CustomFunctionReturnValueMarkup

تابع سفارشیReturnValueMarkup

نتیجه اجرای یک تابع سفارشی توسط کاربر.

فیلدها
result فیلد Union. نتیجه اجرای تابع سفارشی. result فقط می‌تواند یکی از موارد زیر باشد:
value	Value مقداری که از اجرای تابع سفارشی حاصل شده است.
errorMessage	string پیام خطایی که در صورت بروز مشکل به کاربر نشان داده می‌شود.