AddOns Response Service

سرویس پاسخ افزودنی‌ها

این سرویس به اسکریپت‌ها اجازه می‌دهد افزونه‌های Google Workspace را پیکربندی و بسازند که Google Workspace Studio را گسترش می‌دهند.

کلاس‌ها

نام شرح مختصر
Action عملی که افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، می‌توانند برای رندر کردن یک کارت جدید از آن استفاده کنند.
Add Ons Response Service Add Ons Response Service امکان ایجاد پاسخ برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، فراهم می‌کند.
Basic Data Type یک enum که انواع داده‌های عمومی پایه را نشان می‌دهد.
Color یک شیء رنگ که نمایانگر یک رنگ در فضای رنگ RGBA است.
Data Type برای تعیین نوع یک متغیر از DataType استفاده می‌شود.
Dynamic Resource Definition یک DynamicResourceDefinition یک بلوک سازنده برای یک Resource Fields Definition Retrieved Action است که می‌تواند شامل یک یا چند عدد Resource Field باشد تا به صورت پویا تعداد متغیرهای خروجی ارائه شده توسط یک مرحله در Google Workspace Studio را تعریف کند.
Error Actionability یک Enum که نشان‌دهنده‌ی قابلیت اقدام در برابر خطا است.
Error Retryability یک Enum که نشان‌دهنده‌ی قابلیت تلاش مجدد فراخوانی یک عمل در صورت بروز خطا است.
Font Weight یک enum که وزن فونت متن استایل‌بندی شده را نشان می‌دهد.
Host App Action HostAppAction نوعی اکشن است که توسط برنامه‌های میزبان به صورت جداگانه مدیریت می‌شود.
Hyperlink یک عنصر هایپرلینک که در Text Format Element استفاده می‌شود.
Insert Section یک سازنده برای اشیاء InsertSection.
Insert Widget یک سازنده برای اشیاء InsertWidget.
Link شیء لینک از یک منبع شخص ثالث که آن را به یک تراشه هوشمند در برنامه میزبان تبدیل می‌کند.
List Container ظرفی برای آیتم‌های لیست، که در آن هر آیتم لیست می‌تواند شامل چندین Text Format Element باشد.
List Item یک آیتم لیست، که در آن هر آیتم لیست می‌تواند شامل چندین Text Format Element باشد.
List Type یک enum که نوع لیست را نشان می‌دهد.
Modify Card یک سازنده برای اشیاء Modify Card که رابط کارت موجود را با ارسال شیء Modify Card به یک Action تغییر داده و به‌روزرسانی می‌کند.
Navigation یک شیء کمکی که پیمایش کارت را کنترل می‌کند.
Remove Section یک سازنده برای Remove Section .
Remove Widget یک سازنده برای اشیاء RemoveWidget.
Render Action با انجام یک Action در پاسخ به تعامل کاربر، یک کارت را رندر یا به‌روزرسانی می‌کند.
Render Action Builder یک سازنده برای اشیاء Render Action .
Resource Data نشان دهنده یک داده منبع خاص برنامه است، یک داده منبع شامل مجموعه‌ای از جفت‌های کلید-مقدار از نام متغیرها و Variable Data است.
Resource Field یک ResourceField یک بلوک سازنده اساسی از Dynamic Resource Definition است، هر فیلد منبع مربوط به یک متغیر خروجی از مرحله فعلی است.
Resource Fields Definition Retrieved Action یک Resource Fields Definition Retrieved Action نوعی از Resource Fields Definition Retrieved Action است که برای بازیابی تعریف لیستی از فیلدهای منبع از طریق تابع dynamic Resource Definition Provider مشخص‌شده در مانیفست استفاده می‌شود.
Resource Retrieved Action یک ResourceRetrievedAction برای بازیابی محتوای منبع سفارشی در صورت نیاز استفاده می‌شود، که در آن فیلد منبع سفارشی در ResourceData تعریف شده است.
Resource Type یک نوع منبع خاص برنامه، شناسه منحصر به فرد نوع منبع باید دارای یک WorkflowResourceDefinition مربوطه باشد.
Return Element Error Action یک ReturnElementErrorAction نشان می‌دهد که هنگام فراخوانی عنصر، خطایی رخ داده است.
Return Output Variables Action شامل متغیرهای خروجی تولید شده توسط عمل اجرا شده در Google Workspace Studio است.
Save Workflow Action این اقدام نشان می‌دهد که برنامه میزبان (Google Workspace Studio) باید عامل را ذخیره کند.
Styled Text عنصر متن با سبک‌هایی مانند پررنگ، کج و رنگی.
Text Format Chip یک تراشه قابل کلیک در قالب متن.
Text Format Element یک عنصر قالب‌بندی متن، که می‌تواند یک Text Format Chip ، Styled Text ، Hyperlink یا List Container باشد.
Text Format Icon نمادی که در Text Format Chip نمایش داده می‌شود.
Text Style یک enum که نشان دهنده سبک متن استایل داده شده است.
Time Stamp یک شیء timestamp را نشان می‌دهد که می‌تواند به یک Variable Data اضافه شود.
Update Widget یک سازنده برای اشیاء Update Widget .
Validation Error Severity یک enum که شدت خطای اعتبارسنجی را نشان می‌دهد.
Value Metadata یک valueMetadata حاوی اطلاعاتی در مورد مقادیر بالقوه یک متغیر است.
Variable Data نشان دهنده یک متغیر داده است که می‌تواند شامل مجموعه‌ای از مقادیر در انواع مختلف باشد.
Workflow Action WorkflowAction نوعی از Host App Action است که برای انجام یک عمل خاص در Google Workspace Studio استفاده می‌شود.
Workflow Text Format بلوکی از متن با گزینه‌های قالب‌بندی غنی شامل سبک‌ها، هایپرلینک‌ها و عناصر تعاملی که در Text Format Element تعریف شده‌اند.
Workflow Validation Error Action این اقدام نشان می‌دهد که برنامه میزبان (Google Workspace Studio) باید یک خطای اعتبارسنجی نمایش دهد.

Action

روش‌ها

روش نوع بازگشتی شرح مختصر
add Modify Card(modifyCard) Action یک عملیات ModifyCard به اکشن اضافه می‌کند.
add Navigation(navigation) Action یک ناوبری کارتی به اکشن اضافه می‌کند.

Add Ons Response Service

روش‌ها

روش نوع بازگشتی شرح مختصر
new Action() Action یک Action جدید ایجاد می‌کند.
new Navigation() Navigation یک Navigation جدید ایجاد می‌کند.
new Render Action Builder() Render Action Builder یک Render Action Builder جدید ایجاد می‌کند.

Basic Data Type

خواص

ملک نوع توضیحات
BASIC_TYPE_UNSPECIFIED Enum مقدار پیش‌فرض.
STRING Enum رشته‌ای از کاراکترها.
INTEGER Enum یک مقدار عدد صحیح.
FLOAT Enum یک عدد ممیز شناور.
TIMESTAMP Enum یک مهر زمانی با فرمت ISO 8601.
BOOLEAN Enum یک مقدار بولی.
EMAIL_ADDRESS Enum رشته‌ای در قالب آدرس ایمیل.
GOOGLE_USER Enum کاربر سرویس‌های گوگل، با فرمت «users/encoded_GAIA_ID»
FILE Enum یک نوع فایل.
FORMATTED_TEXT Enum متنی با قالب‌بندی غنی.

Color

روش‌ها

روش نوع بازگشتی شرح مختصر
set Alpha(alpha) Color مولفه آلفای رنگ را تنظیم می‌کند.
set Blue(blue) Color مولفه آبی رنگ را تنظیم می‌کند.
set Green(green) Color مولفه سبز رنگ را تنظیم می‌کند.
set Red(red) Color مولفه قرمز رنگ را تنظیم می‌کند.

Data Type

روش‌ها

روش نوع بازگشتی شرح مختصر
set Basic Data Type(basicDataType) Data Type نوع داده را روی یکی از Basic Data Type پشتیبانی شده تنظیم می‌کند.
set Resource Type(resourceType) Data Type نوع داده را روی یک Resource Type سفارشی تعریف شده تنظیم می‌کند.
set Value Metadata(valueMetadata) Data Type Value Metadata تنظیم می‌کند که شامل اطلاعات مربوط به نوع متغیر است.

Dynamic Resource Definition

روش‌ها

روش نوع بازگشتی شرح مختصر
add Resource Field(resourceField) Dynamic Resource Definition یک فیلد منبع به تعریف منبع پویا اضافه می‌کند.
set Resource Id(resourceId) Dynamic Resource Definition شناسه (ID) تعریف منبع پویا را تنظیم می‌کند، این شناسه با workflow Resource Definition Id در مانیفست مطابقت دارد.

Error Actionability

خواص

ملک نوع توضیحات
ERROR_ACTIONABILITY_UNSPECIFIED Enum نامشخص.
NOT_ACTIONABLE Enum این خطا توسط کاربر از طریق کارت پیکربندی قابل رفع نیست.
ACTIONABLE Enum این خطا توسط کاربر از طریق کارت پیکربندی قابل رفع است.

Error Retryability

خواص

ملک نوع توضیحات
RETRYABILITY_UNSPECIFIED Enum نامشخص.
NOT_RETRYABLE Enum خطا قابل تکرار نیست، جریان پس از اولین تلاش خاتمه می‌یابد.
RETRYABLE Enum خطا قابل تکرار است، Workflow سعی خواهد کرد تا ۵ بار مرحله را اجرا کند.

Font Weight

خواص

ملک نوع توضیحات
FONT_WEIGHT_UNSPECIFIED Enum وزن استاندارد با ضخامت معمولی.
LIGHT Enum وزن سبک‌تر با ضخامت کمتر.
MEDIUM Enum وزن متوسطی بین روشن و پررنگ.
BOLD Enum وزن سنگین‌تر با ضخامت بیشتر.

Host App Action

روش‌ها

روش نوع بازگشتی شرح مختصر
set Workflow Action(workflowAction) Host App Action عملکرد برنامه میزبان را روی عملکرد گردش کار تنظیم می‌کند.

روش‌ها

روش نوع بازگشتی شرح مختصر
set Link(link) Hyperlink آدرس اینترنتی (URL) مقصد لینک را تنظیم می‌کند.
set Text(text) Hyperlink متن هایپرلینک را تنظیم می‌کند.

Insert Section

روش‌ها

روش نوع بازگشتی شرح مختصر
insert At Top(onCardTop) Insert Section پرچم onCardTop را تنظیم می‌کند، که نشان می‌دهد آیا بخش جدید باید در بالای کارت درج شود یا خیر.
insert Below Section(sectionId) Insert Section شناسه بخش را تنظیم می‌کند و بخش جدید در زیر آن درج می‌شود.
set Section(section) Insert Section بخش کارتی که باید درج شود را تنظیم می‌کند.

Insert Widget

روش‌ها

روش نوع بازگشتی شرح مختصر
insert Above Widget(widgetId) Insert Widget شناسه ویجت را تنظیم می‌کند و ویجت جدید بالای ویجتی که شناسه داده شده را دارد، درج می‌شود.
insert Below Widget(widgetId) Insert Widget شناسه ویجت را تنظیم می‌کند و ویجت جدید در زیر ویجت با شناسه داده شده درج می‌شود.
set Widget(widget) Insert Widget Widget که قرار است درج شود را تنظیم می‌کند.

روش‌ها

روش نوع بازگشتی شرح مختصر
set Title(title) Link عنوان لینک را تنظیم می‌کند.
set Url(url) Link آدرس اینترنتی (URL) لینک را تنظیم می‌کند.

List Container

روش‌ها

روش نوع بازگشتی شرح مختصر
add List Item(listItem) List Container یک آیتم لیست را به کانتینر لیست اضافه می‌کند.
set List Nest Level(listLevel) List Container سطح لیست را تنظیم می‌کند، از ۰ برای سطح بالا شروع می‌شود و برای هر لیست تو در تو، ۱ واحد افزایش می‌یابد.
set List Type(listType) List Container نوع لیست را به صورت مرتب یا نامرتب تنظیم می‌کند.

List Item

روش‌ها

روش نوع بازگشتی شرح مختصر
add Text Format Element(textFormatElement) List Item یک Text Format Element به آیتم لیست اضافه می‌کند.

List Type

خواص

ملک نوع توضیحات
LIST_TYPE_UNSPECIFIED Enum مقدار پیش‌فرض.
ORDERED Enum لیست مرتب شده.
UNORDERED Enum لیست نامرتب.

Modify Card

روش‌ها

روش نوع بازگشتی شرح مختصر
set Insert Section(insertSection) Modify Card Insert Section برای این شیء کارت اصلاح تنظیم می‌کند.
set Insert Widget(insertWidget) Modify Card Insert Widget برای این شیء کارت تغییر تنظیم می‌کند.
set Remove Section(removeSection) Modify Card Remove Section برای این شیء کارت اصلاح تنظیم می‌کند.
set Remove Widget(removeWidget) Modify Card Remove Widget برای این شیء کارت تغییر تنظیم می‌کند.
set Replace Section(replacementSection) Modify Card Card Section جایگزین را برای این شیء کارت اصلاح‌شده تنظیم می‌کند، بخش جایگزین باید شناسه (id) مشابه بخش کارت موجود داشته باشد.
set Replace Widget(replacementWidget) Modify Card ویجت جایگزین را برای این شیء کارت تغییر تنظیم می‌کند، ویجت جایگزین باید شناسه (id) مشابه ویجت موجود داشته باشد.
set Update Widget(updateWidget) Modify Card Update Widget برای این شیء کارت تغییر تنظیم می‌کند.

روش‌ها

روش نوع بازگشتی شرح مختصر
print Json() String نمایش JSON این شیء را چاپ می‌کند.
push Card(card) Navigation کارت داده شده را روی دسته کارت‌ها فشار می‌دهد.

Remove Section

روش‌ها

روش نوع بازگشتی شرح مختصر
set Section Id(sectionId) Remove Section شناسه بخش مورد نظر برای حذف را تنظیم می‌کند.

Remove Widget

روش‌ها

روش نوع بازگشتی شرح مختصر
set Widget Id(widgetId) Remove Widget شناسه ویجتی که قرار است حذف شود را تنظیم می‌کند.

Render Action

روش‌ها

روش نوع بازگشتی شرح مختصر
print Json() String نمایش JSON این شیء را چاپ می‌کند.

Render Action Builder

روش‌ها

روش نوع بازگشتی شرح مختصر
build() Render Action عمل رندر فعلی را می‌سازد و آن را اعتبارسنجی می‌کند.
set Action(action) Render Action Builder عملی را که افزونه‌ها می‌توانند برای به‌روزرسانی رابط کاربری به عمل رندر استفاده کنند، تنظیم می‌کند.
set Host App Action(hostAppAction) Render Action Builder Host App Action که توسط برنامه‌های میزبان به صورت جداگانه مدیریت می‌شود را برای رندر کردن تنظیم می‌کند.

Resource Data

روش‌ها

روش نوع بازگشتی شرح مختصر
add Variable Data(key, value) Resource Data یک Variable Data با نام متغیر اضافه می‌کند که با نام آن کلیدگذاری شده است، اگر کلید از قبل وجود داشته باشد، مقدار بازنویسی می‌شود.
set Variable Data Map(fields) Resource Data نقشه داده‌های متغیر که با نام متغیرها کلیدگذاری شده‌اند را تنظیم می‌کند.

Resource Field

روش‌ها

روش نوع بازگشتی شرح مختصر
set Data Type(dataType) Resource Field نوع داده‌ی فیلد را تنظیم می‌کند، و به مراحل دیگر اجازه می‌دهد متغیرها را بر اساس نوع در زمان انتخاب فیلتر کنند.
set Display Text(displayText) Resource Field توضیحات فیلدی را که در مراحل بعدی انتخاب متغیر به کاربر نهایی نمایش داده می‌شود، تنظیم می‌کند.
set Selector(selector) Resource Field یک کلید برای تابع ارائه دهنده تنظیم می‌کند تا مقدار آن را در طول اجرای مرحله ارائه دهد.

Resource Fields Definition Retrieved Action

روش‌ها

روش نوع بازگشتی شرح مختصر
add Dynamic Resource Definition(dynamicResourceDefinition) Resource Fields Definition Retrieved Action یک Dynamic Resource Definition به عمل بازیابی تعریف فیلدهای منبع اضافه می‌کند.

Resource Retrieved Action

روش‌ها

روش نوع بازگشتی شرح مختصر
set Resource Data(resourceData) Resource Retrieved Action Resource Data برای عمل بازیابی منبع تنظیم می‌کند تا مقادیری را برای فیلدهای منبع پویا یا فیلدهای منبع سفارشی ارائه دهد.

Resource Type

روش‌ها

روش نوع بازگشتی شرح مختصر
set Workflow Resource Definition Id(resourceType) Resource Type شناسه تعریف منبع گردش کار را تنظیم می‌کند.

Return Element Error Action

روش‌ها

روش نوع بازگشتی شرح مختصر
set Error Actionability(errorActionability) Return Element Error Action قابلیت اقدام در مورد خطا را تنظیم می‌کند، اگر بتوان با پیکربندی مجدد مرحله، خطا را برطرف کرد، باید قابل اقدام باشد.
set Error Log(log) Return Element Error Action تنظیم می‌کند که گزارش خطا در فید فعالیت Workflow به کاربر نهایی نمایش داده شود.
set Error Retryability(errorRetryability) Return Element Error Action قابلیت تلاش مجدد برای خطا را تنظیم می‌کند، اگر خطایی قابل تلاش مجدد نباشد، جریان پس از اولین تلاش خاتمه می‌یابد.

Return Output Variables Action

روش‌ها

روش نوع بازگشتی شرح مختصر
add Variable Data(key, value) Return Output Variables Action یک متغیر با نام متغیر اضافه می‌کند که با داده کلیدگذاری شده است، اگر کلید از قبل وجود داشته باشد، مقدار بازنویسی می‌شود.
set Log(log) Return Output Variables Action گزارش (Log) مربوط به عملیات گردش کار اجرا شده را برای کاربر نهایی در فید فعالیت گردش کار تنظیم می‌کند.
set Variable Data Map(variables) Return Output Variables Action نقشه داده‌های متغیر که با نام متغیر کلیدگذاری شده‌اند را تنظیم می‌کند، اگر کلید از قبل وجود داشته باشد، مقدار بازنویسی می‌شود.

Save Workflow Action

Styled Text

روش‌ها

روش نوع بازگشتی شرح مختصر
add Style(style) Styled Text سبک متن استایل‌بندی شده را تنظیم می‌کند، می‌تواند چندین سبک را به یک متن استایل‌بندی شده اعمال کند.
set Color(color) Styled Text رنگ متن استایل‌بندی شده را تنظیم می‌کند.
set Font Weight(fontWeight) Styled Text وزن فونت متن استایل‌بندی شده را تنظیم می‌کند.
set Text(text) Styled Text محتوای اصلی متن استایل‌دار را تنظیم می‌کند.

Text Format Chip

روش‌ها

روش نوع بازگشتی شرح مختصر
set Label(label) Text Format Chip متن نمایش داده شده در تراشه را تنظیم می‌کند.
set Text Format Icon(icon) Text Format Chip آیکون نمایش داده شده در تراشه را تنظیم می‌کند.
set Url(url) Text Format Chip آدرس اینترنتی (URL) را برای پیمایش هنگام کلیک روی تراشه تنظیم می‌کند.

Text Format Element

روش‌ها

روش نوع بازگشتی شرح مختصر
set Hyperlink(hyperlink) Text Format Element عنصر قالب متن را به عنوان یک Hyperlink تنظیم می‌کند.
set List Container(listContainer) Text Format Element عنصر قالب متن را به عنوان یک List Container تنظیم می‌کند.
set Styled Text(styledText) Text Format Element عنصر قالب متن را به عنوان یک Styled Text تنظیم می‌کند.
set Text(text) Text Format Element عنصر قالب متن را به عنوان یک رشته متنی تنظیم می‌کند.
set Text Format Chip(chip) Text Format Element عنصر قالب متن را به عنوان یک Text Format Chip تنظیم می‌کند.

Text Format Icon

روش‌ها

روش نوع بازگشتی شرح مختصر
set Icon Url(iconUrl) Text Format Icon آدرس اینترنتی آیکون را تنظیم می‌کند.
set Material Icon Name(materialIconName) Text Format Icon نام آیکون متریال تعریف شده در Google Material Icons را تنظیم می‌کند.

Text Style

خواص

ملک نوع توضیحات
STYLE_UNSPECIFIED Enum هیچ سبکی اعمال نشده است.
ITALIC Enum سبک ایتالیک.
UNDERLINE Enum سبک زیرخط دار.
STRIKETHROUGH Enum سبک خط خورده.
LINE_BREAK Enum خط شکنی.
UPPERCASE Enum سبک حروف بزرگ.
CODE Enum سبک کد.
CODE_BLOCK Enum سبک بلوک کد.

Time Stamp

روش‌ها

روش نوع بازگشتی شرح مختصر
set Nanos(nanos) Time Stamp نانو ثانیه‌های مربوط به برچسب زمانی را تنظیم می‌کند، که نشان دهنده تعداد نانو ثانیه‌ها در ثانیه فعلی است.
set Seconds(seconds) Time Stamp ثانیه‌های مربوط به برچسب زمانی را تنظیم می‌کند، که نشان دهنده تعداد ثانیه‌ها از زمان آغاز یونیکس (۱ ژانویه ۱۹۷۰، ساعت ۰۰:۰۰:۰۰ UTC) است.

Update Widget

روش‌ها

روش نوع بازگشتی شرح مختصر
add Suggestion(text, value, selected, startIconUri, bottomText) Update Widget یک آیتم جدید اضافه می‌کند که می‌تواند برای منوهای چند انتخابی انتخاب شود.

Validation Error Severity

خواص

ملک نوع توضیحات
SEVERITY_UNSPECIFIED Enum نامشخص.
CRITICAL Enum بحرانی، خطا بحرانی است و باید قبل از انتشار برطرف شود.
WARNING Enum هشدار، این خطا غیر بحرانی است و مانع انتشار نمی‌شود.

Value Metadata

روش‌ها

روش نوع بازگشتی شرح مختصر
add Castable Type(dataType) Value Metadata یک نوع داده‌ی مجاز اختیاری اضافه می‌کند که می‌تواند به صورت پویا برای داده‌های متغیر به این فراداده‌ی مقداری تبدیل شود.
add Enum Value(enumValue) Value Metadata یک مقدار رشته‌ای اختیاری به مقادیر شمارشی مجاز یک متغیر اضافه می‌کند، این فیلد فقط در صورتی قابل تنظیم است که Data Type روی نوع رشته (String) تنظیم شده باشد.
set Default Value(defaultValue) Value Metadata مقدار پیش‌فرض اختیاری متغیر را تنظیم می‌کند، مثلاً اگر نوع متغیر boolean باشد، مقدار پیش‌فرض می‌تواند روی « true » یا « false » تنظیم شود.

Variable Data

روش‌ها

روش نوع بازگشتی شرح مختصر
add Boolean Value(value) Variable Data یک مقدار بولی به متغیر data اضافه می‌کند.
add Email Address(emailAddress) Variable Data یک آدرس ایمیل به متغیر data اضافه می‌کند.
add Float Value(value) Variable Data یک مقدار اعشاری (float) به متغیر data اضافه می‌کند.
add Google User(googleUser) Variable Data یک کاربر گوگل را به متغیر data اضافه می‌کند.
add Integer Value(value) Variable Data یک مقدار صحیح به متغیر data اضافه می‌کند.
add Resource Data(resourceData) Variable Data یک مقدار Resource Data به متغیر data اضافه می‌کند.
add Resource Reference(resourceReference) Variable Data یک شناسه مرجع منبع به متغیر data اضافه می‌کند.
add String Value(value) Variable Data یک مقدار رشته‌ای را به متغیر data اضافه می‌کند.
add Timestamp Value(value) Variable Data یک مقدار Time Stamp به متغیر data اضافه می‌کند.
add Workflow Text Format(workflowTextFormat) Variable Data یک مقدار Workflow Text Format به متغیر data اضافه می‌کند.

Workflow Action

Workflow Text Format

روش‌ها

روش نوع بازگشتی شرح مختصر
add Text Format Element(textFormatElement) Workflow Text Format یک Text Format Element به قالب متن گردش کار اضافه می‌کند.

Workflow Validation Error Action

روش‌ها

روش نوع بازگشتی شرح مختصر
set Severity(severity) Workflow Validation Error Action شدت خطای اعتبارسنجی را تنظیم می‌کند.