Package google.chat.v1

فضای حالت واردات.

متناسب

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

نشانه گذاری برای توسعه دهندگان برای مشخص کردن محتوای یک افزونه متنی.

کارت

کارت یک عنصر UI است که می تواند حاوی ابزارک های UI مانند متن و تصاویر باشد.

فیلدها
`header`	`CardHeader` هدر کارت. یک هدر معمولاً شامل یک عنوان و یک تصویر است.
`sections[]`	`Section` بخش ها توسط یک تقسیم کننده خط از هم جدا می شوند.
`card_actions[]`	`CardAction` اقدامات این کارت
`name`	`string` نام کارت

کاردستی

اقدام کارت عمل مرتبط با کارت است. برای کارت فاکتور ، یک اقدام معمولی خواهد بود: فاکتور ، فاکتور ایمیل را حذف کنید یا فاکتور را در مرورگر باز کنید.

توسط برنامه های گپ Google پشتیبانی نمی شود.

فیلدها

action_label

string

برچسب مورد استفاده در مورد منوی اکشن نمایش داده می شود.

on_click

عمل OnClick برای این مورد اقدام.

سربرگ کارت

فیلدها
`title`	`string` عنوان باید مشخص شود. این هدر دارای ارتفاع ثابت است: اگر هم عنوان و هم زیرنویس مشخص شده باشد ، هر یک یک خط را به خود اختصاص می دهد. اگر فقط عنوان مشخص شده باشد ، هر دو خط را به خود اختصاص می دهد.
`subtitle`	`string` زیرنویس هدر کارت.
`image_style`	`ImageStyle` نوع تصویر (به عنوان مثال ، مرز مربع یا مرز دایره ای).
`image_url`	`string` URL تصویر در هدر کارت.

تصویر

Enums
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	مرز مربع
`AVATAR`	مرز دایره ای.

بخش

یک بخش شامل مجموعه ای از ابزارک ها است که به ترتیب مشخص شده (به صورت عمودی) ارائه می شوند. در تمام سیستم عامل ها ، کارت ها دارای عرض ثابت باریک هستند ، بنابراین در حال حاضر نیازی به خصوصیات چیدمان (به عنوان مثال ، شناور) نیست.

فیلدها

header

string

هدر بخش. متن فرمت شده پشتیبانی می شود. برای کسب اطلاعات بیشتر در مورد قالب بندی متن ، به قالب بندی متن در برنامه های گپ Google و قالب بندی متن در افزودنی های فضای کاری Google مراجعه کنید.

widgets[]

WidgetMarkup

یک بخش باید حداقل یک ویجت داشته باشد.

CreateCustomemoJireQuest

درخواستی برای ایجاد ایموجی های سفارشی.

فیلدها

custom_emoji

مورد نیاز. ایموجی های سفارشی برای ایجاد.

CreatemembershipRequest

برای ایجاد عضویت پیام را درخواست کنید.

فیلدها

parent

string

مورد نیاز. نام منابع فضایی که برای ایجاد عضویت برای آن ایجاد می شود.

قالب: فضاها/{فضا}

membership

مورد نیاز. رابطه عضویت برای ایجاد.

قسمت memberType باید دارای یک کاربر با زمینه های user.name و user.type باشد. سرور نام منبع را اختصاص داده و هر چیزی را که مشخص شده است بازنویسی می کند.

هنگامی که یک برنامه چت یک رابطه عضویت برای یک کاربر انسانی ایجاد می کند ، باید از اسکوپ های مجوز خاصی استفاده کند و مقادیر خاصی را برای زمینه های خاص تعیین کند:

هنگام تأیید اعتبار به عنوان کاربر ، دامنه مجوز chat.memberships مورد نیاز است.
هنگام تأیید اعتبار به عنوان یک برنامه ، دامنه مجوز chat.app.memberships مورد نیاز است.
user.type به HUMAN تنظیم کنید ، و user.name با users/{user} تنظیم کنید ، جایی که {user} می تواند آدرس ایمیل برای کاربر باشد. برای کاربران در همان سازمان فضای کاری {user} همچنین می تواند id شخص از API افراد یا id کاربر در API دایرکتوری باشد. به عنوان مثال ، اگر شناسه پروفایل People API Person for user@example.com 123456789 است ، می توانید با تنظیم membership.member.name به users/user@example.com یا users/123456789 کاربر را به فضا اضافه کنید.

دعوت از کاربران خارجی به سازمان فضای کاری که صاحب این فضا است ، نیاز به احراز هویت کاربر دارد.

هنگامی که یک برنامه چت یک رابطه عضویت را برای خود ایجاد می کند ، باید به عنوان کاربر تأیید شود و از دامنه chat.memberships.app استفاده کند BOT user.type user.name تنظیم users/app .

use_admin_access

bool

اختیاری. در صورت true ، این روش با استفاده از امتیازات مدیر فضای کاری کاربر کاربر اجرا می شود.

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به دامنه chat.admin.memberships oauth 2.0 نیاز دارد.

ایجاد عضویت در برنامه یا ایجاد عضویت برای کاربران خارج از سازمان فضای کاری Google Administrator با استفاده از Admin Access پشتیبانی نمی شود.

createmessagerequest

پیام ایجاد می کند.

فیلدها
`parent`	`string` مورد نیاز. نام منبع فضایی که در آن می توانید پیام ایجاد کنید. قالب: `spaces/{space}`
`message`	`Message` مورد نیاز. بدن پیام
`thread_key (deprecated)`	`string` این مورد مستهلک می شود! اختیاری. deprecated: به جای آن از `thread.thread_key` استفاده کنید. شناسه برای موضوع. حداکثر 4000 کاراکتر را پشتیبانی می کند. برای شروع یا اضافه کردن به یک موضوع ، یک پیام ایجاد کرده و یک `threadKey` یا موضوع یا `thread.name` را مشخص کنید. به عنوان مثال استفاده ، به شروع یا پاسخ به موضوع پیام مراجعه کنید.
`request_id`	`string` اختیاری. شناسه درخواست منحصر به فرد برای این پیام. مشخص کردن یک شناسه درخواست موجود ، پیام ایجاد شده با آن شناسه را به جای ایجاد پیام جدید برمی گرداند.
`message_reply_option`	`MessageReplyOption` اختیاری. مشخص می کند که آیا یک پیام یک موضوع را شروع می کند یا به یکی پاسخ می دهد. فقط در فضاهای نامگذاری شده پشتیبانی می شود. هنگام پاسخ به تعامل کاربر ، این قسمت نادیده گرفته می شود. برای تعامل در یک موضوع ، پاسخ در همان موضوع ایجاد می شود. در غیر این صورت ، پاسخ به عنوان یک موضوع جدید ایجاد می شود.
`message_id`	`string` اختیاری. یک شناسه سفارشی برای یک پیام. اجازه می دهیم برنامه های گپ بدون نیاز به ذخیره شناسه تعیین شده توسط سیستم در نام منبع پیام (که در قسمت `name` پیام ارائه شده است) دریافت ، به روزرسانی یا حذف پیام را حذف ، به روز کنید. مقدار این قسمت باید شرایط زیر را برآورده کند: با `client-` شروع می شود. به عنوان مثال ، `client-custom-name` یک شناسه سفارشی معتبر است ، اما `custom-name` نیست. حداکثر 63 کاراکتر و فقط حروف کوچک ، اعداد و خط ها را نشان می دهد. در یک فضا بی نظیر است. یک برنامه چت نمی تواند از همان شناسه سفارشی برای پیام های مختلف استفاده کند. برای جزئیات بیشتر ، به یک پیام مراجعه کنید.

پیام رسانی

نحوه پاسخ به پیام را مشخص می کند. ممکن است کشورهای بیشتری در آینده اضافه شوند.

Enums
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	پیش فرض یک موضوع جدید را شروع می کند. با استفاده از این گزینه ، هر `thread ID` یا `thread_key` که در آن گنجانده شده است نادیده می گیرد.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	پیام را به عنوان پاسخی به موضوع مشخص شده توسط `thread ID` یا `thread_key` ایجاد می کند. در صورت عدم موفقیت ، پیام به جای آن یک موضوع جدید را شروع می کند.
`REPLY_MESSAGE_OR_FAIL`	پیام را به عنوان پاسخی به موضوع مشخص شده توسط `thread ID` یا `thread_key` ایجاد می کند. اگر از `thread_key` جدید استفاده شود ، یک موضوع جدید ایجاد می شود. اگر ایجاد پیام از بین برود ، به جای آن یک خطای `NOT_FOUND` بازگردانده می شود.

رفیق

واکنشی به یک پیام ایجاد می کند.

فیلدها

parent

string

مورد نیاز. پیامی که در آن واکنش ایجاد شده است.

قالب: spaces/{space}/messages/{message}

reaction

مورد نیاز. واکنش برای ایجاد.

CreateSpacereQuest

درخواستی برای ایجاد یک فضای نامگذاری شده بدون عضو.

فیلدها

space

مورد نیاز. زمینه های displayName و spaceType باید جمع شوند. فقط SpaceType.SPACE و SpaceType.GROUP_CHAT پشتیبانی می شوند. SpaceType.GROUP_CHAT فقط در صورت تنظیم صحیح importMode قابل استفاده است.

اگر پیام خطا را ALREADY_EXISTS دریافت کرده اید ، یک displayName متفاوت را امتحان کنید. یک فضای موجود در سازمان فضای کاری Google ممکن است در حال حاضر از این نام نمایش استفاده کند.

name فضایی روی سرور اختصاص داده شده است تا هر چیزی که در این زمینه مشخص شده باشد نادیده گرفته شود.

request_id

string

اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می شود. مشخص کردن شناسه درخواست موجود ، فضای ایجاد شده با آن شناسه را به جای ایجاد یک فضای جدید باز می گرداند. مشخص کردن شناسه درخواست موجود از همان برنامه چت با کاربر معتبر متفاوت خطایی را برمی گرداند.

سفارشی

نمایانگر یک ایموجی سفارشی است .

فیلدها
`name`	`string` شناسه نام منبع ایموجی های سفارشی ، که توسط سرور اختصاص داده شده است. قالب: `customEmojis/{customEmoji}`
`uid`	`string` فقط خروجی کلید منحصر به فرد برای منبع ایموجی سفارشی.
`emoji_name`	`string` اختیاری. تغییرناپذیر. نام توسط کاربر برای ایموجی های سفارشی ، که در سازمان بی نظیر است. هنگام ایجاد ایموجی های سفارشی ، مورد نیاز است ، فقط در غیر این صورت خروجی. نامهای ایموجی باید با استفاده از کلون ها شروع و پایان یابد ، باید حروف کوچک باشد و فقط می تواند حاوی شخصیت های الفبایی ، هیپنوها و زیرزمین ها باشد. برای جدا کردن کلمات باید از Hyphens و زیرکرها استفاده شود و به طور متوالی قابل استفاده نیست. مثال :: `:valid-emoji-name:`
`temporary_image_uri`	`string` فقط خروجی یک URL موقت تصویر برای ایموجی های سفارشی ، حداقل برای 10 دقیقه معتبر است. توجه داشته باشید که هنگام ایجاد ایموجی های سفارشی ، این در پاسخ جمع نمی شود.
`payload`	`CustomEmojiPayload` اختیاری. فقط ورودی داده های بارگذاری هنگام ایجاد ایموجی های سفارشی مورد نیاز است.

بار سفارشی

داده های بار برای ایموجی های سفارشی.

فیلدها

file_content

bytes

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

بار بار باید زیر 256 کیلوبایت باشد و ابعاد تصویر باید مربع و بین 64 تا 500 پیکسل باشد. محدودیت ها در معرض تغییر هستند.

filename

string

مورد نیاز. فقط ورودی نام پرونده تصویر

پسوند پرونده پشتیبانی شده: .png ، .jpg ، .gif .

سفارشی

ابرداده حاشیه نویسی برای ایموجی های سفارشی.

فیلدها

custom_emoji

ایموجی های سفارشی.

leeletecustomemojirequest

درخواست حذف ایموجی های سفارشی.

فیلدها

name

string

مورد نیاز. نام منابع ایموجی های سفارشی برای حذف.

قالب: customEmojis/{customEmoji}

می توانید از نام ایموجی به عنوان نام مستعار برای {customEmoji} استفاده کنید. به عنوان مثال ، customEmojis/:example-emoji: کجا :example-emoji: نام ایموجی برای یک ایموجی سفارشی است.

DeletemembershipRequest

درخواست حذف عضویت در یک فضا.

فیلدها

name

string

مورد نیاز. نام منابع عضویت برای حذف. برنامه های گپ می توانند عضویت کاربران انسانی یا خود را حذف کنند. برنامه های چت نمی توانند عضویت برنامه های دیگر را حذف کنند.

هنگام حذف عضویت انسانی ، به دامنه chat.memberships با تأیید اعتبار کاربر یا chat.memberships.app با تأیید برنامه و spaces/{space}/members/{member} نیاز دارد. می توانید از ایمیل به عنوان نام مستعار برای {member} استفاده کنید. به عنوان مثال ، spaces/{space}/members/example@gmail.com که در آن example@gmail.com ایمیل کاربر گپ Google است.

هنگام حذف عضویت در برنامه ، chat.memberships.app memberships.app دامنه و spaces/{space}/members/app نیاز دارد.

قالب: spaces/{space}/members/{member} یا spaces/{space}/members/app .

use_admin_access

bool

اختیاری. در صورت true ، این روش با استفاده از امتیازات مدیر فضای کاری کاربر کاربر اجرا می شود.

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به دامنه chat.admin.memberships oauth 2.0 نیاز دارد.

حذف عضویت در برنامه در یک فضا با استفاده از دسترسی مدیر پشتیبانی نمی شود.

leletemessagerequest

درخواست حذف پیام.

فیلدها

name

string

مورد نیاز. نام منبع پیام.

قالب: spaces/{space}/messages/{message}

اگر یک شناسه سفارشی را برای پیام خود تنظیم کرده اید ، می توانید از قسمت clientAssignedMessageId برای {message} استفاده کنید. برای جزئیات بیشتر ، به یک پیام مراجعه کنید.

force

bool

اختیاری. هنگامی که true ، حذف یک پیام نیز پاسخ های موضوعی خود را حذف می کند. هنگامی که false ، اگر یک پیام پاسخ داده شود ، حذف حذف می شود.

فقط در هنگام تأیید اعتبار به عنوان کاربر اعمال می شود. در هنگام تأیید اعتبار به عنوان برنامه چت هیچ تاثیری ندارد.

deletereactionRequest

واکنشی به یک پیام حذف می کند.

فیلدها

name

string

مورد نیاز. نام واکنش برای حذف.

قالب: spaces/{space}/messages/{message}/reactions/{reaction}

leletespacerequest

درخواست حذف یک فضا.

فیلدها

name

string

مورد نیاز. نام منبع فضا برای حذف.

قالب: spaces/{space}

use_admin_access

bool

اختیاری. در صورت true ، این روش با استفاده از امتیازات مدیر فضای کاری کاربر کاربر اجرا می شود.

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به دامنه chat.admin.delete oauth 2.0 نیاز دارد.

حذف metadata

اطلاعات مربوط به یک پیام حذف شده. هنگام تنظیم delete_time یک پیام حذف می شود.

فیلدها

deletion_type

DeletionType

نشان می دهد چه کسی پیام را حذف کرده است.

حذف

چه کسی پیام را حذف کرد و چگونه حذف شد. مقادیر بیشتری ممکن است در آینده اضافه شود. برای جزئیات بیشتر در مورد حذف پیام ها ، ویرایش یا حذف پیام در Google Chat را مشاهده کنید.

Enums
`DELETION_TYPE_UNSPECIFIED`	این مقدار بلااستفاده است.
`CREATOR`	کاربر پیام خود را حذف کرد.
`SPACE_OWNER`	یک مدیر فضا پیام را حذف کرد.
`ADMIN`	یک مدیر فضای کاری Google پیام را حذف کرد. سرپرستان می توانند هر پیام را در فضا حذف کنند ، از جمله پیام های ارسال شده توسط هر یک از اعضای فضایی یا برنامه چت.
`APP_MESSAGE_EXPIRY`	یک برنامه گپ هنگام انقضا ، پیام خود را حذف کرد.
`CREATOR_VIA_APP`	یک برنامه چت پیام را به نمایندگی از خالق (با استفاده از تأیید اعتبار کاربر) حذف کرد.
`SPACE_OWNER_VIA_APP`	یک برنامه چت پیام را به نمایندگی از یک مدیر فضا (با استفاده از تأیید اعتبار کاربر) حذف کرد.
`SPACE_MEMBER`	یکی از اعضای فضا پیام را حذف کرد. کاربران می توانند پیام های ارسال شده توسط برنامه ها را حذف کنند.

گفتگو

بسته بندی اطراف بدنه دیالوگ.

فیلدها

body

Card

فقط ورودی بدنه گفتگو ، که در یک معین ارائه می شود. برنامه های گپ Google از موجودات کارت زیر پشتیبانی نمی کنند: DateTimePicker ، OnChangeAction .

DialogAction

حاوی یک گفتگوی و کد وضعیت درخواست است.

فیلدها

action_status

ActionStatus

فقط ورودی وضعیت برای درخواست برای استناد به یا ارسال گفتگو . در صورت لزوم وضعیت و پیام را به کاربران نشان می دهد. به عنوان مثال ، در صورت بروز خطا یا موفقیت.

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

dialog

Dialog

فقط ورودی گفتگو برای درخواست.

Driendataref

اشاره به داده های پیوست درایو.

فیلدها

drive_file_id

string

شناسه پرونده درایو. با API درایو استفاده کنید.

دیلینکستاتا

داده ها برای پیوندهای Google Drive.

فیلدها

drive_data_ref

DriveDataRef

یک Driredataref که به یک پرونده Google Drive اشاره می کند.

mime_type

string

نوع MIME منبع Google Drive Linked.

ایموجی

ایموجی که به عنوان واکنشی به یک پیام استفاده می شود.

فیلدها

content میدان اتحادیه. مورد نیاز. محتوای ایموجی ها. content می تواند تنها یکی از موارد زیر باشد:

unicode

string

اختیاری. یک ایموجی اساسی که توسط یک رشته یونیکد نشان داده شده است.

custom_emoji

یک ایموجی سفارشی.

emojirectionsummary

تعداد افرادی که با یک ایموجی خاص به پیام واکنش نشان دادند.

فیلدها

emoji

فقط خروجی ایموجی های مرتبط با واکنش.

reaction_count

int32

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

FindDirectMessagerequest

درخواستی برای دریافت فضای پیام مستقیم بر اساس منبع کاربر.

فیلدها

name

string

مورد نیاز. نام منبع کاربر برای یافتن پیام مستقیم با.

قالب: users/{user} ، که در آن {user} یا id شخص از افراد API افراد است ، یا id کاربر در API دایرکتوری. به عنوان مثال ، اگر شناسه پروفایل API People 123456789 باشد ، می توانید با استفاده users/123456789 به عنوان name ، یک پیام مستقیم با آن شخص پیدا کنید. هنگامی که به عنوان کاربر تأیید می شود ، می توانید از ایمیل به عنوان نام مستعار برای {user} استفاده کنید. به عنوان مثال ، users/example@gmail.com example@gmail.com که در آن example@gmail.com ایمیل کاربر Google Chat است.

GetAttachmentRequest

درخواست دریافت پیوست.

فیلدها

name

string

مورد نیاز. نام منبع ضمیمه ، در spaces/{space}/messages/{message}/attachments/{attachment} .

getCustomemoJireQuest

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

فیلدها

name

string

مورد نیاز. نام منبع ایموجی های سفارشی.

قالب: customEmojis/{customEmoji}

GetMembershipRequest

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

فیلدها

name

string

مورد نیاز. نام منابع عضویت برای بازیابی.

برای به دست آوردن عضویت خود برنامه با استفاده از تأیید اعتبار کاربر ، می توانید به صورت اختیاری spaces/{space}/members/app استفاده کنید.

قالب: spaces/{space}/members/{member} یا spaces/{space}/members/app

می توانید از ایمیل کاربر به عنوان نام مستعار برای {member} استفاده کنید. به عنوان مثال ، spaces/{space}/members/example@gmail.com که در آن example@gmail.com ایمیل کاربر گپ Google است.

use_admin_access

bool

اختیاری. در صورت true ، این روش با استفاده از امتیازات مدیر فضای کاری کاربر کاربر اجرا می شود.

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

نیاز به chat.admin.memberships یا chat.admin.memberships.readonly oauth 2.0 Scopes دارد.

دریافت عضویت در برنامه در یک فضا هنگام استفاده از Admin Access پشتیبانی نمی شود.

GetMessagerEquest

درخواست دریافت پیام

فیلدها

name

string

مورد نیاز. نام منبع پیام.

قالب: spaces/{space}/messages/{message}

getSpaceEventRequest

برای دریافت یک رویداد فضایی پیام را درخواست کنید.

فیلدها

name

string

مورد نیاز. نام منابع رویداد فضایی.

قالب: spaces/{space}/spaceEvents/{spaceEvent}

getSpacenotificationatingRequest

برای دریافت تنظیم اطلاع رسانی فضایی ، پیام را درخواست کنید. فقط از دریافت تنظیم اعلان برای کاربر فراخوانی پشتیبانی می کند.

فیلدها

name

string

مورد نیاز. قالب: کاربران/{کاربر}/فضاها/{فضا}/Spacenotificationationsing

users/me/spaces/{space}/spaceNotificationSetting ، یا
users/user@example.com/spaces/{space}/spaceNotificationSetting ، یا
users/123456789/spaces/{space}/spaceNotificationSetting . توجه: فقط شناسه کاربر یا ایمیل تماس گیرنده در مسیر مجاز است.

getSpacereadStaterequest

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

فیلدها

name

string

مورد نیاز. نام منابع از حالت خوانده شده برای بازیابی.

فقط از خواندن حالت خوانده شده برای کاربر فراخوانی پشتیبانی می کند.

برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید:

من me مستعار به عنوان مثال ، users/me/spaces/{space}/spaceReadState .
آدرس ایمیل فضای کاری آنها. به عنوان مثال ، users/user@example.com/spaces/{space}/spaceReadState /spacereadstate.
شناسه کاربر آنها به عنوان مثال ، users/123456789/spaces/{space}/spaceReadState .

قالب: کاربران/{کاربر}/فضاها/{فضا}/SpacereadState

GetSpacereQuest

درخواست بازگشت یک فضای واحد.

فیلدها

name

string

مورد نیاز. نام منبع فضا ، در spaces/{space} .

قالب: spaces/{space}

use_admin_access

bool

اختیاری. در صورت true ، این روش با استفاده از امتیازات مدیر فضای کاری کاربر کاربر اجرا می شود.

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به Scopes chat.admin.spaces یا chat.admin.spaces.readonly oauth 2.0 نیاز دارد.

getThreadReadStateRequest

پیام درخواست GetThreadReadStateRequest API.

فیلدها

name

string

مورد نیاز. نام منبع موضوع موضوع را برای بازیابی.

فقط از خواندن حالت خوانده شده برای کاربر فراخوانی پشتیبانی می کند.

برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید:

من me مستعار به عنوان مثال ، users/me/spaces/{space}/threads/{thread}/threadReadState .
آدرس ایمیل فضای کاری آنها. به عنوان مثال ، users/user@example.com/spaces/{space}/threads/{thread}/threadReadState /ThreadReadState.
شناسه کاربر آنها به عنوان مثال ، users/123456789/spaces/{space}/threads/{thread}/threadReadState .

فرمت: کاربران/{کاربر}/فضاها/{فضا}/موضوع/{موضوع}/ThreadReadState

گروه

یک گروه Google در Google Chat.

فیلدها

name

string

نام منابع برای یک گروه Google.

گروهی در گروه های هویت ابری API را نشان می دهد.

قالب: گروه ها/{گروه}

تاریخچه

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

Enums
`HISTORY_STATE_UNSPECIFIED`	مقدار پیش فرض استفاده نکنید.
`HISTORY_OFF`	تاریخ خاموش. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند .
`HISTORY_ON`	تاریخ در. قوانین حفظ طاق سازمان مشخص می کند که چه مدت پیام ها و موضوعات نگه داشته می شوند.

ListCustomeMoJisRequest

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

فیلدها

page_size

int32

اختیاری. حداکثر تعداد ایموجی های سفارشی بازگشتند. این سرویس می تواند کمتر از این مقدار ایموجی های سفارشی برگردد. اگر نامشخص باشد ، مقدار پیش فرض 25 است. حداکثر مقدار 200 است. مقادیر بالاتر از 200 به 200 تغییر می یابد.

page_token

string

اختیاری. (در صورت از سرگیری از یک پرس و جو قبلی.)

نشانه ای از صفحه دریافت شده از لیست قبلی تماس ایموجی سفارشی. این کار را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، مقدار فیلتر باید با تماس ارائه شده با صفحه مطابقت داشته باشد. عبور از یک مقدار متفاوت ممکن است منجر به نتایج غیر منتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو.

از فیلتر توسط خالق پشتیبانی می کند.

برای فیلتر کردن توسط خالق ، باید یک مقدار معتبر را مشخص کنید. در حال حاضر فقط creator("users/me") و NOT creator("users/me") پذیرفته شده اند که آیا آنها توسط کاربر فراخوانی ایجاد شده اند یا نه ، ایموجی های سفارشی را فیلتر کنند.

به عنوان مثال ، پرس و جو زیر ایموجی های سفارشی ایجاد شده توسط تماس گیرنده را برمی گرداند:

creator("users/me")

نمایش داده شدگان نامعتبر با یک خطای INVALID_ARGUMENT رد می شوند.

پاسخ لیست

پاسخ به لیست ایموجی های سفارشی.

فیلدها

custom_emojis[]

لیست بدون هماهنگ. لیست ایموجی های سفارشی.

next_page_token

string

نشانه ای که می توانید به عنوان pageToken برای بازیابی صفحه بعدی نتایج ارسال کنید. اگر خالی باشد ، هیچ صفحه بعدی وجود ندارد.

listmembershipsrequest

درخواست پیام برای لیست عضویت.

فیلدها
`parent`	`string` مورد نیاز. نام منبع فضایی که می توانید لیست عضویت را بدست آورید. قالب: فضاها/{فضا}
`page_size`	`int32` اختیاری. حداکثر تعداد عضویت برای بازگشت. این سرویس ممکن است کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 100 عضویت بازگردانده می شوند. حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد. مقادیر منفی یک خطای `INVALID_ARGUMENT` را برمی گرداند.
`page_token`	`string` اختیاری. یک نشان صفحه ، از یک تماس قبلی برای لیست عضویت دریافت شده است. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.
`filter`	`string` اختیاری. یک فیلتر پرس و جو. شما می توانید عضویت در نقش ( `role` ) و نوع ( `member.type` ) عضویت را فیلتر کنید. برای فیلتر کردن بر اساس نقش ، `role` در `ROLE_MEMBER` یا `ROLE_MANAGER` تنظیم کنید. برای فیلتر کردن بر اساس نوع ، `member.type` به `HUMAN` یا `BOT` تنظیم کنید. همچنین می توانید با استفاده از اپراتور `!=` `member.type` فیلتر کنید. برای فیلتر کردن توسط هر دو نقش و نوع ، از اپراتور `AND` اپراتور استفاده کنید. برای فیلتر کردن توسط هر دو نقش یا نوع ، از اپراتور `OR` استفاده کنید. هر دو `member.type = "HUMAN"` یا `member.type != "BOT"` لازم است وقتی `use_admin_access` روی درست تنظیم شود. سایر فیلترهای نوع عضو رد می شوند. به عنوان مثال ، نمایش داده های زیر معتبر است: `role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT"` نمایش داده های زیر نامعتبر است: `member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"` نمایش داده شدگان نامعتبر توسط سرور با یک خطای `INVALID_ARGUMENT` رد می شوند.
`show_groups`	`bool` اختیاری. در صورت `true` ، علاوه بر سایر انواع عضویت ، عضویت های مرتبط با یک `Google Group` را نیز برمی گرداند. اگر `filter` تنظیم شود ، عضویت `Google Group` که با معیارهای فیلتر مطابقت ندارند ، بازگردانده نمی شوند.
`show_invited`	`bool` اختیاری. هنگامی که `true` ، علاوه بر سایر انواع عضویت ، عضویت در ارتباط با اعضای `invited` را نیز برمی گرداند. اگر فیلتر تنظیم شود ، عضویت های `invited` که با معیارهای فیلتر مطابقت ندارند ، بازگردانده نمی شوند. در حال حاضر به تأیید اعتبار کاربر نیاز دارد.
`use_admin_access`	`bool` اختیاری. در صورت `true` ، این روش با استفاده از امتیازات مدیر فضای کاری کاربر کاربر اجرا می شود. کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد. به `chat.admin.memberships.readonly` یا `chat.admin.memberships` oauth 2.0 نیاز دارد. لیست عضویت در برنامه در یک فضا هنگام استفاده از Admin Access پشتیبانی نمی شود.

listmembershipsresponse

پاسخ به لیست عضویت در فضا.

فیلدها

memberships[]

لیست بدون هماهنگ. لیست عضویت در صفحه درخواست شده (یا اول).

next_page_token

string

ListMessagesRequest

پیام ها را در فضای مشخص شده لیست می کند ، که کاربر عضو آن است.

فیلدها
`parent`	`string` مورد نیاز. نام منبع فضا برای لیست پیام ها از. قالب: `spaces/{space}`
`page_size`	`int32` اختیاری. حداکثر تعداد پیام های برگشت یافته. این سرویس ممکن است پیام های کمتری از این مقدار بازگرداند. در صورت نامشخص ، حداکثر 25 نفر بازگردانده می شوند. حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد. مقادیر منفی یک خطای `INVALID_ARGUMENT` را برمی گرداند.
`page_token`	`string` اختیاری. یک صفحه صفحه دریافت شده از تماس پیام های لیست قبلی. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.
`filter`	`string` اختیاری. یک فیلتر پرس و جو. می توانید پیام ها را بر اساس تاریخ ( `create_time` ) و Thread ( `thread.name` ) فیلتر کنید. برای فیلتر کردن پیام ها در تاریخ ایجاد شده ، `create_time` با یک Timestamp در قالب RFC-3339 و علائم دو برابر مشخص کنید. به عنوان مثال ، `"2023-04-21T11:30:00-04:00"` . برای لیست پیام هایی که پس از یک زمان بندی ایجاد شده اند یا کمتر از اپراتور `<` برای لیست پیام هایی که قبل از یک زمان بندی ایجاد شده اند ، می توانید از اپراتور `>` بیشتر از اپراتور استفاده کنید. برای فیلتر کردن پیام ها در یک بازه زمانی ، از `AND` اپراتور بین دو جدول زمانی استفاده کنید. برای فیلتر کردن بر روی نخ ، `thread.name` مشخص کنید ، به عنوان `spaces/{space}/threads/{thread}` . فقط می توانید یک `thread.name` در هر پرس و جو مشخص کنید. برای فیلتر کردن توسط موضوع و تاریخ ، از اپراتور `AND` در پرس و جو خود استفاده کنید. به عنوان مثال ، نمایش داده های زیر معتبر است: `create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123` نمایش داده شدگان نامعتبر توسط سرور با یک خطای `INVALID_ARGUMENT` رد می شوند.
`order_by`	`string` اختیاری. نحوه سفارش لیست پیام ها. یک مقدار برای سفارش توسط یک عملیات سفارش را مشخص کنید. مقادیر عملیاتی سفارش معتبر به شرح زیر است: `ASC` برای صعود. `DESC` برای نزول سفارش پیش فرض `create_time ASC` است.
`show_deleted`	`bool` اختیاری. آیا پیام های حذف شده را شامل می شود. پیام های حذف شده شامل زمان حذف شده و ابرداده در مورد حذف آنها هستند ، اما محتوای پیام در دسترس نیست.

listMessagesResponse

پیام پاسخ برای لیست پیام ها.

فیلدها

messages[]

Message

لیست پیام ها

next_page_token

string

برای بازیابی صفحه بعدی نتایج می توانید یک نشانه را به عنوان pageToken ارسال کنید. اگر خالی باشد ، هیچ صفحه بعدی وجود ندارد.

خطی

واکنش های یک پیام را لیست می کند.

فیلدها
`parent`	`string` مورد نیاز. کاربران پیام به آنها واکنش نشان دادند. قالب: `spaces/{space}/messages/{message}`
`page_size`	`int32` اختیاری. حداکثر تعداد واکنشهای برگشت یافته. این سرویس می تواند واکنش های کمتری نسبت به این مقدار بازگرداند. اگر نامشخص باشد ، مقدار پیش فرض 25 است. حداکثر مقدار 200 است. مقادیر بالاتر از 200 به 200 تغییر می یابد.
`page_token`	`string` اختیاری. (در صورت از سرگیری از یک پرس و جو قبلی.) یک نشان صفحه دریافت شده از تماس واکنش لیست قبلی. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، مقدار فیلتر باید با تماس ارائه شده با صفحه مطابقت داشته باشد. عبور از یک مقدار متفاوت ممکن است منجر به نتایج غیر منتظره شود.
`filter`	`string` اختیاری. یک فیلتر پرس و جو. می توانید واکنش های emoji ( `emoji.unicode` یا `emoji.custom_emoji.uid` ) و کاربر ( `user.name` ) را فیلتر کنید. برای فیلتر کردن واکنش های مختلف برای ایموجی های متعدد یا کاربران ، با اپراتور `OR` ، مانند `emoji.unicode = "🙂" OR emoji.unicode = "👍"` و `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"` بپیوندید. برای فیلتر کردن واکنش توسط ایموجی و کاربر ، از اپراتور `AND` اپراتور مانند `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"` استفاده کنید. اگر پرس و جو شما از هر دو `AND` `OR` گروه بندی آنها را با پرانتز استفاده می کند. به عنوان مثال ، نمایش داده های زیر معتبر است: `user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}"` نمایش داده های زیر نامعتبر است: `emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}"` نمایش داده شدگان نامعتبر با یک خطای `INVALID_ARGUMENT` رد می شوند.

پاسخ

پاسخ به درخواست واکنش لیست.

فیلدها

reactions[]

لیست واکنش ها در صفحه درخواست شده (یا اول).

next_page_token

string

نشانه ادامه برای بازیابی صفحه بعدی نتایج. برای آخرین صفحه نتایج خالی است.

listSpaceEventSrequest

درخواست پیام برای لیست رویدادهای فضایی.

فیلدها
`parent`	`string` مورد نیاز. نام منبع فضای چت Google که در آن وقایع رخ داده است. قالب: `spaces/{space}` .
`page_size`	`int32` اختیاری. حداکثر تعداد وقایع فضایی برگشت. این سرویس ممکن است کمتر از این مقدار برگردد. مقادیر منفی یک خطای `INVALID_ARGUMENT` را برمی گرداند.
`page_token`	`string` اختیاری. یک صفحه صفحه ، که از لیست قبلی رویدادهای فضایی دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده برای لیست رویدادهای فضایی باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.
`filter`	`string` مورد نیاز. یک فیلتر پرس و جو. شما باید حداقل یک نوع رویداد ( `event_type` ) را با استفاده از `:` اپراتور مشخص کنید. برای فیلتر کردن توسط انواع مختلف رویداد ، از اپراتور `OR` استفاده کنید. انواع رویداد دسته ای را در فیلتر خود حذف کنید. درخواست به طور خودکار هر رویداد دسته ای مربوطه را برمی گرداند. به عنوان مثال ، اگر با واکنش های جدید فیلتر کنید ( `google.workspace.chat.reaction.v1.created` ) ، سرور همچنین رویدادهای واکنش های جدید را برمی گرداند ( `google.workspace.chat.reaction.v1.batchCreated` ). برای لیستی از انواع رویداد پشتیبانی شده ، به مستندات مرجع `SpaceEvents` مراجعه کنید. به صورت اختیاری ، می توانید با زمان شروع ( `start_time` ) و زمان پایان ( `end_time` ) فیلتر کنید: `start_time` : جدول زمانی منحصر به فرد برای شروع لیست رویدادهای فضایی. می توانید رویدادهایی را که تا 28 روز پیش رخ داده است لیست کنید. اگر نامشخص باشد ، رویدادهای فضایی را از 28 روز گذشته لیست می کند. `end_time` : Timestamp فراگیر تا زمانی که رویدادهای فضایی ذکر شده اند. اگر نامشخص باشد ، رویدادها را تا زمان درخواست لیست می کند. برای مشخص کردن زمان شروع یا پایان ، از Equals `=` Operator و Format در RFC-3339 استفاده کنید. برای فیلتر کردن توسط `start_time` و `end_time` ، از اپراتور `AND` اپراتور استفاده کنید. به عنوان مثال ، نمایش داده های زیر معتبر است: `start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"` `start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created")` نمایش داده های زیر نامعتبر است: `start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"` `event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created"` نمایش داده شدگان نامعتبر توسط سرور با یک خطای `INVALID_ARGUMENT` رد می شوند.

فضیلت

پیام پاسخ برای لیست رویدادهای فضایی.

فیلدها

space_events[]

SpaceEvent

نتایج به ترتیب زمانی بازگردانده می شوند (قدیمی ترین رویداد اول). توجه: قسمت permissionSettings در شیء فضایی برای درخواست های لیست بازگردانده نمی شود.

next_page_token

string

توکن ادامه برای واکشی رویدادهای بیشتر. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد.

ListSpacesRequest

درخواستی برای لیست فضاهایی که تماس گیرنده عضو آن است.

فیلدها

page_size

int32

اختیاری. حداکثر تعداد فضاها برای بازگشت. این سرویس ممکن است کمتر از این مقدار برگردد.

در صورت نامشخص ، حداکثر 100 فضای بازگردانده می شوند.

حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

page_token

string

اختیاری. یک صفحه صفحه ، که از تماس فضاهای لیست قبلی دریافت شده است. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید.

filter

string

اختیاری. یک فیلتر پرس و جو.

می توانید فضاها را بر اساس نوع فضایی ( space_type ) فیلتر کنید.

برای فیلتر کردن بر اساس نوع فضایی ، باید مقدار معتبر Enum مانند SPACE یا GROUP_CHAT را مشخص کنید ( space_type نمی تواند SPACE_TYPE_UNSPECIFIED باشد). برای پرس و جو برای انواع مختلف فضایی ، از اپراتور OR استفاده کنید.

به عنوان مثال ، نمایش داده های زیر معتبر است:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

نمایش داده شدگان نامعتبر توسط سرور با یک خطای INVALID_ARGUMENT رد می شوند.

لیست

پاسخ درخواست فضاهای لیست.

فیلدها

spaces[]

لیست فضاهای موجود در صفحه درخواست شده (یا اول). توجه: قسمت permissionSettings در شیء فضایی برای درخواست های لیست بازگردانده نمی شود.

next_page_token

string

کابوس

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

فیلدها

url

string

فقط خروجی The URL that was matched.

MeetSpaceLinkData

Data for Meet space links.

فیلدها

meeting_code

string

Meeting code of the linked Meet space.

type

Type

Indicates the type of the Meet space.

huddle_status

HuddleStatus

اختیاری. فقط خروجی If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.

HuddleStatus

The status of the huddle

Enums
`HUDDLE_STATUS_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`STARTED`	The huddle has started.
`ENDED`	The huddle has ended. In this case the Meet space URI and identifiers will no longer be valid.
`MISSED`	The huddle has been missed. In this case the Meet space URI and identifiers will no longer be valid.

تایپ کنید

The type of the Meet space.

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`MEETING`	The Meet space is a meeting.
`HUDDLE`	The Meet space is a huddle.

عضویت

Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.

فیلدها
`name`	`string` Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
`state`	`MembershipState` فقط خروجی State of the membership.
`role`	`MembershipRole` اختیاری. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership` .
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.
`delete_time`	`Timestamp` اختیاری. تغییرناپذیر. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.
Union field `memberType` . Member associated with this membership. Other member types might be supported in the future. `memberType` can be only one of the following:
`member`	`User` اختیاری. The Google Chat user or app the membership corresponds to. If your Chat app authenticates as a user , the output populates the user `name` and `type` .
`group_member`	`Group` اختیاری. The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires user authentication .

MembershipRole

Represents a user's permitted actions in a Chat space. More enum values might be added in the future.

Enums

MEMBERSHIP_ROLE_UNSPECIFIED مقدار پیش فرض For users : they aren't a member of the space, but can be invited. For Google Groups : they're always assigned this role (other enum values might be used in the future).

ROLE_MEMBER

A member of the space. In the Chat UI, this role is called Member.

The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including:

Add or remove members.
Modify space details.
Turn history on or off.
Mention everyone in the space with @all .
Manage Chat apps and webhooks installed in the space.

In direct messages and unnamed group conversations, everyone has this role.

ROLE_MANAGER

A space owner. In the Chat UI, this role is called Owner.

The user has the complete set of space permissions to manage the space, including:

Change the role of other members in the space to member, manager, or owner.
Delete the space.

Only supported in SpaceType.SPACE (named spaces).

To learn more, see Learn more about your role as a space owner or manager .

MembershipState

Specifies the member's relationship with a space. Other membership states might be supported in the future.

Enums
`MEMBERSHIP_STATE_UNSPECIFIED`	مقدار پیش فرض استفاده نکنید.
`JOINED`	The user is added to the space, and can participate in the space.
`INVITED`	The user is invited to join the space, but hasn't joined it.
`NOT_A_MEMBER`	The user doesn't belong to the space and doesn't have a pending invitation to join the space.

پیام

A message in a Google Chat space.

فیلدها
`name`	`string` Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` . If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name` . For details, see Name a message .
`sender`	`User` فقط خروجی The user who created the message. If your Chat app authenticates as a user , the output populates the user `name` and `type` .
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.
`last_update_time`	`Timestamp` فقط خروجی The time at which the message was last edited by a user. If the message has never been edited, this field is empty.
`delete_time`	`Timestamp` فقط خروجی The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
`text`	`string` اختیاری. Plain-text body of the message. The first link to an image, video, or web page generates a preview chip . You can also @mention a Google Chat user , or everyone in the space. To learn about creating text messages, see Send a message .
`formatted_text`	`string` فقط خروجی Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: Markup syntax for bold, italic, strikethrough, monospace, monospace block, and bulleted list. User mentions using the format `<users/{user}>` . Custom hyperlinks using the format `<{url}\|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, `<http://example.com\|custom text>` . Custom emoji using the format `:{emoji_name}:` —for example, `:smile:` . This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see View text formatting sent in a message
`cards[] (deprecated)`	`Card` This item is deprecated! Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.
`cards_v2[]`	`CardWithId` اختیاری. An array of cards . Only Chat apps can create cards. If your Chat app authenticates as a user , the messages can't contain cards. To learn how to create a message that contains cards, see Send a message . Design and preview cards with the Card Builder. Open the Card Builder
`annotations[]`	`Annotation` فقط خروجی Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.
`thread`	`Thread` The thread the message belongs to. For example usage, see Start or reply to a message thread .
`space`	`Space` فقط خروجی If your Chat app authenticates as a user , the output only populates the space `name` .
`fallback_text`	`string` اختیاری. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
`action_response`	`ActionResponse` فقط ورودی Parameters that a Chat app can use to configure how its response is posted.
`argument_text`	`string` فقط خروجی Plain-text body of the message with all Chat app mentions stripped out.
`slash_command`	`SlashCommand` فقط خروجی Slash command information, if applicable.
`attachment[]`	`Attachment` اختیاری. User-uploaded attachment.
`matched_url`	`MatchedUrl` فقط خروجی A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see Preview links .
`thread_reply`	`bool` فقط خروجی When `true` , the message is a response in a reply thread. When `false` , the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false` .
`client_assigned_message_id`	`string` اختیاری. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the `messageId` field when you create the message. For details, see Name a message .
`emoji_reaction_summaries[]`	`EmojiReactionSummary` فقط خروجی The list of emoji reaction summaries on the message.
`private_message_viewer`	`User` اختیاری. تغییرناپذیر. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using app authentication and omit the following: پیوست ها Accessory widgets For details, see Send a message privately .
`deletion_metadata`	`DeletionMetadata` فقط خروجی Information about a deleted message. A message is deleted when `delete_time` is set.
`quoted_message_metadata`	`QuotedMessageMetadata` اختیاری. Information about a message that another message quotes. When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see Quote another message .
`attached_gifs[]`	`AttachedGif` فقط خروجی GIF images that are attached to the message.
`accessory_widgets[]`	`AccessoryWidget` اختیاری. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message . Creating a message with accessory widgets requires app authentication .

The updated message.

QuotedMessageMetadata

Information about a message that another message quotes.

When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread.

When you update a message, you can't add or replace the quotedMessageMetadata field, but you can remove it.

For example usage, see Quote another message .

فیلدها

name

string

مورد نیاز. Resource name of the message that is quoted.

Format: spaces/{space}/messages/{message}

last_update_time

مورد نیاز. The timestamp when the quoted message was created or when the quoted message was last updated.

If the message was edited, use this field, last_update_time . If the message was never edited, use create_time .

If last_update_time doesn't match the latest version of the quoted message, the request fails.

واکنش

A reaction to a message.

فیلدها

name

string

Identifier. The resource name of the reaction.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

فقط خروجی The user who created the reaction.

emoji

ReactionCreatedEventData

مورد نیاز. The emoji used in the reaction.

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

فیلدها

reactions[]

A list of new reactions.

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

فیلدها

reactions[]

ReactionDeletedEventData

A list of deleted reactions.

ReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

فیلدها

reaction

The new reaction.

ReactionDeletedEventData

Event payload for a deleted reaction.

Type: google.workspace.chat.reaction.v1.deleted

فیلدها

reaction

The deleted reaction.

RichLinkMetadata

A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with start_index and length of 0.

فیلدها
`uri`	`string` The URI of this link.
`rich_link_type`	`RichLinkType` The rich link type.
Union field `data` . Data for the linked resource. `data` can be only one of the following:
`drive_link_data`	`DriveLinkData` Data for a drive link.
`chat_space_link_data`	`ChatSpaceLinkData` Data for a chat space link.
`meet_space_link_data`	`MeetSpaceLinkData` Data for a Meet space link.
`calendar_event_link_data`	`CalendarEventLinkData` Data for a Calendar event link.

RichLinkType

The rich link type. More types might be added in the future.

Enums
`RICH_LINK_TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`DRIVE_FILE`	A Google Drive rich link type.
`CHAT_SPACE`	A Chat space rich link type. For example, a space smart chip.
`MEET_SPACE`	A Meet message rich link type. For example, a Meet chip.
`CALENDAR_EVENT`	A Calendar message rich link type. For example, a Calendar chip.

SearchSpacesRequest

Request to search for a list of spaces based on a query.

فیلدها
`use_admin_access`	`bool` When `true` , the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` OAuth 2.0 scope . This method currently only supports admin access, thus only `true` is accepted for this field.
`page_size`	`int32` The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.
`page_token`	`string` A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
`query`	`string` مورد نیاز. A search query. You can search by using the following parameters: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` `create_time` and `last_active_time` accept a timestamp in RFC-3339 format and the supported comparison operators are: `=` , `<` , `>` , `<=` , `>=` . `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` ( `:` ) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name` . For example, `Fun Eve` matches `Fun event` or `The evening was fun` , but not `notFun event` or `even` . `external_user_allowed` accepts either `true` or `false` . `space_history_state` only accepts values from the `historyState` field of a `space` resource. `space_type` is required and the only valid value is `SPACE` . Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"` . Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name` , 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"` . The following example queries are valid: customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
`order_by`	`string` اختیاری. How the list of spaces is ordered. Supported attributes to order by are: `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. `create_time` — Denotes the time of the space creation. Valid ordering operation values are: `ASC` for ascending. مقدار پیش فرض `DESC` for descending. The supported syntax are: `membership_count.joined_direct_human_user_count DESC` `membership_count.joined_direct_human_user_count ASC` `last_active_time DESC` `last_active_time ASC` `create_time DESC` `create_time ASC`

SearchSpacesResponse

Response with a list of spaces corresponding to the search spaces request.

فیلدها

spaces[]

A page of the requested spaces.

next_page_token

string

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.

total_size

int32

The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.

SetUpSpaceRequest

Request to create a space and add specified users to it.

فیلدها

space

مورد نیاز. The Space.spaceType field is required.

To create a space, set Space.spaceType to SPACE and set Space.displayName . If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName . An existing space within the Google Workspace organization might already use this display name.

To create a group chat, set Space.spaceType to GROUP_CHAT . Don't set Space.displayName .

To create a 1:1 conversation between humans, set Space.spaceType to DIRECT_MESSAGE and set Space.singleUserBotDm to false . Don't set Space.displayName or Space.spaceDetails .

To create an 1:1 conversation between a human and the calling Chat app, set Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true . Don't set Space.displayName or Space.spaceDetails .

If a DIRECT_MESSAGE space already exists, that space is returned instead of creating a new space.

request_id

string

اختیاری. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

memberships[]

اختیاری. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically.

The set currently allows up to 49 memberships (in addition to the caller).

For human membership, the Membership.member field must contain a user with name populated (format: users/{user} ) and type set to User.Type.HUMAN . You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the user.name can be users/example@gmail.com . To invite Gmail users or users from external Google Workspace domains, user's email must be used for {user} .

For Google group membership, the Membership.group_member field must contain a group with name populated (format groups/{group} ). You can only add Google groups when setting Space.spaceType to SPACE .

Optional when setting Space.spaceType to SPACE .

Required when setting Space.spaceType to GROUP_CHAT , along with at least two memberships.

Required when setting Space.spaceType to DIRECT_MESSAGE with a human user, along with exactly one membership.

Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true ).

SlashCommand

Metadata about a slash command in Google Chat.

فیلدها

command_id

int64

The ID of the slash command.

SlashCommandMetadata

Annotation metadata for slash commands (/).

فیلدها
`bot`	`User` The Chat app whose command was invoked.
`type`	`Type` The type of slash command.
`command_name`	`string` The name of the invoked slash command.
`command_id`	`int64` The command ID of the invoked slash command.
`triggers_dialog`	`bool` Indicates whether the slash command is for a dialog.

تایپ کنید

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`ADD`	Add Chat app to space.
`INVOKE`	Invoke slash command in space.

فضا

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

فیلدها
`name`	`string` Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the `spaces.list()` method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA` , the space ID is `AAAAAAAAA` .
`type (deprecated)`	`Type` This item is deprecated! فقط خروجی Deprecated: Use `space_type` instead. The type of a space.
`space_type`	`SpaceType` اختیاری. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
`single_user_bot_dm`	`bool` اختیاری. Whether the space is a DM between a Chat app and a single human.
`threaded (deprecated)`	`bool` This item is deprecated! فقط خروجی Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
`display_name`	`string` اختیاری. The space's display name. Required when creating a space with a `spaceType` of `SPACE` . If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName` , try a different `displayName` . An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
`external_user_allowed`	`bool` اختیاری. تغییرناپذیر. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
`space_threading_state`	`SpaceThreadingState` فقط خروجی The threading state in the Chat space.
`space_details`	`SpaceDetails` اختیاری. Details about the space including description and rules.
`space_history_state`	`HistoryState` اختیاری. The message history state for messages and threads in this space.
`import_mode`	`bool` اختیاری. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode` requires user authentication .
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE` .
`last_active_time`	`Timestamp` فقط خروجی Timestamp of the last message in the space.
`admin_installed`	`bool` فقط خروجی For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
`membership_count`	`MembershipCount` فقط خروجی The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE` , `DIRECT_MESSAGE` or `GROUP_CHAT` .
`access_settings`	`AccessSettings` اختیاری. Specifies the access setting of the space. Only populated when the `space_type` is `SPACE` .
`space_uri`	`string` فقط خروجی The URI for a user to access the space.
`import_mode_expire_time`	`Timestamp` فقط خروجی The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport` . This field is only populated for spaces that were created with import mode.
`customer`	`string` اختیاری. تغییرناپذیر. The customer id of the domain of the space. Required only when creating a space with app authentication and `SpaceType` is `SPACE` , otherwise should not be set. In the format `customers/{customer}` , where `customer` is the `id` from the Admin SDK customer resource . Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated.
Union field `space_permission_settings` . Represents the permission settings of a space. Only populated when the `space_type` is `SPACE` . `space_permission_settings` can be only one of the following:
`predefined_permission_settings`	`PredefinedPermissionSettings` اختیاری. فقط ورودی Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: App authentication with administrator approval with the `chat.app.spaces` or `chat.app.spaces.create` scopes. احراز هویت کاربر
`permission_settings`	`PermissionSettings` اختیاری. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: App authentication with administrator approval with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. احراز هویت کاربر

AccessSettings

Represents the access setting of the space.

فیلدها

access_state

AccessState

فقط خروجی Indicates the access state of the space.

audience

string

اختیاری. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience .

Format: audiences/{audience}

To use the default target audience for the Google Workspace organization, set to audiences/default .

Reading the target audience supports:

احراز هویت کاربر
App authentication with administrator approval with the chat.app.spaces scope.

This field is not populated when using the chat.bot scope with app authentication .

Setting the target audience requires user authentication .

AccessState

Represents the access state of the space.

Enums

ACCESS_STATE_UNSPECIFIED Access state is unknown or not supported in this API.

PRIVATE Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.

DISCOVERABLE

A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see Make a space discoverable to specific users .

Creating discoverable spaces requires user authentication .

MembershipCount

Represents the count of memberships of a space, grouped into categories.

فیلدها

joined_direct_human_user_count

int32

فقط خروجی Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.

joined_group_count

int32

فقط خروجی Count of all groups that have directly joined the space.

PermissionSetting

Represents a space permission setting.

فیلدها

managers_allowed

bool

اختیاری. Whether space owners ( ROLE_MANAGER ) have this permission.

members_allowed

bool

اختیاری. Whether basic space members ( ROLE_MEMBER ) have this permission.

PermissionSettings

Permission settings that you can specify when updating an existing named space.

To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

فیلدها
`manage_members_and_groups`	`PermissionSetting` اختیاری. Setting for managing members and groups in a space.
`modify_space_details`	`PermissionSetting` اختیاری. Setting for updating space name, avatar, description and guidelines.
`toggle_history`	`PermissionSetting` اختیاری. Setting for toggling space history on and off.
`use_at_mention_all`	`PermissionSetting` اختیاری. Setting for using @all in a space.
`manage_apps`	`PermissionSetting` اختیاری. Setting for managing apps in a space.
`manage_webhooks`	`PermissionSetting` اختیاری. Setting for managing webhooks in a space.
`post_messages`	`PermissionSetting` فقط خروجی Setting for posting messages in a space.
`reply_messages`	`PermissionSetting` اختیاری. Setting for replying to messages in a space.

PredefinedPermissionSettings

Predefined permission settings that you can only specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about spaces .

Enums
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	نامشخص استفاده نکنید.
`COLLABORATION_SPACE`	Setting to make the space a collaboration space where all members can post messages.
`ANNOUNCEMENT_SPACE`	Setting to make the space an announcement space where only space managers can post messages.

SpaceDetails

Details about the space including description and rules.

فیلدها

description

string

اختیاری. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants.

Supports up to 150 characters.

guidelines

string

اختیاری. The space's rules, expectations, and etiquette.

Supports up to 5,000 characters.

SpaceThreadingState

Specifies the type of threading state in the Chat space.

Enums
`SPACE_THREADING_STATE_UNSPECIFIED`	رزرو شده است.
`THREADED_MESSAGES`	Named spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message.
`GROUPED_MESSAGES`	Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.
`UNTHREADED_MESSAGES`	Direct messages (DMs) between two people and group conversations between 3 or more people.

SpaceType

The type of space. Required when creating or updating a space. Output only for other usage.

Enums
`SPACE_TYPE_UNSPECIFIED`	رزرو شده است.
`SPACE`	A place where people send messages, share files, and collaborate. A `SPACE` can include Chat apps.
`GROUP_CHAT`	Group conversations between 3 or more people. A `GROUP_CHAT` can include Chat apps.
`DIRECT_MESSAGE`	1:1 messages between two humans or a human and a Chat app.

تایپ کنید

Deprecated: Use SpaceType instead.

Enums
`TYPE_UNSPECIFIED`	رزرو شده است.
`ROOM`	Conversations between two or more humans.
`DM`	1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans.

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

فیلدها

spaces[]

SpaceUpdatedEventData

A list of updated spaces.

SpaceEvent

An event that represents a change or activity in a Google Chat space. برای کسب اطلاعات بیشتر ، به کار با رویدادهای Google Chat مراجعه کنید.

فیلدها
`name`	`string` Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Time when the event occurred.
`event_type`	`string` Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for messages : New message: `google.workspace.chat.message.v1.created` Updated message: `google.workspace.chat.message.v1.updated` Deleted message: `google.workspace.chat.message.v1.deleted` Multiple new messages: `google.workspace.chat.message.v1.batchCreated` Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for memberships : New membership: `google.workspace.chat.membership.v1.created` Updated membership: `google.workspace.chat.membership.v1.updated` Deleted membership: `google.workspace.chat.membership.v1.deleted` Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for reactions : New reaction: `google.workspace.chat.reaction.v1.created` Deleted reaction: `google.workspace.chat.reaction.v1.deleted` Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the space : Updated space: `google.workspace.chat.space.v1.updated` Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`
Union field `payload` . `payload` can be only one of the following:
`message_created_event_data`	`MessageCreatedEventData` Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

The notification setting of a user in a space.

فیلدها

name

string

Identifier. The resource name of the space notification setting. Format: users/{user}/spaces/{space}/spaceNotificationSetting .

notification_setting

NotificationSetting

The notification setting.

mute_setting

MuteSetting

The space notification mute setting.

MuteSetting

The space notification mute setting types.

Enums
`MUTE_SETTING_UNSPECIFIED`	رزرو شده است.
`UNMUTED`	The user will receive notifications for the space based on the notification setting.
`MUTED`	The user will not receive any notifications for the space, regardless of the notification setting.

NotificationSetting

The notification setting types. Other types might be supported in the future.

Enums
`NOTIFICATION_SETTING_UNSPECIFIED`	رزرو شده است.
`ALL`	Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user.
`MAIN_CONVERSATIONS`	The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages.
`FOR_YOU`	The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages.
`OFF`	Notification is off.

SpaceReadState

A user's read state within a space, used to identify read and unread messages.

فیلدها

name

string

Resource name of the space read state.

Format: users/{user}/spaces/{space}/spaceReadState

last_read_time

اختیاری. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.

SpaceUpdatedEventData

Event payload for an updated space.

Event type: google.workspace.chat.space.v1.updated

فیلدها

space

The updated space.

موضوع

A thread in a Google Chat space. For example usage, see Start or reply to a message thread .

If you specify a thread when creating a message, you can set the messageReplyOption field to determine what happens if no matching thread is found.

فیلدها

name

string

Identifier. Resource name of the thread.

Example: spaces/{space}/threads/{thread}

thread_key

string

اختیاری. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters.

This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread name field instead.

ThreadReadState

A user's read state within a thread, used to identify read and unread messages.

فیلدها

name

string

Resource name of the thread read state.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.

UpdateMembershipRequest

Request message for updating a membership.

فیلدها

membership

مورد نیاز. The membership to update. Only fields specified by update_mask are updated.

update_mask

مورد نیاز. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

role

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

UpdateMessageRequest

Request to update a message.

فیلدها

message

Message

مورد نیاز. Message with fields updated.

update_mask

SpaceNotificationSetting

مورد نیاز. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

text
attachment
cards (Requires app authentication .)
cards_v2 (Requires app authentication .)
accessory_widgets (Requires app authentication .)
quoted_message_metadata (Only allows removal of the quoted message.)

allow_missing

bool

اختیاری. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

UpdateSpaceNotificationSettingRequest

Request to update the space notification settings. Only supports updating notification setting for the calling user.

فیلدها

space_notification_setting

مورد نیاز. The resource name for the space notification settings must be populated in the form of users/{user}/spaces/{space}/spaceNotificationSetting . Only fields specified by update_mask are updated.

update_mask

مورد نیاز. Supported field paths:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

فیلدها

space_read_state

SpaceReadState

مورد نیاز. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

The me alias. For example, users/me/spaces/{space}/spaceReadState .
Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState .
Their user id. For example, users/123456789/spaces/{space}/spaceReadState .

Format: users/{user}/spaces/{space}/spaceReadState

update_mask

مورد نیاز. The field paths to update. Currently supported field paths:

last_read_time

When the last_read_time is before the latest message create time, the space appears as unread in the UI.

To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.

UpdateSpaceRequest

A request to update a single space.

فیلدها

space

مورد نیاز. Space with fields to be updated. Space.name must be populated in the form of spaces/{space} . Only fields specified by update_mask are updated.

update_mask

مورد نیاز. The updated field paths, comma separated if there are multiple.

You can update the following fields for a space:

space_details : Updates the space's description. Supports up to 150 characters.

display_name : Only supports updating the display name for spaces where spaceType field is SPACE . If you receive the error message ALREADY_EXISTS , try a different value. An existing space within the Google Workspace organization might already use this display name.

space_type : Only supports changing a GROUP_CHAT space type to SPACE . Include display_name together with space_type in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the space_type mask and the SPACE type in the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an invalid argument error. space_type is not supported with useAdminAccess .

space_history_state : Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. space_history_state is not supported with useAdminAccess .

access_settings.audience : Updates the access setting of who can discover the space, join the space, and preview the messages in named space where spaceType field is SPACE . If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode . To learn more, see Make a space discoverable to specific users . access_settings.audience is not supported with useAdminAccess .

permission_settings : Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess . The supported field masks include:

permission_settings.manageMembersAndGroups
permission_settings.modifySpaceDetails
permission_settings.toggleHistory
permission_settings.useAtMentionAll
permission_settings.manageApps
permission_settings.manageWebhooks
permission_settings.replyMessages

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.spaces OAuth 2.0 scope .

Some FieldMask values are not supported using admin access. For details, see the description of update_mask .

کاربر

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user , the output for a User resource only populates the user's name and type .

فیلدها
`name`	`string` Resource name for a Google Chat `user` . Format: `users/{user}` . `users/app` can be used as an alias for the calling app `bot` user. For `human users` , `{user}` is the same user identifier as: the `id` for the Person in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. the `id` for a user in the Admin SDK Directory API. the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789` , you can use `users/user@example.com` as an alias to reference `users/123456789` . Only the canonical resource name (for example `users/123456789` ) will be returned from the API.
`display_name`	`string` فقط خروجی The user's display name.
`domain_id`	`string` Unique identifier of the user's Google Workspace domain.
`type`	`Type` User type.
`is_anonymous`	`bool` فقط خروجی When `true` , the user is deleted or their profile is not visible.

تایپ کنید

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`HUMAN`	Human user.
`BOT`	Chat app user.

UserMentionMetadata

Annotation metadata for user mentions (@).

فیلدها

user

User

The user mentioned.

type

Type

The type of user mention.

تایپ کنید

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`ADD`	Add user to space.
`MENTION`	Mention user in space.

WidgetMarkup

A widget is a UI element that presents text and images.

فیلدها
`buttons[]`	`Button` A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.
Union field `data` . A `WidgetMarkup` can only have one of the following items. You can use multiple `WidgetMarkup` fields to display more items. `data` can be only one of the following:
`text_paragraph`	`TextParagraph` Display a text paragraph in this widget.
`image`	`Image` Display an image in this widget.
`key_value`	`KeyValue` Display a key value item in this widget.

دکمه

یک دکمه Can be a text button or an image button.

فیلدها

Union field type .

type can be only one of the following:

text_button

TextButton

A button with text and onclick action.

image_button

ImageButton

A button with image and onclick action.

FormAction

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

فیلدها

action_method_name

string

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

parameters[]

ActionParameter

List of action parameters.

ActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use action method = snooze() , passing the snooze type and snooze time in the list of string parameters.

فیلدها

key

string

The name of the parameter for the action script.

value

string

The value of the parameter.

نماد

The set of supported icons.

Enums
`ICON_UNSPECIFIED`
`AIRPLANE`
`BOOKMARK`
`BUS`
`CAR`
`CLOCK`
`CONFIRMATION_NUMBER_ICON`
`DOLLAR`
`DESCRIPTION`
`EMAIL`
`EVENT_PERFORMER`
`EVENT_SEAT`
`FLIGHT_ARRIVAL`
`FLIGHT_DEPARTURE`
`HOTEL`
`HOTEL_ROOM_TYPE`
`INVITE`
`MAP_PIN`
`MEMBERSHIP`
`MULTIPLE_PEOPLE`
`OFFER`
`PERSON`
`PHONE`
`RESTAURANT_ICON`
`SHOPPING_CART`
`STAR`
`STORE`
`TICKET`
`TRAIN`
`VIDEO_CAMERA`
`VIDEO_PLAY`

تصویر

An image that's specified by a URL and can have an onclick action.

فیلدها

image_url

string

The URL of the image.

on_click

The onclick action.

aspect_ratio

double

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

دکمه تصویر

An image button with an onclick action.

فیلدها
`on_click`	`OnClick` The `onclick` action.
`name`	`string` The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.
Union field `icons` . The icon can be specified by an `Icon` `enum` or a URL. `icons` can be only one of the following:
`icon`	`Icon` The icon specified by an `enum` that indices to an icon provided by Chat API.
`icon_url`	`string` The icon specified by a URL.

KeyValue

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

فیلدها
`top_label`	`string` The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
`content`	`string` The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
`content_multiline`	`bool` If the content should be multiline.
`bottom_label`	`string` The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
`on_click`	`OnClick` The `onclick` action. Only the top label, bottom label, and content region are clickable.
Union field `icons` . At least one of icons, `top_label` and `bottom_label` must be defined. `icons` can be only one of the following:
`icon`	`Icon` An enum value that's replaced by the Chat API with the corresponding icon image.
`icon_url`	`string` The icon specified by a URL.
Union field `control` . A control widget. You can set either `button` or `switch_widget` , but not both. `control` can be only one of the following:
`button`	`Button` A button that can be clicked to trigger an action.

OnClick

An onclick action (for example, open a link).

فیلدها

Union field data .

data can be only one of the following:

action

FormAction

A form action is triggered by this onclick action if specified.

open_link

OpenLink

This onclick action triggers an open link action if specified.

OpenLink

A link that opens a new window.

فیلدها

url

string

The URL to open.

دکمه متن

A button with text and onclick action.

فیلدها

text

string

The text of the button.

on_click

The onclick action of the button.

TextParagraph

A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

فیلدها
`text`	`string`

شاخص

ChatService (interface)
AccessoryWidget (message)
ActionResponse (message)
ActionResponse.ResponseType (enum)
ActionResponse.SelectionItems (message)
ActionResponse.UpdatedWidget (message)
ActionStatus (message)
Annotation (message)
AnnotationType (enum)
AppCommandMetadata (message)
AppCommandMetadata.AppCommandType (enum)
AttachedGif (message)
Attachment (message)
Attachment.Source (enum)
AttachmentDataRef (message)
CalendarEventLinkData (message)
CardWithId (message)
ChatSpaceLinkData (message)
CompleteImportSpaceRequest (message)
CompleteImportSpaceResponse (message)
ContextualAddOnMarkup (message)
ContextualAddOnMarkup.Card (message)
ContextualAddOnMarkup.Card.CardAction (message)
ContextualAddOnMarkup.Card.CardHeader (message)
ContextualAddOnMarkup.Card.CardHeader.ImageStyle (enum)
ContextualAddOnMarkup.Card.Section (message)
CreateCustomEmojiRequest (message)
CreateMembershipRequest (message)
CreateMessageRequest (message)
CreateMessageRequest.MessageReplyOption (enum)
CreateReactionRequest (message)
CreateSpaceRequest (message)
CustomEmoji (message)
CustomEmoji.CustomEmojiPayload (message)
CustomEmojiMetadata (message)
DeleteCustomEmojiRequest (message)
DeleteMembershipRequest (message)
DeleteMessageRequest (message)
DeleteReactionRequest (message)
DeleteSpaceRequest (message)
DeletionMetadata (message)
DeletionMetadata.DeletionType (enum)
Dialog (message)
DialogAction (message)
DriveDataRef (message)
DriveLinkData (message)
Emoji (message)
EmojiReactionSummary (message)
FindDirectMessageRequest (message)
GetAttachmentRequest (message)
GetCustomEmojiRequest (message)
GetMembershipRequest (message)
GetMessageRequest (message)
GetSpaceEventRequest (message)
GetSpaceNotificationSettingRequest (message)
GetSpaceReadStateRequest (message)
GetSpaceRequest (message)
GetThreadReadStateRequest (message)
Group (message)
HistoryState (enum)
ListCustomEmojisRequest (message)
ListCustomEmojisResponse (message)
ListMembershipsRequest (message)
ListMembershipsResponse (message)
ListMessagesRequest (message)
ListMessagesResponse (message)
ListReactionsRequest (message)
ListReactionsResponse (message)
ListSpaceEventsRequest (message)
ListSpaceEventsResponse (message)
ListSpacesRequest (message)
ListSpacesResponse (message)
MatchedUrl (message)
MeetSpaceLinkData (message)
MeetSpaceLinkData.HuddleStatus (enum)
MeetSpaceLinkData.Type (enum)
Membership (message)
Membership.MembershipRole (enum)
Membership.MembershipState (enum)
MembershipBatchCreatedEventData (message)
MembershipBatchDeletedEventData (message)
MembershipBatchUpdatedEventData (message)
MembershipCreatedEventData (message)
MembershipDeletedEventData (message)
MembershipUpdatedEventData (message)
Message (message)
MessageBatchCreatedEventData (message)
MessageBatchDeletedEventData (message)
MessageBatchUpdatedEventData (message)
MessageCreatedEventData (message)
MessageDeletedEventData (message)
MessageUpdatedEventData (message)
QuotedMessageMetadata (message)
Reaction (message)
ReactionBatchCreatedEventData (message)
ReactionBatchDeletedEventData (message)
ReactionCreatedEventData (message)
ReactionDeletedEventData (message)
RichLinkMetadata (message)
RichLinkMetadata.RichLinkType (enum)
SearchSpacesRequest (message)
SearchSpacesResponse (message)
SetUpSpaceRequest (message)
SlashCommand (message)
SlashCommandMetadata (message)
SlashCommandMetadata.Type (enum)
Space (message)
Space.AccessSettings (message)
Space.AccessSettings.AccessState (enum)
Space.MembershipCount (message)
Space.PermissionSetting (message)
Space.PermissionSettings (message)
Space.PredefinedPermissionSettings (enum)
Space.SpaceDetails (message)
Space.SpaceThreadingState (enum)
Space.SpaceType (enum)
Space.Type (enum)
SpaceBatchUpdatedEventData (message)
SpaceEvent (message)
SpaceNotificationSetting (message)
SpaceNotificationSetting.MuteSetting (enum)
SpaceNotificationSetting.NotificationSetting (enum)
SpaceReadState (message)
SpaceUpdatedEventData (message)
Thread (message)
ThreadReadState (message)
UpdateMembershipRequest (message)
UpdateMessageRequest (message)
UpdateSpaceNotificationSettingRequest (message)
UpdateSpaceReadStateRequest (message)
UpdateSpaceRequest (message)
User (message)
User.Type (enum)
UserMentionMetadata (message)
UserMentionMetadata.Type (enum)
WidgetMarkup (message)
WidgetMarkup.Button (message)
WidgetMarkup.FormAction (message)
WidgetMarkup.FormAction.ActionParameter (message)
WidgetMarkup.Icon (enum)
WidgetMarkup.Image (message)
WidgetMarkup.ImageButton (message)
WidgetMarkup.KeyValue (message)
WidgetMarkup.OnClick (message)
WidgetMarkup.OpenLink (message)
WidgetMarkup.TextButton (message)
WidgetMarkup.TextParagraph (message)

ChatService

Enables developers to build Chat apps and integrations on Google Chat Platform.

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse )

Completes the import process for the specified space and makes it visible to users.

Requires user authentication and domain-wide delegation with the authorization scope :

https://www.googleapis.com/auth/chat.import

For more information, see Authorize Google Chat apps to import data .

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.import

For more information, see the Authorization guide .

CreateCustomEmoji

rpc CreateCustomEmoji( CreateCustomEmojiRequest ) returns ( CustomEmoji )

Creates a custom emoji.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions .

Requires user authentication with the authorization scope :

https://www.googleapis.com/auth/chat.customemojis

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.customemojis

For more information, see the Authorization guide .

CreateMembership

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership )

Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space.

Supports the following types of authentication :

App authentication with administrator approval and the authorization scope:
- https://www.googleapis.com/auth/chat.app.memberships
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.memberships
- https://www.googleapis.com/auth/chat.memberships.app (to add the calling app to the space)
- https://www.googleapis.com/auth/chat.import (import mode spaces only)
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and the following authorization scope is used:
  - https://www.googleapis.com/auth/chat.admin.memberships

App authentication is not supported for the following use cases:

Inviting users external to the Workspace organization that owns the space.
Adding a Google Group to a space.
Adding a Chat app to a space.

For example usage, see:

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.admin.memberships
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.app

For more information, see the Authorization guide .

CreateMessage

rpc CreateMessage( CreateMessageRequest ) returns ( Message )

Creates a message in a Google Chat space. For an example, see Send a message .

Supports the following types of authentication :

App authentication with the authorization scope:
- https://www.googleapis.com/auth/chat.bot
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.messages.create
- https://www.googleapis.com/auth/chat.messages
- https://www.googleapis.com/auth/chat.import (import mode spaces only)

Chat attributes the message sender differently depending on the type of authentication that you use in your request.

The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text ( text ), cards ( cardsV2 ), and accessory widgets ( accessoryWidgets ).

Message sent with app authentication

The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text ( text ).

Message sent with user authentication

The maximum message size, including the message contents, is 32,000 bytes.

For webhook requests, the response doesn't contain the full message. The response only populates the name and thread.name fields in addition to the information that was in the request.

Authorization scopes

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

https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.create

For more information, see the Authorization guide .

CreateReaction

rpc CreateReaction( CreateReactionRequest ) returns ( Reaction )

Creates a reaction and adds it to a message. For an example, see Add a reaction to a message .

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.messages.reactions.create
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.import (import mode spaces only)

Authorization scopes

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

https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.create

For more information, see the Authorization guide .

CreateSpace

rpc CreateSpace( CreateSpaceRequest ) returns ( Space )

Creates a space. Can be used to create a named space, or a group chat in Import mode . For an example, see Create a space .

Supports the following types of authentication :

App authentication with administrator approval and one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.app.spaces.create
- https://www.googleapis.com/auth/chat.app.spaces
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces.create
- https://www.googleapis.com/auth/chat.spaces
- https://www.googleapis.com/auth/chat.import (import mode spaces only)

When authenticating as an app, the space.customer field must be set in the request.

When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set space.permission_settings.manage_apps to managers_allowed .

Space membership upon creation depends on whether the space is created in Import mode :

Import mode: No members are created.
All other modes: The calling user is added as a member. این است:
- The app itself when using app authentication.
- The human user when using user authentication.

If you receive the error message ALREADY_EXISTS when creating a space, try a different displayName . An existing space within the Google Workspace organization might already use this display name.

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.spaces.create
https://www.googleapis.com/auth/chat.app.spaces
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create

For more information, see the Authorization guide .

DeleteCustomEmoji

rpc DeleteCustomEmoji( DeleteCustomEmojiRequest ) returns ( Empty )

Deletes a custom emoji. By default, users can only delete custom emoji they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. See Learn about custom emojis in Google Chat .

Requires user authentication with the authorization scope :

https://www.googleapis.com/auth/chat.customemojis

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.customemojis

For more information, see the Authorization guide .

DeleteMembership

rpc DeleteMembership( DeleteMembershipRequest ) returns ( Membership )

Deletes a membership. For an example, see Remove a user or a Google Chat app from a space .

Supports the following types of authentication :

App authentication with administrator approval and the authorization scope:
- https://www.googleapis.com/auth/chat.app.memberships
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.memberships
- https://www.googleapis.com/auth/chat.memberships.app (to remove the calling app from the space)
- https://www.googleapis.com/auth/chat.import (import mode spaces only)
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and the following authorization scope is used:
  - https://www.googleapis.com/auth/chat.admin.memberships

App authentication is not supported for the following use cases:

Removing a Google Group from a space.
Removing a Chat app from a space.

To delete memberships for space managers, the requester must be a space manager. If you're using app authentication the Chat app must be the space creator.

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.admin.memberships
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.app

For more information, see the Authorization guide .

DeleteMessage

rpc DeleteMessage( DeleteMessageRequest ) returns ( Empty )

Deletes a message. For an example, see Delete a message .

Supports the following types of authentication :

App authentication with the authorization scope:
- https://www.googleapis.com/auth/chat.bot
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.messages
- https://www.googleapis.com/auth/chat.import (import mode spaces only)

When using app authentication, requests can only delete messages created by the calling Chat app.

Authorization scopes

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

https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages

For more information, see the Authorization guide .

DeleteReaction

rpc DeleteReaction( DeleteReactionRequest ) returns ( Empty )

Deletes a reaction to a message. For an example, see Delete a reaction .

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.import (import mode spaces only)

Authorization scopes

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

https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.reactions

For more information, see the Authorization guide .

DeleteSpace

rpc DeleteSpace( DeleteSpaceRequest ) returns ( Empty )

Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space .

Supports the following types of authentication :

App authentication with administrator approval and the authorization scope:
- https://www.googleapis.com/auth/chat.app.delete (only in spaces the app created)
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.delete
- https://www.googleapis.com/auth/chat.import (import mode spaces only)
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and the following authorization scope is used:
  - https://www.googleapis.com/auth/chat.admin.delete

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.delete
https://www.googleapis.com/auth/chat.admin.delete
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.delete

For more information, see the Authorization guide .

FindDirectMessage

rpc FindDirectMessage( FindDirectMessageRequest ) returns ( Space )

Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND error. For an example, see Find a direct message .

With app authentication , returns the direct message space between the specified user and the calling Chat app.

With user authentication , returns the direct message space between the specified user and the authenticated user.

Supports the following types of authentication :

App authentication with the authorization scope:
- https://www.googleapis.com/auth/chat.bot
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces.readonly
- https://www.googleapis.com/auth/chat.spaces

Authorization scopes

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

https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.bot

For more information, see the Authorization guide .

GetAttachment

rpc GetAttachment( GetAttachmentRequest ) returns ( Attachment )

Gets the metadata of a message attachment. The attachment data is fetched using the media API . For an example, see Get metadata about a message attachment .

Requires app authentication with the authorization scope :

https://www.googleapis.com/auth/chat.bot

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.bot

For more information, see the Authorization guide .

GetCustomEmoji

rpc GetCustomEmoji( GetCustomEmojiRequest ) returns ( CustomEmoji )

Returns details about a custom emoji.

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.customemojis.readonly
https://www.googleapis.com/auth/chat.customemojis

Authorization scopes

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

https://www.googleapis.com/auth/chat.customemojis
https://www.googleapis.com/auth/chat.customemojis.readonly

For more information, see the Authorization guide .

GetMembership

rpc GetMembership( GetMembershipRequest ) returns ( Membership )

Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership .

Supports the following types of authentication :

App authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.bot
- https://www.googleapis.com/auth/chat.app.memberships (requires administrator approval )
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.memberships.readonly
- https://www.googleapis.com/auth/chat.memberships
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and one of the following authorization scopes is used:
  - https://www.googleapis.com/auth/chat.admin.memberships.readonly
  - https://www.googleapis.com/auth/chat.admin.memberships

Authorization scopes

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

https://www.googleapis.com/auth/chat.admin.memberships
https://www.googleapis.com/auth/chat.admin.memberships.readonly
https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly

For more information, see the Authorization guide .

GetMessage

rpc GetMessage( GetMessageRequest ) returns ( Message )

Returns details about a message. For an example, see Get details about a message .

Supports the following types of authentication :

App authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.bot : When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and slash commands that invoke the Chat app.
- https://www.googleapis.com/auth/chat.app.messages.readonly with administrator approval (available in Developer Preview ). When using this authentication scope, this method returns details about a public message in a space.
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.messages.readonly
- https://www.googleapis.com/auth/chat.messages

Note: Might return a message from a blocked member or space.

Authorization scopes

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

https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.app.messages.readonly

For more information, see the Authorization guide .

GetSpace

rpc GetSpace( GetSpaceRequest ) returns ( Space )

Returns details about a space. For an example, see Get details about a space .

Supports the following types of authentication :

App authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.bot
- https://www.googleapis.com/auth/chat.app.spaces with administrator approval
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces.readonly
- https://www.googleapis.com/auth/chat.spaces
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and one of the following authorization scopes is used:
  - https://www.googleapis.com/auth/chat.admin.spaces.readonly
  - https://www.googleapis.com/auth/chat.admin.spaces

App authentication has the following limitations:

space.access_settings is only populated when using the chat.app.spaces scope.
space.predefind_permission_settings and space.permission_settings are only populated when using the chat.app.spaces scope, and only for spaces the app created.

Authorization scopes

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

https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.app.spaces

For more information, see the Authorization guide .

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent )

Returns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Message resource in the event payload.

Note: The permissionSettings field is not returned in the Space object of the Space event data for this request.

Supports the following types of authentication with an authorization scope appropriate for reading the requested data:

App authentication with administrator approval in Developer Preview with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.app.spaces
- https://www.googleapis.com/auth/chat.app.messages.readonly
- https://www.googleapis.com/auth/chat.app.memberships
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces.readonly
- https://www.googleapis.com/auth/chat.spaces
- https://www.googleapis.com/auth/chat.messages.readonly
- https://www.googleapis.com/auth/chat.messages
- https://www.googleapis.com/auth/chat.messages.reactions.readonly
- https://www.googleapis.com/auth/chat.messages.reactions
- https://www.googleapis.com/auth/chat.memberships.readonly
- https://www.googleapis.com/auth/chat.memberships

To get an event, the authenticated caller must be a member of the space.

For an example, see Get details about an event from a Google Chat space .

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.app.messages.readonly
https://www.googleapis.com/auth/chat.app.spaces
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.readonly

For more information, see the Authorization guide .

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting( GetSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting )

Gets the space notification setting. For an example, see Get the caller's space notification setting .

Requires user authentication with the authorization scope :

https://www.googleapis.com/auth/chat.users.spacesettings

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.users.spacesettings

For more information, see the Authorization guide .

GetSpaceReadState

rpc GetSpaceReadState( GetSpaceReadStateRequest ) returns ( SpaceReadState )

Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see Get details about a user's space read state .

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.users.readstate.readonly
https://www.googleapis.com/auth/chat.users.readstate

Authorization scopes

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

https://www.googleapis.com/auth/chat.users.readstate
https://www.googleapis.com/auth/chat.users.readstate.readonly

For more information, see the Authorization guide .

GetThreadReadState

rpc GetThreadReadState( GetThreadReadStateRequest ) returns ( ThreadReadState )

Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see Get details about a user's thread read state .

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.users.readstate.readonly
https://www.googleapis.com/auth/chat.users.readstate

Authorization scopes

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

https://www.googleapis.com/auth/chat.users.readstate
https://www.googleapis.com/auth/chat.users.readstate.readonly

For more information, see the Authorization guide .

ListCustomEmojis

rpc ListCustomEmojis( ListCustomEmojisRequest ) returns ( ListCustomEmojisResponse )

Lists custom emojis visible to the authenticated user.

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.customemojis.readonly
https://www.googleapis.com/auth/chat.customemojis

Authorization scopes

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

https://www.googleapis.com/auth/chat.customemojis
https://www.googleapis.com/auth/chat.customemojis.readonly

For more information, see the Authorization guide .

ListMemberships

rpc ListMemberships( ListMembershipsRequest ) returns ( ListMembershipsResponse )

Lists memberships in a space. For an example, see List users and Google Chat apps in a space . Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to.

Supports the following types of authentication :

App authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.bot
- https://www.googleapis.com/auth/chat.app.memberships (requires administrator approval )
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.memberships.readonly
- https://www.googleapis.com/auth/chat.memberships
- https://www.googleapis.com/auth/chat.import (import mode spaces only)
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and one of the following authorization scopes is used:
  - https://www.googleapis.com/auth/chat.admin.memberships.readonly
  - https://www.googleapis.com/auth/chat.admin.memberships

Authorization scopes

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

https://www.googleapis.com/auth/chat.admin.memberships
https://www.googleapis.com/auth/chat.admin.memberships.readonly
https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly

For more information, see the Authorization guide .

ListMessages

rpc ListMessages( ListMessagesRequest ) returns ( ListMessagesResponse )

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, {} . For an example, see List messages .

Supports the following types of authentication :

App authentication with administrator approval in Developer Preview with the authorization scope:
- https://www.googleapis.com/auth/chat.app.messages.readonly . When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages.
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.messages.readonly
- https://www.googleapis.com/auth/chat.messages
- https://www.googleapis.com/auth/chat.import (import mode spaces only)

Authorization scopes

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

https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.app.messages.readonly

For more information, see the Authorization guide .

ListReactions

rpc ListReactions( ListReactionsRequest ) returns ( ListReactionsResponse )

Lists reactions to a message. For an example, see List reactions for a message .

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.messages.reactions.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.messages

Authorization scopes

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

https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.readonly

For more information, see the Authorization guide .

ListSpaceEvents

rpc ListSpaceEvents( ListSpaceEventsRequest ) returns ( ListSpaceEventsResponse )

Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership resource.

Supports the following types of authentication with an authorization scope appropriate for reading the requested data:

App authentication with administrator approval in Developer Preview with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.app.spaces
- https://www.googleapis.com/auth/chat.app.messages.readonly
- https://www.googleapis.com/auth/chat.app.memberships
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces.readonly
- https://www.googleapis.com/auth/chat.spaces
- https://www.googleapis.com/auth/chat.messages.readonly
- https://www.googleapis.com/auth/chat.messages
- https://www.googleapis.com/auth/chat.messages.reactions.readonly
- https://www.googleapis.com/auth/chat.messages.reactions
- https://www.googleapis.com/auth/chat.memberships.readonly
- https://www.googleapis.com/auth/chat.memberships

To list events, the authenticated caller must be a member of the space.

For an example, see List events from a Google Chat space .

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.app.messages.readonly
https://www.googleapis.com/auth/chat.app.spaces
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.readonly

For more information, see the Authorization guide .

ListSpaces

rpc ListSpaces( ListSpacesRequest ) returns ( ListSpacesResponse )

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces .

Supports the following types of authentication :

App authentication with the authorization scope:
- https://www.googleapis.com/auth/chat.bot
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces.readonly
- https://www.googleapis.com/auth/chat.spaces

To list all named spaces by Google Workspace organization, use the spaces.search() method using Workspace administrator privileges instead.

Authorization scopes

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

https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.bot

For more information, see the Authorization guide .

SearchSpaces

rpc SearchSpaces( SearchSpacesRequest ) returns ( SearchSpacesResponse )

Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, set use_admin_access to true . For an example, see Search for and manage spaces .

Requires user authentication with administrator privileges and one of the following authorization scopes :

https://www.googleapis.com/auth/chat.admin.spaces.readonly
https://www.googleapis.com/auth/chat.admin.spaces

Authorization scopes

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

https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly

For more information, see the Authorization guide .

SetUpSpace

rpc SetUpSpace( SetUpSpaceRequest ) returns ( Space )

Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members .

To specify the human members to add, add memberships with the appropriate membership.member.name . To add a human user, use users/{user} , where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789 , you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789 .

To specify the Google groups to add, add memberships with the appropriate membership.group_member.name . To add or invite a Google group, use groups/{group} , where {group} is the id for the group from the Cloud Identity Groups API. For example, you can use Cloud Identity Groups lookup API to retrieve the ID 123456789 for group email group@example.com , then you can add the group to the space by setting the membership.group_member.name to groups/123456789 . Group email is not supported, and Google groups can only be added as members in named spaces.

For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space.

To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created.

To create a DM between the calling user and the calling app, set Space.singleUserBotDm to true and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or add a user or app to a space .

If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned.

Spaces with threaded replies aren't supported. If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName . An existing space within the Google Workspace organization might already use this display name.

Requires user authentication with one of the following authorization scopes :

https://www.googleapis.com/auth/chat.spaces.create
https://www.googleapis.com/auth/chat.spaces

Authorization scopes

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

https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create

For more information, see the Authorization guide .

UpdateMembership

rpc UpdateMembership( UpdateMembershipRequest ) returns ( Membership )

Updates a membership. For an example, see Update a user's membership in a space .

Supports the following types of authentication :

App authentication with administrator approval and the authorization scope:
- https://www.googleapis.com/auth/chat.app.memberships (only in spaces the app created)
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.memberships
- https://www.googleapis.com/auth/chat.import (import mode spaces only)
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and the following authorization scope is used:
  - https://www.googleapis.com/auth/chat.admin.memberships

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.memberships
https://www.googleapis.com/auth/chat.admin.memberships
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.memberships

For more information, see the Authorization guide .

UpdateMessage

rpc UpdateMessage( UpdateMessageRequest ) returns ( Message )

Updates a message. There's a difference between the patch and update methods. The patch method uses a patch request while the update method uses a put request. We recommend using the patch method. For an example, see Update a message .

Supports the following types of authentication :

App authentication with the authorization scope:
- https://www.googleapis.com/auth/chat.bot
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.messages
- https://www.googleapis.com/auth/chat.import (import mode spaces only)

When using app authentication, requests can only update messages created by the calling Chat app.

Authorization scopes

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

https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages

For more information, see the Authorization guide .

UpdateSpace

rpc UpdateSpace( UpdateSpaceRequest ) returns ( Space )

Updates a space. For an example, see Update a space .

If you're updating the displayName field and receive the error message ALREADY_EXISTS , try a different display name.. An existing space within the Google Workspace organization might already use this display name.

Supports the following types of authentication :

App authentication with administrator approval and one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.app.spaces
User authentication with one of the following authorization scopes:
- https://www.googleapis.com/auth/chat.spaces
- https://www.googleapis.com/auth/chat.import (import mode spaces only)
- User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true , and the following authorization scopes is used:
  - https://www.googleapis.com/auth/chat.admin.spaces

App authentication has the following limitations:

To update either space.predefined_permission_settings or space.permission_settings , the app must be the space creator.
Updating the space.access_settings.audience is not supported for app authentication.

Authorization scopes

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

https://www.googleapis.com/auth/chat.app.spaces
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.spaces

For more information, see the Authorization guide .

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting( UpdateSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting )

Updates the space notification setting. For an example, see Update the caller's space notification setting .

Requires user authentication with the authorization scope :

https://www.googleapis.com/auth/chat.users.spacesettings

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.users.spacesettings

For more information, see the Authorization guide .

UpdateSpaceReadState

rpc UpdateSpaceReadState( UpdateSpaceReadStateRequest ) returns ( SpaceReadState )

Updates a user's read state within a space, used to identify read and unread messages. For an example, see Update a user's space read state .

Requires user authentication with the authorization scope :

https://www.googleapis.com/auth/chat.users.readstate

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/chat.users.readstate

For more information, see the Authorization guide .

AccessoryWidget

One or more interactive widgets that appear at the bottom of a message. For details, see Add interactive widgets at the bottom of a message .

فیلدها

Union field action . The type of action. action can be only one of the following:

button_list

ButtonList

A list of buttons.

ActionResponse

Parameters that a Chat app can use to configure how its response is posted.

فیلدها
`type`	`ResponseType` فقط ورودی The type of Chat app response.
`url`	`string` فقط ورودی URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
`dialog_action`	`DialogAction` فقط ورودی A response to an interaction event related to a dialog . Must be accompanied by `ResponseType.Dialog` .
`updated_widget`	`UpdatedWidget` فقط ورودی The response of the updated widget.

ResponseType

The type of Chat app response.

Enums
`TYPE_UNSPECIFIED`	Default type that's handled as `NEW_MESSAGE` .
`NEW_MESSAGE`	Post as a new message in the topic.
`UPDATE_MESSAGE`	Update the Chat app's message. This is only permitted on a `CARD_CLICKED` event where the message sender type is `BOT` .
`UPDATE_USER_MESSAGE_CARDS`	Update the cards on a user's message. This is only permitted as a response to a `MESSAGE` event with a matched url, or a `CARD_CLICKED` event where the message sender type is `HUMAN` . Text is ignored.
`REQUEST_CONFIG`	Privately ask the user for additional authentication or configuration.
`DIALOG`	Presents a dialog .
`UPDATE_WIDGET`	Widget text autocomplete options query.

SelectionItems

List of widget autocomplete results.

فیلدها

items[]

SelectionItem

An array of the SelectionItem objects.

UpdatedWidget

For selectionInput widgets, returns autocomplete suggestions for a multiselect menu.

فیلدها

widget

string

The ID of the updated widget. The ID must match the one for the widget that triggered the update request.

Union field updated_widget . The widget updated in response to a user action. updated_widget can be only one of the following:

suggestions

SelectionItems

List of widget autocomplete results

ActionStatus

Represents the status for a request to either invoke or submit a dialog .

فیلدها

status_code

Code

The status code.

user_facing_message

string

The message to send users about the status of their request. If unset, a generic message based on the status_code is sent.

حاشیه نویسی

فقط خروجی Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with start_index and length of 0. To add basic formatting to a text message, see Format text messages .

Example plain-text message body:

Hello @FooBot how are you!"

The corresponding annotations metadata:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]

فیلدها
`type`	`AnnotationType` The type of this annotation.
`length`	`int32` Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
`start_index`	`int32` Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
Union field `metadata` . Additional metadata about the annotation. `metadata` can be only one of the following:
`user_mention`	`UserMentionMetadata` The metadata of user mention.
`slash_command`	`SlashCommandMetadata` The metadata for a slash command.
`rich_link_metadata`	`RichLinkMetadata` The metadata for a rich link.
`custom_emoji_metadata`	`CustomEmojiMetadata` The metadata for a custom emoji.

AnnotationType

Type of the annotation.

Enums
`ANNOTATION_TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`USER_MENTION`	A user is mentioned.
`SLASH_COMMAND`	A slash command is invoked.
`RICH_LINK`	A rich link annotation.
`CUSTOM_EMOJI`	A custom emoji annotation.

AppCommandMetadata

Metadata about a Chat app command .

فیلدها

app_command_id

int32

The ID for the command specified in the Chat API configuration.

app_command_type

AppCommandType

The type of Chat app command.

AppCommandType

The type of Chat app command. For details, see Types of Chat app commands .

Enums
`APP_COMMAND_TYPE_UNSPECIFIED`	مقدار پیش فرض نامشخص
`SLASH_COMMAND`	A slash command. The user sends the command in a Chat message.
`QUICK_COMMAND`	A quick command. The user selects the command from the Chat menu in the message reply area.

AttachedGif

A GIF image that's specified by a URL.

فیلدها

uri

string

فقط خروجی The URL that hosts the GIF image.

پیوست

An attachment in Google Chat.

فیلدها
`name`	`string` اختیاری. Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}` .
`content_name`	`string` فقط خروجی The original file name for the content, not the full path.
`content_type`	`string` فقط خروجی The content type (MIME type) of the file.
`thumbnail_uri`	`string` فقط خروجی The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
`download_uri`	`string` فقط خروجی The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.
`source`	`Source` فقط خروجی The source of the attachment.
Union field `data_ref` . The data reference to the attachment. `data_ref` can be only one of the following:
`attachment_data_ref`	`AttachmentDataRef` اختیاری. A reference to the attachment data. This field is used to create or update messages with attachments, or with the media API to download the attachment data.
`drive_data_ref`	`DriveDataRef` فقط خروجی A reference to the Google Drive attachment. This field is used with the Google Drive API.

منبع

The source of the attachment.

Enums
`SOURCE_UNSPECIFIED`	رزرو شده است.
`DRIVE_FILE`	The file is a Google Drive file.
`UPLOADED_CONTENT`	The file is uploaded to Chat.

AttachmentDataRef

A reference to the attachment data.

فیلدها

resource_name

string

اختیاری. The resource name of the attachment data. This field is used with the media API to download the attachment data.

attachment_upload_token

string

اختیاری. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.

CalendarEventLinkData

Data for Calendar event links.

فیلدها

calendar_id

string

The Calendar identifier of the linked Calendar.

event_id

string

The Event identifier of the linked Calendar event.

CardWithId

A card in a Google Chat message.

Only Chat apps can create cards. If your Chat app authenticates as a user , the message can't contain cards.

Design and preview cards with the Card Builder.

Open the Card Builder

فیلدها

card_id

string

Required if the message contains multiple cards. A unique identifier for a card in a message.

card

Card

یک کارت Maximum size is 32 KB.

ChatSpaceLinkData

Data for Chat space links.

فیلدها

space

string

The space of the linked Chat space resource.

Format: spaces/{space}

thread

string

The thread of the linked Chat space resource.

Format: spaces/{space}/threads/{thread}

message

string

The message of the linked Chat space resource.

Format: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Request message for completing the import process for a space.

فیلدها

name

string

مورد نیاز. Resource name of the import mode space.

Format: spaces/{space}

CompleteImportSpaceResponse

Response message for completing the import process for a space.

فیلدها

space

The import mode space.

ContextualAddOnMarkup

This type has no fields.

The markup for developers to specify the contents of a contextual AddOn.

کارت

A card is a UI element that can contain UI widgets such as text and images.

فیلدها
`header`	`CardHeader` The header of the card. A header usually contains a title and an image.
`sections[]`	`Section` Sections are separated by a line divider.
`card_actions[]`	`CardAction` The actions of this card.
`name`	`string` Name of the card.

CardAction

A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser.

Not supported by Google Chat apps.

فیلدها

action_label

string

The label used to be displayed in the action menu item.

on_click

The onclick action for this action item.

سربرگ کارت

فیلدها
`title`	`string` The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines.
`subtitle`	`string` The subtitle of the card header.
`image_style`	`ImageStyle` The image's type (for example, square border or circular border).
`image_url`	`string` The URL of the image in the card header.

ImageStyle

Enums
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Square border.
`AVATAR`	Circular border.

بخش

A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).

فیلدها

header

string

The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

widgets[]

WidgetMarkup

A section must contain at least one widget.

CreateCustomEmojiRequest

A request to create a custom emoji.

فیلدها

custom_emoji

مورد نیاز. The custom emoji to create.

CreateMembershipRequest

Request message for creating a membership.

فیلدها

parent

string

مورد نیاز. The resource name of the space for which to create the membership.

Format: spaces/{space}

membership

مورد نیاز. The membership relation to create.

The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified.

When a Chat app creates a membership relation for a human user, it must use certain authorization scopes and set specific values for certain fields:

When authenticating as a user , the chat.memberships authorization scope is required.
When authenticating as an app , the chat.app.memberships authorization scope is required.
Set user.type to HUMAN , and set user.name with format users/{user} , where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id of the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789 , you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789 .

Inviting users external to the Workspace organization that owns the space requires user authentication .

When a Chat app creates a membership relation for itself, it must authenticate as a user and use the chat.memberships.app scope, set user.type to BOT , and set user.name to users/app .

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.

CreateMessageRequest

Creates a message.

فیلدها
`parent`	`string` مورد نیاز. The resource name of the space in which to create a message. Format: `spaces/{space}`
`message`	`Message` مورد نیاز. Message body.
`thread_key (deprecated)`	`string` This item is deprecated! اختیاری. Deprecated: Use `thread.thread_key` instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the `thread.name` . For example usage, see Start or reply to a message thread .
`request_id`	`string` اختیاری. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
`message_reply_option`	`MessageReplyOption` اختیاری. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When responding to user interactions , this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
`message_id`	`string` اختیاری. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: Begins with `client-` . For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. Contains up to 63 characters and only lowercase letters, numbers, and hyphens. Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see Name a message .

MessageReplyOption

Specifies how to reply to a message. More states might be added in the future.

Enums
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	پیش فرض Starts a new thread. Using this option ignores any `thread ID` or `thread_key` that's included.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	Creates the message as a reply to the thread specified by `thread ID` or `thread_key` . If it fails, the message starts a new thread instead.
`REPLY_MESSAGE_OR_FAIL`	Creates the message as a reply to the thread specified by `thread ID` or `thread_key` . If a new `thread_key` is used, a new thread is created. If the message creation fails, a `NOT_FOUND` error is returned instead.

CreateReactionRequest

Creates a reaction to a message.

فیلدها

parent

string

مورد نیاز. The message where the reaction is created.

Format: spaces/{space}/messages/{message}

reaction

مورد نیاز. The reaction to create.

CreateSpaceRequest

A request to create a named space with no members.

فیلدها

space

مورد نیاز. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true.

If you receive the error message ALREADY_EXISTS , try a different displayName . An existing space within the Google Workspace organization might already use this display name.

The space name is assigned on the server so anything specified in this field will be ignored.

request_id

string

CustomEmoji

Represents a custom emoji .

فیلدها
`name`	`string` Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`
`uid`	`string` فقط خروجی Unique key for the custom emoji resource.
`emoji_name`	`string` اختیاری. تغییرناپذیر. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
`temporary_image_uri`	`string` فقط خروجی A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.
`payload`	`CustomEmojiPayload` اختیاری. فقط ورودی Payload data. Required when the custom emoji is created.

CustomEmojiPayload

Payload data for the custom emoji.

فیلدها

file_content

bytes

مورد نیاز. فقط ورودی The image used for the custom emoji.

The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.

filename

string

مورد نیاز. فقط ورودی The image file name.

Supported file extensions: .png , .jpg , .gif .

CustomEmojiMetadata

Annotation metadata for custom emoji.

فیلدها

custom_emoji

The custom emoji.

DeleteCustomEmojiRequest

Request for deleting a custom emoji.

فیلدها

name

string

مورد نیاز. Resource name of the custom emoji to delete.

Format: customEmojis/{customEmoji}

You can use the emoji name as an alias for {customEmoji} . For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

DeleteMembershipRequest

Request to delete a membership in a space.

فیلدها

name

string

مورد نیاز. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

When deleting a human membership, requires the chat.memberships scope with user authentication or the chat.memberships.app scope with app authentication and the spaces/{space}/members/{member} format. You can use the email as an alias for {member} . For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app .

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

Deleting app memberships in a space isn't supported using admin access.

DeleteMessageRequest

Request to delete a message.

فیلدها

name

string

مورد نیاز. Resource name of the message.

Format: spaces/{space}/messages/{message}

If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message} . For details, see Name a message .

force

bool

اختیاری. When true , deleting a message also deletes its threaded replies. When false , if a message has threaded replies, deletion fails.

Only applies when authenticating as a user . Has no effect when authenticating as a Chat app .

DeleteReactionRequest

Deletes a reaction to a message.

فیلدها

name

string

مورد نیاز. Name of the reaction to delete.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Request for deleting a space.

فیلدها

name

string

مورد نیاز. Resource name of the space to delete.

Format: spaces/{space}

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.delete OAuth 2.0 scope .

DeletionMetadata

Information about a deleted message. A message is deleted when delete_time is set.

فیلدها

deletion_type

DeletionType

Indicates who deleted the message.

DeletionType

Who deleted the message and how it was deleted. More values may be added in the future. See Edit or delete a message in Google Chat for details on when messages can be deleted.

Enums
`DELETION_TYPE_UNSPECIFIED`	This value is unused.
`CREATOR`	User deleted their own message.
`SPACE_OWNER`	A space manager deleted the message.
`ADMIN`	A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.
`APP_MESSAGE_EXPIRY`	A Chat app deleted its own message when it expired.
`CREATOR_VIA_APP`	A Chat app deleted the message on behalf of the creator (using user authentication).
`SPACE_OWNER_VIA_APP`	A Chat app deleted the message on behalf of a space manager (using user authentication).
`SPACE_MEMBER`	A member of the space deleted the message. Users can delete messages sent by apps.

گفتگو

Wrapper around the card body of the dialog.

فیلدها

body

Card

فقط ورودی Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: DateTimePicker , OnChangeAction .

DialogAction

Contains a dialog and request status code.

فیلدها

action_status

ActionStatus

فقط ورودی Status for a request to either invoke or submit a dialog . Displays a status and message to users, if necessary. For example, in case of an error or success.

Union field action . Action to perform. action can be only one of the following:

dialog

Dialog

فقط ورودی Dialog for the request.

DriveDataRef

A reference to the data of a drive attachment.

فیلدها

drive_file_id

string

The ID for the drive file. Use with the Drive API.

DriveLinkData

Data for Google Drive links.

فیلدها

drive_data_ref

DriveDataRef

A DriveDataRef which references a Google Drive file.

mime_type

string

The mime type of the linked Google Drive resource.

ایموجی

An emoji that is used as a reaction to a message.

فیلدها

Union field content . مورد نیاز. The content of the emoji. content can be only one of the following:

unicode

string

اختیاری. A basic emoji represented by a unicode string.

custom_emoji

A custom emoji.

EmojiReactionSummary

The number of people who reacted to a message with a specific emoji.

فیلدها

emoji

فقط خروجی Emoji associated with the reactions.

reaction_count

int32

فقط خروجی The total number of reactions using the associated emoji.

FindDirectMessageRequest

A request to get direct message space based on the user resource.

فیلدها

name

string

مورد نیاز. Resource name of the user to find direct message with.

Format: users/{user} , where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API profile ID is 123456789 , you can find a direct message with that person by using users/123456789 as the name . When authenticated as a user , you can use the email as an alias for {user} . For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

GetAttachmentRequest

Request to get an attachment.

فیلدها

name

string

مورد نیاز. Resource name of the attachment, in the form spaces/{space}/messages/{message}/attachments/{attachment} .

GetCustomEmojiRequest

A request to return a single custom emoji.

فیلدها

name

string

مورد نیاز. Resource name of the custom emoji.

Format: customEmojis/{customEmoji}

You can use the emoji name as an alias for {customEmoji} . For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

GetMembershipRequest

Request to get a membership of a space.

فیلدها

name

string

مورد نیاز. Resource name of the membership to retrieve.

To get the app's own membership by using user authentication , you can optionally use spaces/{space}/members/app .

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

You can use the user's email as an alias for {member} . For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes .

Getting app memberships in a space isn't supported when using admin access.

GetMessageRequest

Request to get a message.

فیلدها

name

string

مورد نیاز. Resource name of the message.

Format: spaces/{space}/messages/{message}

If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message} . For details, see Name a message .

GetSpaceEventRequest

Request message for getting a space event.

فیلدها

name

string

مورد نیاز. The resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

Request message to get space notification setting. Only supports getting notification setting for the calling user.

فیلدها

name

string

مورد نیاز. Format: users/{user}/spaces/{space}/spaceNotificationSetting

users/me/spaces/{space}/spaceNotificationSetting , OR
users/user@example.com/spaces/{space}/spaceNotificationSetting , OR
users/123456789/spaces/{space}/spaceNotificationSetting . Note: Only the caller's user id or email is allowed in the path.

GetSpaceReadStateRequest

Request message for GetSpaceReadState API.

فیلدها

name

string

مورد نیاز. Resource name of the space read state to retrieve.

Only supports getting read state for the calling user.

To refer to the calling user, set one of the following:

The me alias. For example, users/me/spaces/{space}/spaceReadState .
Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState .
Their user id. For example, users/123456789/spaces/{space}/spaceReadState .

Format: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

A request to return a single space.

فیلدها

name

string

مورد نیاز. Resource name of the space, in the form spaces/{space} .

Format: spaces/{space}

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.spaces or chat.admin.spaces.readonly OAuth 2.0 scopes .

GetThreadReadStateRequest

Request message for GetThreadReadStateRequest API.

فیلدها

name

string

مورد نیاز. Resource name of the thread read state to retrieve.

Only supports getting read state for the calling user.

To refer to the calling user, set one of the following:

The me alias. For example, users/me/spaces/{space}/threads/{thread}/threadReadState .
Their Workspace email address. For example, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState .
Their user id. For example, users/123456789/spaces/{space}/threads/{thread}/threadReadState .

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

گروه

A Google Group in Google Chat.

فیلدها

name

string

Resource name for a Google Group.

Represents a group in Cloud Identity Groups API.

Format: groups/{group}

HistoryState

The history state for messages and spaces. Specifies how long messages and conversation threads are kept after creation.

Enums
`HISTORY_STATE_UNSPECIFIED`	مقدار پیش فرض استفاده نکنید.
`HISTORY_OFF`	History off. Messages and threads are kept for 24 hours .
`HISTORY_ON`	History on. The organization's Vault retention rules specify for how long messages and threads are kept.

ListCustomEmojisRequest

A request to return a list of custom emojis.

فیلدها

page_size

int32

اختیاری. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

page_token

string

اختیاری. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

filter

string

اختیاری. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller:

creator("users/me")

فیلدها

page_size

int32

اختیاری. The maximum number of spaces to return. The service might return fewer than this value.

If unspecified, at most 100 spaces are returned.

The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

Negative values return an INVALID_ARGUMENT error.

page_token

string

اختیاری. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

filter

string

اختیاری. A query filter.

You can filter spaces by the space type ( space_type ).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED ). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

ListSpacesResponse

The response for a list spaces request.

فیلدها

spaces[]

List of spaces in the requested (or first) page. Note: The permissionSettings field is not returned in the Space object for list requests.

next_page_token

string

You can send a token as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

MatchedUrl

A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see Preview links .

فیلدها

url

string

فقط خروجی The URL that was matched.

MeetSpaceLinkData

Data for Meet space links.

فیلدها

meeting_code

string

Meeting code of the linked Meet space.

type

Type

Indicates the type of the Meet space.

huddle_status

HuddleStatus

اختیاری. فقط خروجی If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.

HuddleStatus

The status of the huddle

Enums
`HUDDLE_STATUS_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`STARTED`	The huddle has started.
`ENDED`	The huddle has ended. In this case the Meet space URI and identifiers will no longer be valid.
`MISSED`	The huddle has been missed. In this case the Meet space URI and identifiers will no longer be valid.

تایپ کنید

The type of the Meet space.

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`MEETING`	The Meet space is a meeting.
`HUDDLE`	The Meet space is a huddle.

عضویت

Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.

فیلدها
`name`	`string` Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
`state`	`MembershipState` فقط خروجی State of the membership.
`role`	`MembershipRole` اختیاری. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership` .
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.
`delete_time`	`Timestamp` اختیاری. تغییرناپذیر. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.
Union field `memberType` . Member associated with this membership. Other member types might be supported in the future. `memberType` can be only one of the following:
`member`	`User` اختیاری. The Google Chat user or app the membership corresponds to. If your Chat app authenticates as a user , the output populates the user `name` and `type` .
`group_member`	`Group` اختیاری. The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires user authentication .

MembershipRole

Represents a user's permitted actions in a Chat space. More enum values might be added in the future.

Enums

ROLE_MEMBER

A member of the space. In the Chat UI, this role is called Member.

The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including:

Add or remove members.
Modify space details.
Turn history on or off.
Mention everyone in the space with @all .
Manage Chat apps and webhooks installed in the space.

In direct messages and unnamed group conversations, everyone has this role.

ROLE_MANAGER

A space owner. In the Chat UI, this role is called Owner.

The user has the complete set of space permissions to manage the space, including:

Change the role of other members in the space to member, manager, or owner.
Delete the space.

Only supported in SpaceType.SPACE (named spaces).

To learn more, see Learn more about your role as a space owner or manager .

MembershipState

Specifies the member's relationship with a space. Other membership states might be supported in the future.

Enums
`MEMBERSHIP_STATE_UNSPECIFIED`	مقدار پیش فرض استفاده نکنید.
`JOINED`	The user is added to the space, and can participate in the space.
`INVITED`	The user is invited to join the space, but hasn't joined it.
`NOT_A_MEMBER`	The user doesn't belong to the space and doesn't have a pending invitation to join the space.

پیام

A message in a Google Chat space.

فیلدها
`name`	`string` Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` . If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name` . For details, see Name a message .
`sender`	`User` فقط خروجی The user who created the message. If your Chat app authenticates as a user , the output populates the user `name` and `type` .
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.
`last_update_time`	`Timestamp` فقط خروجی The time at which the message was last edited by a user. If the message has never been edited, this field is empty.
`delete_time`	`Timestamp` فقط خروجی The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
`text`	`string` اختیاری. Plain-text body of the message. The first link to an image, video, or web page generates a preview chip . You can also @mention a Google Chat user , or everyone in the space. To learn about creating text messages, see Send a message .
`formatted_text`	`string` فقط خروجی Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: Markup syntax for bold, italic, strikethrough, monospace, monospace block, and bulleted list. User mentions using the format `<users/{user}>` . Custom hyperlinks using the format `<{url}\|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, `<http://example.com\|custom text>` . Custom emoji using the format `:{emoji_name}:` —for example, `:smile:` . This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see View text formatting sent in a message
`cards[] (deprecated)`	`Card` This item is deprecated! Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.
`cards_v2[]`	`CardWithId` اختیاری. An array of cards . Only Chat apps can create cards. If your Chat app authenticates as a user , the messages can't contain cards. To learn how to create a message that contains cards, see Send a message . Design and preview cards with the Card Builder. Open the Card Builder
`annotations[]`	`Annotation` فقط خروجی Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.
`thread`	`Thread` The thread the message belongs to. For example usage, see Start or reply to a message thread .
`space`	`Space` فقط خروجی If your Chat app authenticates as a user , the output only populates the space `name` .
`fallback_text`	`string` اختیاری. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
`action_response`	`ActionResponse` فقط ورودی Parameters that a Chat app can use to configure how its response is posted.
`argument_text`	`string` فقط خروجی Plain-text body of the message with all Chat app mentions stripped out.
`slash_command`	`SlashCommand` فقط خروجی Slash command information, if applicable.
`attachment[]`	`Attachment` اختیاری. User-uploaded attachment.
`matched_url`	`MatchedUrl` فقط خروجی A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see Preview links .
`thread_reply`	`bool` فقط خروجی When `true` , the message is a response in a reply thread. When `false` , the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false` .
`client_assigned_message_id`	`string` اختیاری. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the `messageId` field when you create the message. For details, see Name a message .
`emoji_reaction_summaries[]`	`EmojiReactionSummary` فقط خروجی The list of emoji reaction summaries on the message.
`private_message_viewer`	`User` اختیاری. تغییرناپذیر. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using app authentication and omit the following: پیوست ها Accessory widgets For details, see Send a message privately .
`deletion_metadata`	`DeletionMetadata` فقط خروجی Information about a deleted message. A message is deleted when `delete_time` is set.
`quoted_message_metadata`	`QuotedMessageMetadata` اختیاری. Information about a message that another message quotes. When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see Quote another message .
`attached_gifs[]`	`AttachedGif` فقط خروجی GIF images that are attached to the message.
`accessory_widgets[]`	`AccessoryWidget` اختیاری. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message . Creating a message with accessory widgets requires app authentication .

If last_update_time doesn't match the latest version of the quoted message, the request fails.

واکنش

A reaction to a message.

فیلدها

name

string

Identifier. The resource name of the reaction.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

فقط خروجی The user who created the reaction.

emoji

ReactionCreatedEventData

مورد نیاز. The emoji used in the reaction.

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

فیلدها

reactions[]

A list of new reactions.

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

فیلدها

reactions[]

ReactionDeletedEventData

A list of deleted reactions.

ReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

فیلدها

reaction

The new reaction.

ReactionDeletedEventData

Event payload for a deleted reaction.

Type: google.workspace.chat.reaction.v1.deleted

فیلدها

reaction

The deleted reaction.

RichLinkMetadata

فیلدها
`uri`	`string` The URI of this link.
`rich_link_type`	`RichLinkType` The rich link type.
Union field `data` . Data for the linked resource. `data` can be only one of the following:
`drive_link_data`	`DriveLinkData` Data for a drive link.
`chat_space_link_data`	`ChatSpaceLinkData` Data for a chat space link.
`meet_space_link_data`	`MeetSpaceLinkData` Data for a Meet space link.
`calendar_event_link_data`	`CalendarEventLinkData` Data for a Calendar event link.

RichLinkType

The rich link type. More types might be added in the future.

Enums
`RICH_LINK_TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`DRIVE_FILE`	A Google Drive rich link type.
`CHAT_SPACE`	A Chat space rich link type. For example, a space smart chip.
`MEET_SPACE`	A Meet message rich link type. For example, a Meet chip.
`CALENDAR_EVENT`	A Calendar message rich link type. For example, a Calendar chip.

SearchSpacesRequest

Request to search for a list of spaces based on a query.

فیلدها
`use_admin_access`	`bool` When `true` , the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` OAuth 2.0 scope . This method currently only supports admin access, thus only `true` is accepted for this field.
`page_size`	`int32` The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.
`page_token`	`string` A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
`query`	`string` مورد نیاز. A search query. You can search by using the following parameters: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` `create_time` and `last_active_time` accept a timestamp in RFC-3339 format and the supported comparison operators are: `=` , `<` , `>` , `<=` , `>=` . `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` ( `:` ) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name` . For example, `Fun Eve` matches `Fun event` or `The evening was fun` , but not `notFun event` or `even` . `external_user_allowed` accepts either `true` or `false` . `space_history_state` only accepts values from the `historyState` field of a `space` resource. `space_type` is required and the only valid value is `SPACE` . Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"` . Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name` , 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"` . The following example queries are valid: customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
`order_by`	`string` اختیاری. How the list of spaces is ordered. Supported attributes to order by are: `membership_count.joined_direct_human_user_count` — Denotes the count of human users that have directly joined a space. `last_active_time` — Denotes the time when last eligible item is added to any topic of this space. `create_time` — Denotes the time of the space creation. Valid ordering operation values are: `ASC` for ascending. مقدار پیش فرض `DESC` for descending. The supported syntax are: `membership_count.joined_direct_human_user_count DESC` `membership_count.joined_direct_human_user_count ASC` `last_active_time DESC` `last_active_time ASC` `create_time DESC` `create_time ASC`

SearchSpacesResponse

Response with a list of spaces corresponding to the search spaces request.

فیلدها

spaces[]

A page of the requested spaces.

next_page_token

string

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.

total_size

int32

The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.

SetUpSpaceRequest

Request to create a space and add specified users to it.

فیلدها

space

مورد نیاز. The Space.spaceType field is required.

To create a group chat, set Space.spaceType to GROUP_CHAT . Don't set Space.displayName .

To create a 1:1 conversation between humans, set Space.spaceType to DIRECT_MESSAGE and set Space.singleUserBotDm to false . Don't set Space.displayName or Space.spaceDetails .

If a DIRECT_MESSAGE space already exists, that space is returned instead of creating a new space.

request_id

string

memberships[]

اختیاری. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically.

The set currently allows up to 49 memberships (in addition to the caller).

Optional when setting Space.spaceType to SPACE .

Required when setting Space.spaceType to GROUP_CHAT , along with at least two memberships.

Required when setting Space.spaceType to DIRECT_MESSAGE with a human user, along with exactly one membership.

Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true ).

SlashCommand

Metadata about a slash command in Google Chat.

فیلدها

command_id

int64

The ID of the slash command.

SlashCommandMetadata

Annotation metadata for slash commands (/).

فیلدها
`bot`	`User` The Chat app whose command was invoked.
`type`	`Type` The type of slash command.
`command_name`	`string` The name of the invoked slash command.
`command_id`	`int64` The command ID of the invoked slash command.
`triggers_dialog`	`bool` Indicates whether the slash command is for a dialog.

تایپ کنید

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`ADD`	Add Chat app to space.
`INVOKE`	Invoke slash command in space.

فضا

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

فیلدها
`name`	`string` Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the `spaces.list()` method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA` , the space ID is `AAAAAAAAA` .
`type (deprecated)`	`Type` This item is deprecated! فقط خروجی Deprecated: Use `space_type` instead. The type of a space.
`space_type`	`SpaceType` اختیاری. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
`single_user_bot_dm`	`bool` اختیاری. Whether the space is a DM between a Chat app and a single human.
`threaded (deprecated)`	`bool` This item is deprecated! فقط خروجی Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
`display_name`	`string` اختیاری. The space's display name. Required when creating a space with a `spaceType` of `SPACE` . If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName` , try a different `displayName` . An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
`external_user_allowed`	`bool` اختیاری. تغییرناپذیر. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
`space_threading_state`	`SpaceThreadingState` فقط خروجی The threading state in the Chat space.
`space_details`	`SpaceDetails` اختیاری. Details about the space including description and rules.
`space_history_state`	`HistoryState` اختیاری. The message history state for messages and threads in this space.
`import_mode`	`bool` اختیاری. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode` requires user authentication .
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE` .
`last_active_time`	`Timestamp` فقط خروجی Timestamp of the last message in the space.
`admin_installed`	`bool` فقط خروجی For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
`membership_count`	`MembershipCount` فقط خروجی The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE` , `DIRECT_MESSAGE` or `GROUP_CHAT` .
`access_settings`	`AccessSettings` اختیاری. Specifies the access setting of the space. Only populated when the `space_type` is `SPACE` .
`space_uri`	`string` فقط خروجی The URI for a user to access the space.
`import_mode_expire_time`	`Timestamp` فقط خروجی The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport` . This field is only populated for spaces that were created with import mode.
`customer`	`string` اختیاری. تغییرناپذیر. The customer id of the domain of the space. Required only when creating a space with app authentication and `SpaceType` is `SPACE` , otherwise should not be set. In the format `customers/{customer}` , where `customer` is the `id` from the Admin SDK customer resource . Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated.
Union field `space_permission_settings` . Represents the permission settings of a space. Only populated when the `space_type` is `SPACE` . `space_permission_settings` can be only one of the following:
`predefined_permission_settings`	`PredefinedPermissionSettings` اختیاری. فقط ورودی Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: App authentication with administrator approval with the `chat.app.spaces` or `chat.app.spaces.create` scopes. احراز هویت کاربر
`permission_settings`	`PermissionSettings` اختیاری. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: App authentication with administrator approval with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. احراز هویت کاربر

AccessSettings

Represents the access setting of the space.

فیلدها

access_state

AccessState

فقط خروجی Indicates the access state of the space.

audience

string

Format: audiences/{audience}

To use the default target audience for the Google Workspace organization, set to audiences/default .

Reading the target audience supports:

احراز هویت کاربر
App authentication with administrator approval with the chat.app.spaces scope.

This field is not populated when using the chat.bot scope with app authentication .

Setting the target audience requires user authentication .

AccessState

Represents the access state of the space.

Enums

ACCESS_STATE_UNSPECIFIED Access state is unknown or not supported in this API.

PRIVATE Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.

DISCOVERABLE

Creating discoverable spaces requires user authentication .

MembershipCount

Represents the count of memberships of a space, grouped into categories.

فیلدها

joined_direct_human_user_count

int32

فقط خروجی Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.

joined_group_count

int32

فقط خروجی Count of all groups that have directly joined the space.

PermissionSetting

Represents a space permission setting.

فیلدها

managers_allowed

bool

اختیاری. Whether space owners ( ROLE_MANAGER ) have this permission.

members_allowed

bool

اختیاری. Whether basic space members ( ROLE_MEMBER ) have this permission.

PermissionSettings

Permission settings that you can specify when updating an existing named space.

To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

فیلدها
`manage_members_and_groups`	`PermissionSetting` اختیاری. Setting for managing members and groups in a space.
`modify_space_details`	`PermissionSetting` اختیاری. Setting for updating space name, avatar, description and guidelines.
`toggle_history`	`PermissionSetting` اختیاری. Setting for toggling space history on and off.
`use_at_mention_all`	`PermissionSetting` اختیاری. Setting for using @all in a space.
`manage_apps`	`PermissionSetting` اختیاری. Setting for managing apps in a space.
`manage_webhooks`	`PermissionSetting` اختیاری. Setting for managing webhooks in a space.
`post_messages`	`PermissionSetting` فقط خروجی Setting for posting messages in a space.
`reply_messages`	`PermissionSetting` اختیاری. Setting for replying to messages in a space.

PredefinedPermissionSettings

Enums
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	نامشخص استفاده نکنید.
`COLLABORATION_SPACE`	Setting to make the space a collaboration space where all members can post messages.
`ANNOUNCEMENT_SPACE`	Setting to make the space an announcement space where only space managers can post messages.

SpaceDetails

Details about the space including description and rules.

فیلدها

description

string

اختیاری. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants.

Supports up to 150 characters.

guidelines

string

اختیاری. The space's rules, expectations, and etiquette.

Supports up to 5,000 characters.

SpaceThreadingState

Specifies the type of threading state in the Chat space.

Enums
`SPACE_THREADING_STATE_UNSPECIFIED`	رزرو شده است.
`THREADED_MESSAGES`	Named spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message.
`GROUPED_MESSAGES`	Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.
`UNTHREADED_MESSAGES`	Direct messages (DMs) between two people and group conversations between 3 or more people.

SpaceType

The type of space. Required when creating or updating a space. Output only for other usage.

Enums
`SPACE_TYPE_UNSPECIFIED`	رزرو شده است.
`SPACE`	A place where people send messages, share files, and collaborate. A `SPACE` can include Chat apps.
`GROUP_CHAT`	Group conversations between 3 or more people. A `GROUP_CHAT` can include Chat apps.
`DIRECT_MESSAGE`	1:1 messages between two humans or a human and a Chat app.

تایپ کنید

Deprecated: Use SpaceType instead.

Enums
`TYPE_UNSPECIFIED`	رزرو شده است.
`ROOM`	Conversations between two or more humans.
`DM`	1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans.

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

فیلدها

spaces[]

SpaceUpdatedEventData

A list of updated spaces.

SpaceEvent

An event that represents a change or activity in a Google Chat space. برای کسب اطلاعات بیشتر ، به کار با رویدادهای Google Chat مراجعه کنید.

فیلدها
`name`	`string` Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Time when the event occurred.
`event_type`	`string` Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for messages : New message: `google.workspace.chat.message.v1.created` Updated message: `google.workspace.chat.message.v1.updated` Deleted message: `google.workspace.chat.message.v1.deleted` Multiple new messages: `google.workspace.chat.message.v1.batchCreated` Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for memberships : New membership: `google.workspace.chat.membership.v1.created` Updated membership: `google.workspace.chat.membership.v1.updated` Deleted membership: `google.workspace.chat.membership.v1.deleted` Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for reactions : New reaction: `google.workspace.chat.reaction.v1.created` Deleted reaction: `google.workspace.chat.reaction.v1.deleted` Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the space : Updated space: `google.workspace.chat.space.v1.updated` Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`
Union field `payload` . `payload` can be only one of the following:
`message_created_event_data`	`MessageCreatedEventData` Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

The notification setting of a user in a space.

فیلدها

name

string

Identifier. The resource name of the space notification setting. Format: users/{user}/spaces/{space}/spaceNotificationSetting .

notification_setting

NotificationSetting

The notification setting.

mute_setting

MuteSetting

The space notification mute setting.

MuteSetting

The space notification mute setting types.

Enums
`MUTE_SETTING_UNSPECIFIED`	رزرو شده است.
`UNMUTED`	The user will receive notifications for the space based on the notification setting.
`MUTED`	The user will not receive any notifications for the space, regardless of the notification setting.

NotificationSetting

The notification setting types. Other types might be supported in the future.

Enums
`NOTIFICATION_SETTING_UNSPECIFIED`	رزرو شده است.
`ALL`	Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user.
`MAIN_CONVERSATIONS`	The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages.
`FOR_YOU`	The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages.
`OFF`	Notification is off.

SpaceReadState

A user's read state within a space, used to identify read and unread messages.

فیلدها

name

string

Resource name of the space read state.

Format: users/{user}/spaces/{space}/spaceReadState

last_read_time

SpaceUpdatedEventData

Event payload for an updated space.

Event type: google.workspace.chat.space.v1.updated

فیلدها

space

The updated space.

موضوع

A thread in a Google Chat space. For example usage, see Start or reply to a message thread .

If you specify a thread when creating a message, you can set the messageReplyOption field to determine what happens if no matching thread is found.

فیلدها

name

string

Identifier. Resource name of the thread.

Example: spaces/{space}/threads/{thread}

thread_key

string

اختیاری. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters.

ThreadReadState

A user's read state within a thread, used to identify read and unread messages.

فیلدها

name

string

Resource name of the thread read state.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.

UpdateMembershipRequest

Request message for updating a membership.

فیلدها

membership

مورد نیاز. The membership to update. Only fields specified by update_mask are updated.

update_mask

مورد نیاز. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

role

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

UpdateMessageRequest

Request to update a message.

فیلدها

message

Message

مورد نیاز. Message with fields updated.

update_mask

SpaceNotificationSetting

مورد نیاز. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

text
attachment
cards (Requires app authentication .)
cards_v2 (Requires app authentication .)
accessory_widgets (Requires app authentication .)
quoted_message_metadata (Only allows removal of the quoted message.)

allow_missing

bool

اختیاری. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

UpdateSpaceNotificationSettingRequest

Request to update the space notification settings. Only supports updating notification setting for the calling user.

فیلدها

space_notification_setting

update_mask

مورد نیاز. Supported field paths:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

فیلدها

space_read_state

SpaceReadState

مورد نیاز. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

The me alias. For example, users/me/spaces/{space}/spaceReadState .
Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState .
Their user id. For example, users/123456789/spaces/{space}/spaceReadState .

Format: users/{user}/spaces/{space}/spaceReadState

update_mask

مورد نیاز. The field paths to update. Currently supported field paths:

last_read_time

When the last_read_time is before the latest message create time, the space appears as unread in the UI.

UpdateSpaceRequest

A request to update a single space.

فیلدها

space

مورد نیاز. Space with fields to be updated. Space.name must be populated in the form of spaces/{space} . Only fields specified by update_mask are updated.

update_mask

مورد نیاز. The updated field paths, comma separated if there are multiple.

You can update the following fields for a space:

space_details : Updates the space's description. Supports up to 150 characters.

permission_settings.manageMembersAndGroups
permission_settings.modifySpaceDetails
permission_settings.toggleHistory
permission_settings.useAtMentionAll
permission_settings.manageApps
permission_settings.manageWebhooks
permission_settings.replyMessages

use_admin_access

bool

اختیاری. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.spaces OAuth 2.0 scope .

Some FieldMask values are not supported using admin access. For details, see the description of update_mask .

کاربر

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user , the output for a User resource only populates the user's name and type .

فیلدها
`name`	`string` Resource name for a Google Chat `user` . Format: `users/{user}` . `users/app` can be used as an alias for the calling app `bot` user. For `human users` , `{user}` is the same user identifier as: the `id` for the Person in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. the `id` for a user in the Admin SDK Directory API. the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789` , you can use `users/user@example.com` as an alias to reference `users/123456789` . Only the canonical resource name (for example `users/123456789` ) will be returned from the API.
`display_name`	`string` فقط خروجی The user's display name.
`domain_id`	`string` Unique identifier of the user's Google Workspace domain.
`type`	`Type` User type.
`is_anonymous`	`bool` فقط خروجی When `true` , the user is deleted or their profile is not visible.

تایپ کنید

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`HUMAN`	Human user.
`BOT`	Chat app user.

UserMentionMetadata

Annotation metadata for user mentions (@).

فیلدها

user

User

The user mentioned.

type

Type

The type of user mention.

تایپ کنید

Enums
`TYPE_UNSPECIFIED`	Default value for the enum. استفاده نکنید.
`ADD`	Add user to space.
`MENTION`	Mention user in space.

WidgetMarkup

A widget is a UI element that presents text and images.

فیلدها
`buttons[]`	`Button` A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.
Union field `data` . A `WidgetMarkup` can only have one of the following items. You can use multiple `WidgetMarkup` fields to display more items. `data` can be only one of the following:
`text_paragraph`	`TextParagraph` Display a text paragraph in this widget.
`image`	`Image` Display an image in this widget.
`key_value`	`KeyValue` Display a key value item in this widget.

دکمه

یک دکمه Can be a text button or an image button.

فیلدها

Union field type .

type can be only one of the following:

text_button

TextButton

A button with text and onclick action.

image_button

ImageButton

A button with image and onclick action.

FormAction

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

فیلدها

action_method_name

string

parameters[]

ActionParameter

List of action parameters.

ActionParameter

فیلدها

key

string

The name of the parameter for the action script.

value

string

The value of the parameter.

نماد

The set of supported icons.

Enums
`ICON_UNSPECIFIED`
`AIRPLANE`
`BOOKMARK`
`BUS`
`CAR`
`CLOCK`
`CONFIRMATION_NUMBER_ICON`
`DOLLAR`
`DESCRIPTION`
`EMAIL`
`EVENT_PERFORMER`
`EVENT_SEAT`
`FLIGHT_ARRIVAL`
`FLIGHT_DEPARTURE`
`HOTEL`
`HOTEL_ROOM_TYPE`
`INVITE`
`MAP_PIN`
`MEMBERSHIP`
`MULTIPLE_PEOPLE`
`OFFER`
`PERSON`
`PHONE`
`RESTAURANT_ICON`
`SHOPPING_CART`
`STAR`
`STORE`
`TICKET`
`TRAIN`
`VIDEO_CAMERA`
`VIDEO_PLAY`

تصویر

An image that's specified by a URL and can have an onclick action.

فیلدها

image_url

string

The URL of the image.

on_click

The onclick action.

aspect_ratio

double

دکمه تصویر

An image button with an onclick action.

فیلدها
`on_click`	`OnClick` The `onclick` action.
`name`	`string` The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.
Union field `icons` . The icon can be specified by an `Icon` `enum` or a URL. `icons` can be only one of the following:
`icon`	`Icon` The icon specified by an `enum` that indices to an icon provided by Chat API.
`icon_url`	`string` The icon specified by a URL.

KeyValue

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

فیلدها
`top_label`	`string` The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
`content`	`string` The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
`content_multiline`	`bool` If the content should be multiline.
`bottom_label`	`string` The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
`on_click`	`OnClick` The `onclick` action. Only the top label, bottom label, and content region are clickable.
Union field `icons` . At least one of icons, `top_label` and `bottom_label` must be defined. `icons` can be only one of the following:
`icon`	`Icon` An enum value that's replaced by the Chat API with the corresponding icon image.
`icon_url`	`string` The icon specified by a URL.
Union field `control` . A control widget. You can set either `button` or `switch_widget` , but not both. `control` can be only one of the following:
`button`	`Button` A button that can be clicked to trigger an action.

OnClick

An onclick action (for example, open a link).

فیلدها

Union field data .

data can be only one of the following:

action

FormAction

A form action is triggered by this onclick action if specified.

open_link

OpenLink

This onclick action triggers an open link action if specified.

OpenLink

A link that opens a new window.

فیلدها

url

string

The URL to open.

دکمه متن

A button with text and onclick action.

فیلدها

text

string

The text of the button.

on_click