Package google.apps.studio.v1

فهرست

خدمات استودیوی کاری

سرویس استودیوی فضای کاری.

آتش‌افروز

rpc FireTrigger( FireTriggerRequest ) returns ( FireTriggerResponse )

به گوگل اطلاع می‌دهد که یک رویداد محرک رخ داده است.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/workspace.studio.trigger

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

درخواست آتش‌افروزی

پیام درخواست برای متد FireTrigger.

فیلدها
name

string

الزامی. نام منبع تریگر. فرمت: triggers/{trigger_id}

outputs

map<string, VariableData >

اختیاری. متغیرهای خروجی از رویداد تریگر در برنامه 3P.

log

TextFormat

اختیاری. گزارش مواجهه کاربر برای رویداد محرک اختیاری است.

request_id

string

اختیاری. یک شناسه منحصر به فرد برای این درخواست. محدود به ۳۶ کاراکتر ASCII. یک UUID تصادفی توصیه می‌شود. این درخواست فقط در صورتی که request_id ارائه شود، خود-توان (idempotent) است.

پاسخ آتش‌افروز

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

پیام پاسخ برای متد FireTrigger.

منابع داده

مقدار منبع خاص برنامه.

فیلدها
fields

map<string, VariableData >

نقشه‌ای از فیلدهای منابع که با نام فیلد کلیدگذاری شده‌اند.

قالب متن

بلوکی از متن با گزینه‌های قالب‌بندی غنی شامل سبک‌ها، هایپرلینک‌ها و عناصر تعاملی.

فیلدها
text_format_elements[]

TextFormatElement

اختیاری. مجموعه‌ای از عناصر قالب‌بندی متن.

تراشه

یک تراشه قابل کلیک در قالب متن.

فیلدها
icon

Icon

اختیاری. آیکون نمایش داده شده در تراشه.

label

string

اختیاری. متنی که در تراشه نمایش داده می‌شود.

url

string

اختیاری. آدرس اینترنتی (URL) که پس از کلیک روی تراشه به آن هدایت می‌شوید.

آیکون

یک آیکون در تراشه.

فیلدها
icons فیلد Union. آیکون نمایش داده شده در چیپ. icons می‌توانند فقط یکی از موارد زیر باشند:
icon_url

string

یک آیکون سفارشی که در یک URL HTTPS میزبانی می‌شود را نمایش دهید.

برای مثال:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

انواع فایل‌های پشتیبانی‌شده شامل .png ‎ و .jpg ‎ هستند.

material_icon

string

نام آیکون تعریف شده در Google Material Icon ، برای مثال، check_box . هر نام نامعتبری رها شده و با رشته خالی جایگزین می‌شود و منجر به عدم نمایش آیکون می‌شود.

عنصر قالب متن

یک عنصر واحد در یک پیام WorkflowTextFormatMarkup، که می‌تواند یک تراشه، متن استایل‌دار، یک هایپرلینک یا یک فهرست باشد.

فیلدها
element فیلد Union. عنصری که یکی از چندین عنصر قالب‌بندی متن ممکن را نشان می‌دهد. element می‌تواند فقط یکی از موارد زیر باشد:
text

string

متن در قالب متن.

chip

Chip

تراشه قابل کلیک در قالب متن.

styled_text

StyledText

متن استایل‌دار در قالب متن.

list_container

ListContainer

فهرست کانتینر در قالب متن.

فهرست کانتینر

ظرفی برای آیتم‌های لیست، که در آن هر آیتم لیست می‌تواند شامل چندین TextFormatElement باشد.

فیلدها
list_nest_level

int64

اختیاری. سطح تودرتوی لیست. از ۰ برای سطح بالا شروع می‌شود و برای هر لیست تودرتو ۱ واحد افزایش می‌یابد.

list_type

ListType

اختیاری. نوع لیست.

list_items[]

ListItem

اختیاری. مجموعه‌ای از آیتم‌های لیست.

آیتم لیست

یک مورد فهرست.

فیلدها
text_format_elements[]

TextFormatElement

اختیاری. مجموعه‌ای از عناصر قالب‌بندی متن.

نوع لیست

Enum برای انواع مختلف لیست.

انوم‌ها
LIST_TYPE_UNSPECIFIED نوع فهرست مشخص نشده است.
ORDERED لیست مرتب شده.
UNORDERED لیست نامرتب.

متن استایل‌دار

عنصر متن با سبک‌هایی مانند پررنگ، کج و رنگی.

فیلدها
text

string

اختیاری. محتوای اصلی متن.

styles[]

Style

اختیاری. مجموعه‌ای از سبک‌های اعمال‌شده بر متن.

font_weight

FontWeight

اختیاری. وزن فونت متن.

color

Color

اختیاری. رنگ متن.

wrap_style

WrapStyle

اختیاری. سبک پوشش متن.

وزن فونت

Enum برای وزن‌های مختلف فونت.

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

سبک

Enum برای سبک‌های مختلف متن مانند ایتالیک، زیرخط‌دار و غیره

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

سبک بسته‌بندی

Enum برای سبک‌های مختلف پوشش.

انوم‌ها
WRAP_STYLE_UNSPECIFIED هیچ سبک بسته‌بندی مشخص نشده است.
NO_WRAP بدون سبک بسته بندی.

داده‌های متغیر

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

فیلدها
boolean_values[]

bool

مقادیر بولی.

integer_values[]

int64

مقادیر عدد صحیح.

string_values[]

string

مقادیر رشته‌ای.

timestamp_values[]

Timestamp

مقادیر برچسب زمانی.

resource_references[]

string

فهرستی از شناسه‌های منابع (مثلاً "spaces/123").

resource_data_values[]

ResourceData

فهرستی از داده‌های منابع.

email_address_values[]

string

مقادیر آدرس ایمیل

users[]

string

مقادیر کاربر گوگل در قالب users/{user} .