Package google.chat.v1

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

ContextualAddOnMarkup

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

نشانه گذاری برای توسعه دهندگان برای تعیین محتوای یک AddOn متنی.

کارت

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

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

CardAction

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

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

فیلدها

action_label

string

برچسب قبلاً در آیتم منوی عمل نمایش داده می شد.

on_click

OnClick

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

سربرگ کارت

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

ImageStyle

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

بخش

یک بخش شامل مجموعه ای از ویجت ها است که به ترتیبی که مشخص شده اند (به صورت عمودی) ارائه می شوند. در همه پلتفرم‌ها، کارت‌ها دارای عرض ثابت باریکی هستند، بنابراین در حال حاضر نیازی به ویژگی‌های طرح‌بندی (مثلاً شناور) نیست.

فیلدها

header

string

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

widgets[]

WidgetMarkup

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

CreateCustomEmojiRequest

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

فیلدها

custom_emoji

CustomEmoji

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

ایجاد درخواست عضویت

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

فیلدها

parent

string

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

قالب: spaces/{space}

membership

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

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

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

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

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

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

use_admin_access

bool

اختیاری. وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود.

کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد.

به محدوده chat.admin.memberships OAuth 2.0 نیاز دارد.

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

CreateMessageRequest

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

فیلدها
`parent`	`string` مورد نیاز. نام منبع فضایی که در آن پیام ایجاد می شود. قالب: `spaces/{space}`
`message`	`Message` مورد نیاز. متن پیام
`thread_key (deprecated)`	`string` این مورد منسوخ شده است! اختیاری. منسوخ شده: به جای آن از `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 کاراکتر و فقط حروف کوچک، اعداد و خط فاصله است. در یک فضا منحصر به فرد است. برنامه چت نمی‌تواند از یک شناسه سفارشی برای پیام‌های مختلف استفاده کند. برای جزئیات، به نام پیام مراجعه کنید.

MessageReplyOption

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

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}` پیش نمایش توسعه دهنده: به عنوان بخشی از برنامه پیش نمایش توسعه دهنده Google Workspace ، که دسترسی زود هنگام به ویژگی های خاص را اعطا می کند.
`uid`	`string` فقط خروجی کلید منحصر به فرد برای منبع ایموجی سفارشی.
`emoji_name`	`string` اختیاری. تغییرناپذیر. نام توسط کاربر برای ایموجی های سفارشی ، که در سازمان بی نظیر است. هنگام ایجاد ایموجی های سفارشی ، مورد نیاز است ، فقط در غیر این صورت خروجی. نامهای ایموجی باید با استفاده از کلون ها شروع و پایان یابد ، باید حروف کوچک باشد و فقط می تواند حاوی شخصیت های الفبایی ، هیپنوها و زیرزمین ها باشد. برای جدا کردن کلمات باید از Hyphens و زیرکرها استفاده شود و به طور متوالی قابل استفاده نیست. مثال :: `:valid-emoji-name:` پیش نمایش توسعه دهنده: به عنوان بخشی از برنامه پیش نمایش توسعه دهنده Google Workspace ، که دسترسی زود هنگام به ویژگی های خاص را اعطا می کند.
`temporary_image_uri`	`string` فقط خروجی URL تصویر برای ایموجی های سفارشی ، حداقل برای 10 دقیقه معتبر است. توجه داشته باشید که هنگام ایجاد ایموجی های سفارشی ، این در پاسخ جمع نمی شود. پیش نمایش توسعه دهنده: به عنوان بخشی از برنامه پیش نمایش توسعه دهنده Google Workspace ، که دسترسی زود هنگام به ویژگی های خاص را اعطا می کند.
`payload`	`CustomEmojiPayload` اختیاری. فقط ورودی داده های بارگذاری هنگام ایجاد ایموجی های سفارشی مورد نیاز است. پیش نمایش توسعه دهنده: به عنوان بخشی از برنامه پیش نمایش توسعه دهنده Google Workspace ، که دسترسی زود هنگام به ویژگی های خاص را اعطا می کند.

بار سفارشی

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

فیلدها

file_content

bytes

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

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

filename

string

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

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

leeletecustomemojirequest

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

فیلدها

name

string

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

قالب: customEmojis/{customEmoji}

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

DeletemembershipRequest

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

فیلدها

name

string

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

هنگام حذف عضویت در انسانی ، به chat.memberships memberships دامنه و 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

CustomEmoji

فقط خروجی یک ایموجی سفارشی.

emojirectionsummary

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

فیلدها

emoji

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[]

CustomEmoji

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

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[]

لیست پیام ها

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[]

MembershipCreatedEventData

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

next_page_token

string

کابوس

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

فیلدها

url

string

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

عضویت

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

فیلدها
`name`	`string` شناسه. نام منابع عضویت ، اختصاص داده شده توسط سرور. قالب: `spaces/{space}/members/{member}`
`state`	`MembershipState` فقط خروجی وضعیت عضویت.
`role`	`MembershipRole` اختیاری. نقش کاربر در یک فضای گپ ، که اقدامات مجاز آنها را در فضا تعیین می کند. این قسمت فقط می تواند به عنوان ورودی در `UpdateMembership` استفاده شود.
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. زمان ایجاد عضویت ، مانند زمانی که یک عضو به آن پیوست یا برای پیوستن به یک فضا دعوت شده بود. این قسمت فقط خروجی است ، به جز در مواردی که برای وارد کردن عضویت های تاریخی در فضاهای حالت واردات استفاده می شود.
`delete_time`	`Timestamp` اختیاری. تغییرناپذیر. زمان حذف عضویت ، مانند زمانی که یک عضو از آنجا خارج شد یا از یک فضا خارج شد. این قسمت فقط خروجی است ، به جز در مواردی که برای وارد کردن عضویت های تاریخی در فضاهای حالت واردات استفاده می شود.
`memberType` اتحادیه عضو. عضو مرتبط با این عضویت. انواع دیگر اعضا ممکن است در آینده پشتیبانی شوند. `memberType` می تواند تنها یکی از موارد زیر باشد:
`member`	`User` اختیاری. کاربر یا برنامه Google CHAT که عضویت دارد با آن مطابقت دارد. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی `name` و `type` کاربر را جمع می کند.
`group_member`	`Group` اختیاری. گروه Google عضویت با آن مطابقت دارد. خواندن یا جهش عضویت برای گروه های Google نیاز به تأیید اعتبار کاربر دارد.

عضو

نشان دهنده اقدامات مجاز کاربر در یک فضای گپ است. مقادیر بیشتر در آینده ممکن است در آینده اضافه شود.

Enums
`MEMBERSHIP_ROLE_UNSPECIFIED`	مقدار پیش فرض برای `users` : آنها عضو فضا نیستند ، اما می توان از آنها دعوت شد. برای `Google Groups` : آنها همیشه این نقش را اختصاص داده اند (مقادیر دیگر در آینده ممکن است در آینده استفاده شود).
`ROLE_MEMBER`	عضو فضا کاربر مجوزهای اساسی دارد ، مانند ارسال پیام به فضا. در مکالمات گروهی 1: 1 و نامشخص ، همه این نقش را دارند.
`ROLE_MANAGER`	یک مدیر فضایی کاربر دارای تمام مجوزهای اساسی به علاوه مجوزهای اداری است که به آنها اجازه می دهد فضا را مانند اضافه کردن یا حذف اعضا مدیریت کنند. فقط در `SpaceType.SPACE` پشتیبانی می شود.

عضو کشور

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

Enums
`MEMBERSHIP_STATE_UNSPECIFIED`	مقدار پیش فرض استفاده نکنید.
`JOINED`	کاربر به فضا اضافه می شود و می تواند در فضا شرکت کند.
`INVITED`	از کاربر دعوت شده است تا به فضا بپیوندد ، اما به آن پیوسته است.
`NOT_A_MEMBER`	کاربر متعلق به فضا نیست و دعوت در انتظار برای پیوستن به فضا ندارد.

عضویت batchcreatedeventdata

بارگذاری رویداد برای چندین عضویت جدید.

نوع رویداد: google.workspace.chat.membership.v1.batchCreated

فیلدها

memberships[]

لیستی از عضویت های جدید.

عضویت batchdeletedeventdata

بارگذاری رویداد برای چندین عضویت حذف شده.

نوع رویداد: google.workspace.chat.membership.v1.batchDeleted

فیلدها

memberships[]

MembershipDeletedEventData

لیستی از عضویت های حذف شده.

عضویت batchupdatedeventdata

بارگذاری رویداد برای چندین عضویت به روز شده.

نوع رویداد: google.workspace.chat.membership.v1.batchUpdated

فیلدها

memberships[]

MembershipUpdatedEventData

لیستی از عضویت به روز شده.

عضویت

بارگیری رویداد برای عضویت جدید.

نوع رویداد: google.workspace.chat.membership.v1.created .

فیلدها

membership

عضویت جدید

عضویت deletedeventdata

بارگذاری رویداد برای عضویت حذف شده.

نوع رویداد: google.workspace.chat.membership.v1.deleted

فیلدها

membership

عضویت حذف شده. فقط name و زمینه های state جمع شده اند.

عضویت

بارگیری رویداد برای عضویت به روز شده.

نوع رویداد: google.workspace.chat.membership.v1.updated

فیلدها

membership

MessageCreatedEventData

عضویت به روز شده

پیام

پیامی در فضای گپ گوگل.

فیلدها
`name`	`string` شناسه. نام منبع پیام. قالب: `spaces/{space}/messages/{message}` جایی که `{space}` شناسه فضایی است که پیام در آن ارسال شده است و `{message}` یک شناسه تعیین شده توسط سیستم برای پیام است. به عنوان مثال ، `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` . اگر هنگام ایجاد پیام ، شناسه سفارشی را تنظیم کنید ، می توانید با جایگزینی `{message}` با مقدار از قسمت `clientAssignedMessageId` از این شناسه استفاده کنید. به عنوان مثال ، `spaces/AAAAAAAAAAA/messages/client-custom-name` . برای جزئیات بیشتر ، به یک پیام مراجعه کنید.
`sender`	`User` فقط خروجی کاربر که پیام را ایجاد کرده است. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی `name` و `type` کاربر را جمع می کند.
`create_time`	`Timestamp` اختیاری. تغییرناپذیر. برای فضاهای ایجاد شده در گپ ، زمانی که پیام ایجاد شده است. این قسمت فقط خروجی است ، به استثنای زمانی که در فضاهای حالت واردات استفاده می شود. برای فضاهای حالت واردات ، این قسمت را روی جدول زمانی تاریخی قرار دهید که در آن پیام در منبع ایجاد شده است تا زمان ایجاد اصلی ایجاد شود.
`last_update_time`	`Timestamp` فقط خروجی زمان آخرین پیام توسط یک کاربر ویرایش شده است. اگر پیام هرگز ویرایش نشده باشد ، این قسمت خالی است.
`delete_time`	`Timestamp` فقط خروجی زمان حذف پیام در Google Chat. اگر پیام هرگز حذف نشود ، این قسمت خالی است.
`text`	`string` اختیاری. متن ساده پیام از پیام. اولین لینک به یک تصویر ، فیلم یا صفحه وب تراشه پیش نمایش را ایجاد می کند. همچنین می توانید Mention یک کاربر Google Chat یا همه افراد موجود در فضا. برای کسب اطلاعات در مورد ایجاد پیام های متنی ، به ارسال پیام مراجعه کنید.
`formatted_text`	`string` فقط خروجی حاوی `text` پیام با نشانه گذاری های اضافه شده به قالب بندی ارتباط است. این زمینه ممکن است تمام قالب بندی های قابل مشاهده در UI را ضبط نکند ، اما موارد زیر را شامل می شود: علامت گذاری به عنوان Syntax برای جسورانه ، ایتالیایی ، Strikethrough ، Monospace ، Monospace Block و لیست گلوله. کاربر با استفاده از قالب `<users/{user}>` ذکر می کند. لینک های سفارشی با استفاده از فرمت `<{url}\|{rendered_text}>` که در آن رشته اول URL است و دوم متن ارائه شده - برای مثال ، `<http://example.com\|custom text>` . emoji سفارشی با استفاده از قالب `:{emoji_name}:` برای مثال ، `:smile:` این در مورد ایموجی های یونیکد ، مانند `U+1F600` برای ایموجی صورت پوزخند صدق نمی کند. برای اطلاعات بیشتر ، به مشاهده قالب بندی متن ارسال شده در یک پیام مراجعه کنید
`cards[] (deprecated)`	`Card` این مورد منسوخ شده است! deprecated: به جای آن از `cards_v2` استفاده کنید. کارتهای غنی ، فرمت شده و تعاملی که می توانید برای نمایش عناصر UI مانند: متون فرمت ، دکمه ها و تصاویر قابل کلیک استفاده کنید. کارتها به طور معمول در زیر بدنه متن ساده پیام نمایش داده می شوند. `cards` و `cards_v2` می توانند حداکثر اندازه 32 کیلوبایت داشته باشند.
`cards_v2[]`	`CardWithId` اختیاری. مجموعه ای از کارت ها . فقط برنامه های چت می توانند کارت ایجاد کنند. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، پیام ها نمی توانند حاوی کارت باشند. برای یادگیری نحوه ایجاد پیامی که حاوی کارت است ، به ارسال پیام مراجعه کنید. کارت های طراحی و پیش نمایش با سازنده کارت. سازنده کارت را باز کنید
`annotations[]`	`Annotation` فقط خروجی حاشیه نویسی های مرتبط با `text` در این پیام.
`thread`	`Thread` موضوع پیام متعلق به آن است. به عنوان مثال استفاده ، به شروع یا پاسخ به موضوع پیام مراجعه کنید.
`space`	`Space` فقط خروجی اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی فقط `name` فضایی را جمع می کند.
`fallback_text`	`string` اختیاری. شرح متن ساده از کارتهای پیام ، که در هنگام نمایش کارتهای واقعی استفاده نمی شود-برای مثال ، اعلان های موبایل.
`action_response`	`ActionResponse` فقط ورودی پارامترهایی که یک برنامه گپ می تواند برای پیکربندی نحوه ارسال پاسخ آن استفاده کند.
`argument_text`	`string` فقط خروجی متن ساده پیام با تمام برنامه های چت که از آن خارج شده است.
`slash_command`	`SlashCommand` فقط خروجی در صورت وجود اطلاعات فرمان Slash.
`attachment[]`	`Attachment` اختیاری. ضمیمه کاربر بارگیری شده.
`matched_url`	`MatchedUrl` فقط خروجی URL در `spaces.messages.text` که با یک الگوی پیش نمایش پیوند مطابقت دارد. برای اطلاعات بیشتر ، به پیوندهای پیش نمایش مراجعه کنید.
`thread_reply`	`bool` فقط خروجی هنگامی که `true` ، پیام در یک موضوع پاسخ پاسخی است. هنگامی که `false` ، پیام در مکالمه سطح بالای فضا به عنوان اولین پیام یک موضوع یا پیام بدون پاسخ موضوعی قابل مشاهده است. اگر فضا از پاسخ در موضوعات پشتیبانی نمی کند ، این قسمت همیشه `false` است.
`client_assigned_message_id`	`string` اختیاری. شناسه سفارشی برای پیام. می توانید از فیلد برای شناسایی یک پیام استفاده کنید ، یا برای دریافت ، حذف یا به روزرسانی پیام استفاده کنید. برای تنظیم شناسه سفارشی ، هنگام ایجاد پیام ، قسمت `messageId` را مشخص کنید. برای جزئیات بیشتر ، به یک پیام مراجعه کنید.
`emoji_reaction_summaries[]`	`EmojiReactionSummary` فقط خروجی لیست خلاصه واکنش ایموجی در پیام.
`private_message_viewer`	`User` اختیاری. تغییرناپذیر. ورودی برای ایجاد پیام ، در غیر این صورت فقط خروجی. کاربر که می تواند پیام را مشاهده کند. هنگام تنظیم ، پیام خصوصی است و فقط برای کاربر مشخص شده و برنامه چت قابل مشاهده است. 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's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.
`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 .

MessageBatchCreatedEventData

Event payload for multiple new messages.

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

فیلدها

messages[]

A list of new messages.

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

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

فیلدها

messages[]

MessageDeletedEventData

A list of deleted messages.

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

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

فیلدها

messages[]

MessageUpdatedEventData

A list of updated messages.

MessageCreatedEventData

Event payload for a new message.

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

فیلدها

message

The new message.

MessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

فیلدها

message

The deleted message. Only the name , createTime , deleteTime , and deletionMetadata fields are populated.

MessageUpdatedEventData

Event payload for an updated message.

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

فیلدها

message

ReactionCreatedEventData

The updated message.

QuotedMessageMetadata

Information about a quoted message.

فیلدها

name

string

فقط خروجی Resource name of the quoted message.

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

last_update_time

Timestamp

فقط خروجی The timestamp when the quoted message was created or when the quoted message was last updated.

واکنش

A reaction to a message.

فیلدها

name

string

شناسه. The resource name of the reaction.

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

user

User

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

emoji

Emoji

مورد نیاز. 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.

فیلدها
`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.

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.

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` شناسه. 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` این مورد منسوخ شده است! فقط خروجی 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` این مورد منسوخ شده است! فقط خروجی 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]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) . 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. Developer Preview: Available as part of the Google Workspace Developer Preview Program , which grants early access to certain features.
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: In Developer Preview , 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: In Developer Preview , 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 in
Developer Preview: Available as part of the Google Workspace Developer Preview Program , which grants early access to certain features.

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 spaces managers have this permission.

members_allowed

bool

اختیاری. Whether non-manager members 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. To learn more, see Work with events from 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

شناسه. 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

Timestamp

اختیاری. 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

شناسه. 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

Timestamp

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 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 .)

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