شاخص
-
ChatService
(رابط) -
AccessoryWidget
(پیام) -
ActionResponse
(پیام) -
ActionResponse.ResponseType
(enum) -
ActionResponse.SelectionItems
(پیام) -
ActionResponse.UpdatedWidget
(پیام) -
ActionStatus
(پیام) -
Annotation
(پیام) -
AnnotationType
(enum) -
AttachedGif
(پیام) -
Attachment
(پیام) -
Attachment.Source
(تعدادی) -
AttachmentDataRef
(پیام) -
CardWithId
(پیام) -
ChatSpaceLinkData
(پیام) -
CompleteImportSpaceRequest
(پیام) -
CompleteImportSpaceResponse
(پیام) -
ContextualAddOnMarkup
(پیام) -
ContextualAddOnMarkup.Card
(پیام) -
ContextualAddOnMarkup.Card.CardAction
(پیام) -
ContextualAddOnMarkup.Card.CardHeader
(پیام) -
ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum) -
ContextualAddOnMarkup.Card.Section
(پیام) -
CreateMembershipRequest
(پیام) -
CreateMessageRequest
(پیام) -
CreateMessageRequest.MessageReplyOption
(enum) -
CreateReactionRequest
(پیام) -
CreateSpaceRequest
(پیام) -
CustomEmoji
(پیام) -
DeleteMembershipRequest
(پیام) -
DeleteMessageRequest
(پیام) -
DeleteReactionRequest
(پیام) -
DeleteSpaceRequest
(پیام) -
DeletionMetadata
(پیام) -
DeletionMetadata.DeletionType
(enum) -
Dialog
(پیام) -
DialogAction
(پیام) -
DriveDataRef
(پیام) -
DriveLinkData
(پیام) -
Emoji
(پیام) -
EmojiReactionSummary
(پیام) -
FindDirectMessageRequest
(پیام) -
GetAttachmentRequest
(پیام) -
GetMembershipRequest
(پیام) -
GetMessageRequest
(پیام) -
GetSpaceEventRequest
(پیام) -
GetSpaceReadStateRequest
(پیام) -
GetSpaceRequest
(پیام) -
GetThreadReadStateRequest
(پیام) -
Group
(پیام) -
HistoryState
(تعدادی) -
ListMembershipsRequest
(پیام) -
ListMembershipsResponse
(پیام) -
ListMessagesRequest
(پیام) -
ListMessagesResponse
(پیام) -
ListReactionsRequest
(پیام) -
ListReactionsResponse
(پیام) -
ListSpaceEventsRequest
(پیام) -
ListSpaceEventsResponse
(پیام) -
ListSpacesRequest
(پیام) -
ListSpacesResponse
(پیام) -
MatchedUrl
(پیام) -
Membership
(پیام) -
Membership.MembershipRole
(enum) -
Membership.MembershipState
(تعدادی) -
MembershipBatchCreatedEventData
(پیام) -
MembershipBatchDeletedEventData
(پیام) -
MembershipBatchUpdatedEventData
(پیام) -
MembershipCreatedEventData
(پیام) -
MembershipDeletedEventData
(پیام) -
MembershipUpdatedEventData
(پیام) -
Message
(پیام) -
MessageBatchCreatedEventData
(پیام) -
MessageBatchDeletedEventData
(پیام) -
MessageBatchUpdatedEventData
(پیام) -
MessageCreatedEventData
(پیام) -
MessageDeletedEventData
(پیام) -
MessageUpdatedEventData
(پیام) -
QuotedMessageMetadata
(پیام) -
Reaction
(پیام) -
ReactionBatchCreatedEventData
(پیام) -
ReactionBatchDeletedEventData
(پیام) -
ReactionCreatedEventData
(پیام) -
ReactionDeletedEventData
(پیام) -
RichLinkMetadata
(پیام) -
RichLinkMetadata.RichLinkType
(enum) -
SearchSpacesRequest
(پیام) -
SearchSpacesResponse
(پیام) -
SetUpSpaceRequest
(پیام) -
SlashCommand
(پیام) -
SlashCommandMetadata
(پیام) -
SlashCommandMetadata.Type
(enum) -
Space
(پیام) -
Space.AccessSettings
(پیام) -
Space.AccessSettings.AccessState
(enum) -
Space.MembershipCount
(پیام) -
Space.PermissionSetting
(پیام) -
Space.PermissionSettings
(پیام) -
Space.PredefinedPermissionSettings
(enum) -
Space.SpaceDetails
(پیام) -
Space.SpaceThreadingState
(enum) -
Space.SpaceType
(enum) -
Space.Type
(enum) -
SpaceBatchUpdatedEventData
(پیام) -
SpaceEvent
(پیام) -
SpaceReadState
(پیام) -
SpaceUpdatedEventData
(پیام) -
Thread
(پیام) -
ThreadReadState
(پیام) -
UpdateMembershipRequest
(پیام) -
UpdateMessageRequest
(پیام) -
UpdateSpaceReadStateRequest
(پیام) -
UpdateSpaceRequest
(پیام) -
User
(پیام) -
User.Type
(enum) -
UserMentionMetadata
(پیام) -
UserMentionMetadata.Type
(enum) -
WidgetMarkup
(پیام) -
WidgetMarkup.Button
(پیام) -
WidgetMarkup.FormAction
(پیام) -
WidgetMarkup.FormAction.ActionParameter
(پیام) -
WidgetMarkup.Icon
(enum) -
WidgetMarkup.Image
(پیام) -
WidgetMarkup.ImageButton
(پیام) -
WidgetMarkup.KeyValue
(پیام) -
WidgetMarkup.OnClick
(پیام) -
WidgetMarkup.OpenLink
(پیام) -
WidgetMarkup.TextButton
(پیام) -
WidgetMarkup.TextParagraph
(پیام)
سرویس چت
به برنامهنویسان امکان میدهد تا برنامهها و ادغامهای Chat را در Google Chat Platform بسازند.
CompleteImportSpace |
---|
فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند. به احراز هویت برنامه و تفویض اختیار در سطح دامنه نیاز دارد. برای اطلاعات بیشتر، به مجوز برنامههای گپ Google برای وارد کردن دادهها مراجعه کنید.
|
ایجاد عضویت |
---|
یک عضویت برای برنامه چت تماس گیرنده، یک کاربر یا یک گروه Google ایجاد می کند. ایجاد عضویت برای سایر برنامههای گپ پشتیبانی نمیشود. هنگام ایجاد عضویت، اگر خطمشی پذیرش خودکار عضو مشخصشده خاموش باشد، دعوت میشود و باید قبل از پیوستن، دعوت فضایی را بپذیرد. در غیر این صورت، ایجاد عضویت، عضو را مستقیماً به فضای مشخص شده اضافه می کند. نیاز به احراز هویت کاربر دارد. برای مثال استفاده، نگاه کنید به:
|
ایجاد پیام |
---|
پیامی را در فضای چت Google ایجاد می کند. برای مثال، به ارسال پیام مراجعه کنید. متد تصویر زیر نشان می دهد که چگونه Chat هنگام استفاده از احراز هویت برنامه، پیامی را نسبت می دهد. Chat برنامه چت را به عنوان فرستنده پیام نمایش می دهد. محتوای پیام میتواند شامل متن ( تصویر زیر نشان میدهد که چگونه Chat هنگام استفاده از احراز هویت کاربر، یک پیام را مشخص میکند. Chat کاربر را به عنوان فرستنده پیام نمایش می دهد و برنامه Chat را با نمایش نام پیام به آن نسبت می دهد. محتوای پیام فقط می تواند حاوی متن ( حداکثر اندازه پیام، با احتساب محتوای پیام، 32000 بایت است.
|
CreateReaction |
---|
یک واکنش ایجاد می کند و آن را به یک پیام اضافه می کند. فقط ایموجی های یونیکد پشتیبانی می شوند. برای مثال، افزودن واکنش به پیام را ببینید. نیاز به احراز هویت کاربر دارد.
|
CreateSpace |
---|
فضایی با نام ایجاد می کند. فضاهای گروه بندی شده بر اساس موضوعات پشتیبانی نمی شوند. برای مثال، ایجاد فاصله را ببینید. اگر هنگام ایجاد یک فاصله، پیام خطای نیاز به احراز هویت کاربر دارد.
|
حذف عضویت |
---|
عضویت را حذف می کند. برای مثال، به حذف یک کاربر یا برنامه چت Google از یک فضا مراجعه کنید. نیاز به احراز هویت کاربر دارد.
|
DeleteMessage |
---|
یک پیام را حذف می کند. برای مثال، حذف یک پیام را ببینید. نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند. هنگام استفاده از احراز هویت برنامه، درخواستها فقط میتوانند پیامهای ایجاد شده توسط برنامه چت را حذف کنند.
|
DeleteReaction |
---|
واکنش به یک پیام را حذف می کند. فقط ایموجی های یونیکد پشتیبانی می شوند. برای مثال، حذف واکنش را ببینید. نیاز به احراز هویت کاربر دارد.
|
DeleteSpace |
---|
فضای نامگذاری شده را حذف می کند. همیشه یک حذف آبشاری انجام می دهد، به این معنی که منابع فرزند فضا - مانند پیام های ارسال شده در فضا و عضویت در فضا - نیز حذف می شوند. برای مثال، حذف یک فاصله را ببینید. نیاز به احراز هویت کاربر از کاربری دارد که اجازه حذف فضا را دارد.
|
FindDirectMessage |
---|
پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند. اگر فضای پیام مستقیم پیدا نشد، خطای با احراز هویت کاربر ، فضای پیام مستقیم بین کاربر مشخص شده و کاربر احراز هویت شده را برمی گرداند. با احراز هویت برنامه ، فضای پیام مستقیم بین کاربر مشخص شده و برنامه چت در حال تماس را برمیگرداند. به احراز هویت کاربر یا تأیید اعتبار برنامه نیاز دارد.
|
GetAttachment |
---|
فراداده یک پیوست پیام را دریافت می کند. دادههای پیوست با استفاده از API رسانه واکشی میشوند. برای مثال، به دریافت فراداده درباره پیوست پیام مراجعه کنید. نیاز به احراز هویت برنامه دارد.
|
GetMembership |
---|
جزئیات عضویت را برمیگرداند. برای مثال، به دریافت جزئیات درباره عضویت کاربر یا برنامه چت Google مراجعه کنید. نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.
|
GetMessage |
---|
جزئیات یک پیام را برمی گرداند. برای مثال، به دریافت جزئیات درباره یک پیام مراجعه کنید. نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند. توجه: ممکن است پیامی از یک عضو یا فضای مسدود شده بازگرداند.
|
GetSpace |
---|
جزئیات یک فضا را برمیگرداند. برای مثال، به دریافت جزئیات در مورد یک فضا مراجعه کنید. نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.
|
GetSpaceEvent |
---|
رویدادی را از فضای گپ Google برمیگرداند. بارگذاری رویداد حاوی جدیدترین نسخه منبعی است که تغییر کرده است. به عنوان مثال، اگر رویدادی را درباره یک پیام جدید درخواست کنید اما پیام بعداً بهروزرسانی شد، سرور منبع نیاز به احراز هویت کاربر دارد. برای دریافت یک رویداد، کاربر احراز هویت شده باید عضوی از فضا باشد. برای مثال، به دریافت جزئیات یک رویداد از فضای گپ Google مراجعه کنید.
|
GetSpaceReadState |
---|
جزئیات مربوط به وضعیت خوانده شده کاربر را در یک فضا باز می گرداند که برای شناسایی پیام های خوانده شده و خوانده نشده استفاده می شود. برای مثال، به دریافت جزئیات در مورد وضعیت خواندن فضای کاربر مراجعه کنید. نیاز به احراز هویت کاربر دارد.
|
GetThreadReadState |
---|
جزئیات مربوط به وضعیت خواندن کاربر در یک رشته را که برای شناسایی پیام های خوانده شده و خوانده نشده استفاده می شود، برمی گرداند. برای مثال، به دریافت جزئیات در مورد وضعیت خواندن رشته کاربر مراجعه کنید. نیاز به احراز هویت کاربر دارد.
|
لیست اعضا |
---|
عضویت ها را در یک فضا فهرست می کند. برای مثال، فهرست کاربران و برنامههای چت Google را در یک فضا ببینید. فهرست کردن عضویتها با احراز هویت برنامه ، عضویتها را در فضاهایی فهرست میکند که برنامه Chat به آنها دسترسی دارد، اما عضویتهای برنامه Chat، از جمله عضویت خود را استثنا نمیکند. فهرست کردن عضویتها با احراز هویت کاربر ، عضویتها را در فضاهایی فهرست میکند که کاربر احراز هویت شده به آنها دسترسی دارد. نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.
|
ListMessages |
---|
پیامها را در فضایی فهرست میکند که تماسگیرنده عضو آن است، از جمله پیامهای اعضای مسدود شده و فضاها. اگر پیامهایی را از یک فضای بدون پیام فهرست کنید، پاسخ یک شی خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی،
|
ListReactions |
---|
واکنش ها به یک پیام را فهرست می کند. برای مثال، فهرست واکنشها را برای یک پیام ببینید. نیاز به احراز هویت کاربر دارد.
|
ListSpaceEvents |
---|
رویدادها را از فضای چت Google فهرست می کند. برای هر رویداد، محموله حاوی جدیدترین نسخه منبع چت است. برای مثال، اگر رویدادهای مربوط به اعضای جدید فضایی را فهرست کنید، سرور منابع نیاز به احراز هویت کاربر دارد. برای فهرست کردن رویدادها، کاربر احراز هویت شده باید عضوی از فضا باشد. برای مثال، فهرست رویدادها را از فضای گپ Google ببینید.
|
ListSpaces |
---|
فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند. تا زمانی که اولین پیام ارسال نشود، چتهای گروهی و پیامهای پیامکی فهرست نمیشوند. برای مثال، لیست فاصله ها را ببینید. نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند. فضاهای قابل مشاهده برای تماس گیرنده یا کاربر تأیید شده را فهرست می کند. تا زمانی که اولین پیام ارسال نشود، چتهای گروهی و پیامهای پیامکی فهرست نمیشوند. برای فهرست کردن همه فضاهای نامگذاری شده توسط سازمان Google Workspace، به جای آن از روش
|
فضاهای جستجو |
---|
فهرستی از فضاها را بر اساس جستجوی کاربر برمیگرداند. نیاز به احراز هویت کاربر دارد. کاربر باید یک سرپرست برای سازمان Google Workspace باشد. در درخواست،
|
SetUpSpace |
---|
فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. کاربر تماس گیرنده به طور خودکار به فضا اضافه می شود و نباید به عنوان عضویت در درخواست مشخص شود. برای مثال، به تنظیم فضایی با اعضای اولیه مراجعه کنید. برای تعیین اعضای انسانی برای افزودن، عضویت هایی را با برای تعیین گروههای Google برای افزودن، عضویتها را با برای یک فضای نامگذاری شده یا چت گروهی، اگر تماس گیرنده مسدود شود، یا توسط برخی از اعضا مسدود شده باشد، یا اجازه اضافه کردن برخی از اعضا را نداشته باشد، آن اعضا به فضای ایجاد شده اضافه نمی شوند. برای ایجاد یک پیام مستقیم (DM) بین کاربر تماس گیرنده و کاربر انسانی دیگر، دقیقاً یک عضویت را برای نشان دادن کاربر انسانی مشخص کنید. اگر یکی از کاربران دیگری را مسدود کند، درخواست با شکست مواجه می شود و DM ایجاد نمی شود. برای ایجاد DM بین کاربر تماس گیرنده و برنامه تماس گیرنده، اگر یک DM از قبل بین دو کاربر وجود داشته باشد، حتی زمانی که یک کاربر در زمان درخواست، دیگری را مسدود کند، DM موجود برگردانده می شود. فضاهای دارای پاسخ رشته ای پشتیبانی نمی شوند. اگر هنگام تنظیم یک فاصله، پیام خطای نیاز به احراز هویت کاربر دارد.
|
به روز رسانی عضویت |
---|
عضویت را به روز می کند. برای مثال، بهروزرسانی عضویت کاربر در یک فضا را ببینید. نیاز به احراز هویت کاربر دارد.
|
UpdateMessage |
---|
یک پیام را به روز می کند. بین روش های نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند. هنگام استفاده از احراز هویت برنامه، درخواستها فقط میتوانند پیامهای ایجاد شده توسط برنامه چت را بهروزرسانی کنند.
|
UpdateSpace |
---|
یک فضا را به روز می کند. برای مثال، بهروزرسانی یک فاصله را ببینید. اگر فیلد نیاز به احراز هویت کاربر دارد.
|
UpdateSpaceReadState |
---|
وضعیت خواندن کاربر را در یک فضا به روز می کند، که برای شناسایی پیام های خوانده شده و خوانده نشده استفاده می شود. برای مثال، بهروزرسانی وضعیت خواندن فضای کاربر را ببینید. نیاز به احراز هویت کاربر دارد.
|
ابزارک لوازم جانبی
یک یا چند ویجت تعاملی که در پایین یک پیام ظاهر می شود. برای جزئیات، به افزودن ویجتهای تعاملی در پایین پیام رجوع کنید.
فیلدها | |
---|---|
action میدانی اتحادیه نوع عمل. action فقط می تواند یکی از موارد زیر باشد: | |
button_list | لیستی از دکمه ها |
ActionResponse
پارامترهایی که یک برنامه چت می تواند برای پیکربندی نحوه ارسال پاسخ خود استفاده کند.
فیلدها | |
---|---|
type | فقط ورودی نوع پاسخ برنامه چت. |
url | فقط ورودی URL برای احراز هویت یا پیکربندی کاربران. (فقط برای انواع پاسخ |
dialog_action | فقط ورودی پاسخی به یک رویداد تعاملی مربوط به یک گفتگو . باید با |
updated_widget | فقط ورودی پاسخ ویجت به روز شده. |
نوع پاسخ
نوع پاسخ برنامه چت.
Enums | |
---|---|
TYPE_UNSPECIFIED | نوع پیشفرض که بهعنوان NEW_MESSAGE استفاده میشود. |
NEW_MESSAGE | به عنوان یک پیام جدید در تاپیک ارسال کنید. |
UPDATE_MESSAGE | پیام برنامه چت را به روز کنید. این فقط در رویداد CARD_CLICKED که نوع فرستنده پیام BOT است مجاز است. |
UPDATE_USER_MESSAGE_CARDS | کارت ها را در پیام کاربر به روز کنید. این فقط به عنوان پاسخی به یک رویداد MESSAGE با نشانی اینترنتی منطبق، یا یک رویداد CARD_CLICKED که نوع فرستنده پیام HUMAN است مجاز است. متن نادیده گرفته می شود. |
REQUEST_CONFIG | به طور خصوصی از کاربر برای احراز هویت یا پیکربندی اضافی بخواهید. |
DIALOG | دیالوگی ارائه می دهد. |
UPDATE_WIDGET | پرس و جو گزینه های تکمیل خودکار متن ویجت. |
انتخاب آیتم ها
فهرست نتایج تکمیل خودکار ویجت.
فیلدها | |
---|---|
items[] | آرایه ای از اشیاء SelectionItem. |
ویجت به روز شده
پاسخ ویجت به روز شده. برای ارائه گزینه های تکمیل خودکار برای یک ویجت استفاده می شود.
فیلدها | |
---|---|
widget | شناسه ویجت به روز شده. شناسه باید با شناسه ویجتی که درخواست بهروزرسانی را راهاندازی کرده، مطابقت داشته باشد. |
فیلد اتحادیه updated_widget . ویجت در پاسخ به اقدام کاربر به روز شد. updated_widget فقط می تواند یکی از موارد زیر باشد: | |
suggestions | فهرست نتایج تکمیل خودکار ویجت |
ActionStatus
وضعیت درخواست برای فراخوانی یا ارسال گفتگو را نشان می دهد.
فیلدها | |
---|---|
status_code | کد وضعیت. |
user_facing_message | پیامی برای ارسال به کاربران در مورد وضعیت درخواست آنها. اگر تنظیم نشود، یک پیام عمومی بر اساس |
حاشیه نویسی
فقط خروجی حاشیه نویسی مرتبط با متن ساده پیام. برای افزودن قالببندی اولیه به پیام نوشتاری، به قالببندی پیامهای متنی مراجعه کنید.
مثال متن پیام ساده:
Hello @FooBot how are you!"
فراداده حاشیه نویسی مربوطه:
"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 | نوع این حاشیه نویسی |
length | طول رشته فرعی در متن پیام متنی ساده با این حاشیه نویسی مطابقت دارد. |
start_index | نمایه شروع (بر اساس 0، شامل) در متن پیام متنی ساده که این حاشیه نویسی با آن مطابقت دارد. |
metadata میدان اتحادیه فراداده اضافی در مورد حاشیه نویسی. metadata تنها می تواند یکی از موارد زیر باشد: | |
user_mention | فراداده ذکر کاربر. |
slash_command | ابرداده برای یک دستور اسلش. |
rich_link_metadata | ابرداده برای یک پیوند غنی. |
AnnotationType
نوع حاشیه نویسی
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED | مقدار پیش فرض برای enum. استفاده نکنید. |
USER_MENTION | یک کاربر ذکر شده است. |
SLASH_COMMAND | یک دستور اسلش فراخوانی می شود. |
RICH_LINK | حاشیه نویسی پیوند غنی |
گیف پیوست شده
یک تصویر GIF که توسط یک URL مشخص شده است.
فیلدها | |
---|---|
uri | فقط خروجی URL که میزبان تصویر GIF است. |
پیوست
یک پیوست در Google Chat.
فیلدها | |
---|---|
name | نام منبع پیوست، به شکل |
content_name | فقط خروجی نام فایل اصلی برای محتوا، نه مسیر کامل. |
content_type | فقط خروجی نوع محتوا (نوع MIME) فایل. |
thumbnail_uri | فقط خروجی نشانی اینترنتی تصویر کوچکی که باید برای پیش نمایش پیوست یک کاربر انسانی استفاده شود. برنامههای گپ نباید از این نشانی اینترنتی برای دانلود محتوای پیوست استفاده کنند. |
download_uri | فقط خروجی URL دانلودی که باید از آن استفاده شود تا کاربر انسانی بتواند پیوست را دانلود کند. برنامههای گپ نباید از این نشانی اینترنتی برای دانلود محتوای پیوست استفاده کنند. |
source | فقط خروجی منبع پیوست |
فیلد اتحادیه data_ref . ارجاع داده به پیوست data_ref تنها می تواند یکی از موارد زیر باشد: | |
attachment_data_ref | ارجاع به داده های پیوست این فیلد با API رسانه برای دانلود داده های پیوست استفاده می شود. |
drive_data_ref | فقط خروجی ارجاع به پیوست Google Drive. این فیلد با Google Drive API استفاده می شود. |
منبع
منبع پیوست
Enums | |
---|---|
SOURCE_UNSPECIFIED | رزرو شده است. |
DRIVE_FILE | فایل یک فایل گوگل درایو است. |
UPLOADED_CONTENT | فایل در چت آپلود می شود. |
AttachmentDataRef
ارجاع به داده های پیوست
فیلدها | |
---|---|
resource_name | نام منبع داده های پیوست. این فیلد با API رسانه برای دانلود داده های پیوست استفاده می شود. |
attachment_upload_token | نشانه مات حاوی ارجاع به پیوست آپلود شده. توسط کلاینتها بهعنوان یک رشته غیرشفاف تلقی میشود و برای ایجاد یا بهروزرسانی پیامهای چت با پیوستها استفاده میشود. |
CardWithId
کارتی در پیام چت Google.
فقط برنامههای چت میتوانند کارت ایجاد کنند. اگر برنامه چت شما به عنوان کاربر احراز هویت شود ، پیام نمیتواند حاوی کارت باشد.
طراحی و پیش نمایش کارت ها با Card Builder.
کارت ساز را باز کنیدفیلدها | |
---|---|
card_id | اگر پیام حاوی چندین کارت باشد، الزامی است. یک شناسه منحصر به فرد برای یک کارت در یک پیام. |
card | یک کارت حداکثر حجم 32 کیلوبایت است. |
ChatSpaceLinkData
داده برای پیوندهای فضای چت.
فیلدها | |
---|---|
space | فضای منبع فضای چت پیوند شده. قالب: |
thread | رشته منبع فضای چت پیوند شده. قالب: |
message | پیام منبع فضای چت پیوند شده. قالب: |
CompleteImportSpaceRequest
درخواست پیام برای تکمیل فرآیند واردات برای یک فضا.
فیلدها | |
---|---|
name | مورد نیاز. نام منبع فضای حالت واردات. قالب: |
CompleteImportSpaceResponse
پیام پاسخ برای تکمیل فرآیند واردات برای یک فضا.
فیلدها | |
---|---|
space | فضای حالت واردات. |
ContextualAddOnMarkup
این نوع هیچ فیلدی ندارد.
نشانه گذاری برای توسعه دهندگان برای تعیین محتوای یک AddOn متنی.
کارت
کارت یک عنصر رابط کاربری است که می تواند حاوی ویجت های رابط کاربری مانند متن و تصویر باشد.
فیلدها | |
---|---|
header | هدر کارت. یک هدر معمولاً حاوی یک عنوان و یک تصویر است. |
sections[] | بخش ها توسط یک تقسیم کننده خط از هم جدا می شوند. |
card_actions[] | اقدامات این کارت. |
name | نام کارت. |
CardAction
اکشن کارت، عمل مرتبط با کارت است. برای یک کارت فاکتور، یک اقدام معمولی این است: حذف فاکتور، فاکتور ایمیل یا باز کردن فاکتور در مرورگر.
توسط برنامههای چت Google پشتیبانی نمیشود.
فیلدها | |
---|---|
action_label | برچسب قبلاً در آیتم منوی عمل نمایش داده می شد. |
on_click | عمل onclick برای این مورد اقدام. |
سربرگ کارت
فیلدها | |
---|---|
title | عنوان باید مشخص شود. هدر دارای ارتفاع ثابتی است: اگر عنوان و عنوان فرعی هر دو مشخص شده باشد، هر کدام یک خط را اشغال می کنند. اگر فقط عنوان مشخص شده باشد، هر دو خط را می گیرد. |
subtitle | زیرنویس هدر کارت. |
image_style | نوع تصویر (به عنوان مثال، حاشیه مربع یا حاشیه دایره ای). |
image_url | URL تصویر در هدر کارت. |
ImageStyle
Enums | |
---|---|
IMAGE_STYLE_UNSPECIFIED | |
IMAGE | حاشیه مربع. |
AVATAR | حاشیه دایره ای |
بخش
یک بخش شامل مجموعه ای از ویجت ها است که به ترتیبی که مشخص شده اند (به صورت عمودی) ارائه می شوند. در همه پلتفرمها، کارتها دارای عرض ثابت باریکی هستند، بنابراین در حال حاضر نیازی به ویژگیهای طرحبندی (مثلاً شناور) نیست.
فیلدها | |
---|---|
header | سربرگ بخش. متن قالب بندی شده پشتیبانی می شود. برای اطلاعات بیشتر درباره قالببندی متن، به قالببندی متن در برنامههای چت Google و قالببندی متن در افزونههای Google Workspace مراجعه کنید. |
widgets[] | یک بخش باید حداقل دارای یک ویجت باشد. |
ایجاد درخواست عضویت
درخواست پیام برای ایجاد عضویت.
فیلدها | |
---|---|
parent | مورد نیاز. نام منبع فضایی که برای آن عضویت ایجاد می شود. قالب: spaces/{space} |
membership | مورد نیاز. رابطه عضویت برای ایجاد. فیلد |
use_admin_access | وقتی کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به محدوده ایجاد عضویت در برنامه یا ایجاد عضویت برای کاربران خارج از سازمان Google Workspace سرپرست با استفاده از دسترسی سرپرست پشتیبانی نمیشود. |
CreateMessageRequest
پیامی ایجاد می کند.
فیلدها | |
---|---|
parent | مورد نیاز. نام منبع فضایی که در آن پیام ایجاد می شود. قالب: |
message | مورد نیاز. متن پیام |
thread_key | اختیاری. منسوخ شده: به جای آن از |
request_id | اختیاری. یک شناسه درخواست منحصر به فرد برای این پیام. تعیین شناسه درخواست موجود، پیام ایجاد شده با آن شناسه را به جای ایجاد یک پیام جدید برمی گرداند. |
message_reply_option | اختیاری. مشخص می کند که آیا یک پیام یک رشته را شروع می کند یا به یکی پاسخ می دهد. فقط در فضاهای نامگذاری شده پشتیبانی می شود. |
message_id | اختیاری. یک شناسه سفارشی برای یک پیام. به برنامههای گپ اجازه میدهد بدون نیاز به ذخیره شناسه اختصاص داده شده به سیستم در نام منبع پیام (که در قسمت مقدار این فیلد باید شرایط زیر را داشته باشد:
برای جزئیات، به نام پیام مراجعه کنید. |
MessageReplyOption
نحوه پاسخ دادن به یک پیام را مشخص می کند. ممکن است در آینده ایالت های بیشتری اضافه شود.
Enums | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED | پیش فرض یک تاپیک جدید راه اندازی می کند. با استفاده از این گزینه، thread ID یا موجود در آن نادیده گرفته میشود. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD | پیام را به عنوان پاسخی به رشته ای که توسط thread ID یا مشخص شده است ایجاد می کند. اگر شکست بخورد، پیام به جای آن یک رشته جدید شروع می کند. |
REPLY_MESSAGE_OR_FAIL | پیام را به عنوان پاسخی به رشته ای که توسط thread ID یا مشخص شده است ایجاد می کند. اگر یک thread_key جدید استفاده شود، یک رشته جدید ایجاد می شود. اگر ایجاد پیام ناموفق باشد، به جای آن یک خطای NOT_FOUND برگردانده می شود. |
CreateReactionRequest
واکنشی به پیام ایجاد می کند.
فیلدها | |
---|---|
parent | مورد نیاز. پیامی که در آن واکنش ایجاد می شود. قالب: |
reaction | مورد نیاز. واکنش به ایجاد. |
CreateSpaceRequest
درخواستی برای ایجاد فضایی با نام.
فیلدها | |
---|---|
space | مورد نیاز. فیلدهای اگر پیام خطای |
request_id | اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می شود. تعیین شناسه درخواست موجود، به جای ایجاد فضای جدید، فضای ایجاد شده با آن شناسه را برمی گرداند. مشخص کردن شناسه درخواست موجود از همان برنامه چت با کاربر تأیید شده متفاوت، یک خطا برمیگرداند. |
ایموجی سفارشی
نشان دهنده یک ایموجی سفارشی است.
فیلدها | |
---|---|
uid | فقط خروجی کلید منحصر به فرد برای منبع ایموجی سفارشی. |
DeleteMembership Request
درخواست حذف عضویت در یک فضا.
فیلدها | |
---|---|
name | مورد نیاز. نام منبع عضویت برای حذف. برنامه های چت می توانند عضویت کاربران انسانی یا خود آنها را حذف کنند. برنامههای چت نمیتوانند عضویت برنامههای دیگر را حذف کنند. هنگام حذف عضویت انسانی، به قالب هنگام حذف عضویت برنامه، به محدوده و قالب: |
use_admin_access | وقتی کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به محدوده حذف عضویت برنامه در یک فضا با استفاده از دسترسی سرپرست پشتیبانی نمیشود. |
DeleteMessageRequest
درخواست حذف پیام
فیلدها | |
---|---|
name | مورد نیاز. نام منبع پیام قالب: اگر یک شناسه سفارشی برای پیام خود تنظیم کردهاید، میتوانید از مقدار فیلد |
force | وقتی فقط هنگام احراز هویت به عنوان کاربر اعمال می شود. هنگام احراز هویت به عنوان یک برنامه چت تأثیری ندارد. |
DeleteReactionRequest
واکنش به یک پیام را حذف می کند.
فیلدها | |
---|---|
name | مورد نیاز. نام واکنش برای حذف. قالب: |
DeleteSpaceRequest
درخواست حذف فاصله
فیلدها | |
---|---|
name | مورد نیاز. نام منبع فضایی که باید حذف شود. قالب: |
use_admin_access | وقتی کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به محدوده |
حذف متادیتا
اطلاعاتی در مورد پیام حذف شده زمانی که delete_time
تنظیم شده باشد، پیامی حذف می شود.
فیلدها | |
---|---|
deletion_type | نشان می دهد که چه کسی پیام را حذف کرده است. |
نوع حذف
چه کسی پیام را حذف کرد و چگونه حذف شد.
Enums | |
---|---|
DELETION_TYPE_UNSPECIFIED | این مقدار استفاده نشده است. |
CREATOR | کاربر پیام خود را حذف کرد. |
SPACE_OWNER | مالک فضا پیام را حذف کرد. |
ADMIN | یک سرپرست Google Workspace پیام را حذف کرد. |
APP_MESSAGE_EXPIRY | یک برنامه چت پیام خود را پس از انقضا حذف کرد. |
CREATOR_VIA_APP | یک برنامه چت پیام را از طرف کاربر حذف کرد. |
SPACE_OWNER_VIA_APP | یک برنامه چت پیام را از طرف مالک فضا حذف کرد. |
گفتگو
بسته بندی در اطراف بدنه کارت گفتگو.
فیلدها | |
---|---|
body | فقط ورودی بدنه گفتگو که به صورت مودال ارائه می شود. برنامههای گپ Google از موجودیتهای کارت زیر پشتیبانی نمیکنند: |
DialogAction
حاوی یک گفتگو و کد وضعیت درخواست است.
فیلدها | |
---|---|
action_status | فقط ورودی وضعیت درخواست برای فراخوانی یا ارسال گفتگو . در صورت لزوم وضعیت و پیامی را برای کاربران نمایش می دهد. مثلاً در صورت خطا یا موفقیت. |
action میدانی اتحادیه اقدام برای انجام. action فقط می تواند یکی از موارد زیر باشد: | |
dialog | فقط ورودی گفتگو برای درخواست |
DriveDataRef
ارجاع به داده های پیوست درایو.
فیلدها | |
---|---|
drive_file_id | شناسه فایل درایو با Drive API استفاده کنید. |
DriveLinkData
داده برای پیوندهای Google Drive.
فیلدها | |
---|---|
drive_data_ref | یک DriveDataRef که به یک فایل Google Drive ارجاع می دهد. |
mime_type | نوع mime منبع Google Drive پیوند شده. |
ایموجی
ایموجی که به عنوان واکنش به یک پیام استفاده می شود.
فیلدها | |
---|---|
content زمینه اتحادیه محتوای ایموجی. content فقط می تواند یکی از موارد زیر باشد: | |
unicode | یک ایموجی اصلی که با یک رشته یونیکد نمایش داده می شود. |
custom_emoji | فقط خروجی یک ایموجی سفارشی |
EmojiReactionSummary
تعداد افرادی که با یک ایموجی خاص به پیام واکنش نشان دادند.
فیلدها | |
---|---|
emoji | ایموجی های مرتبط با واکنش. |
reaction_count | تعداد کل واکنش ها با استفاده از ایموجی های مرتبط. |
FindDirectMessagerequest
درخواستی برای دریافت فضای پیام مستقیم بر اساس منبع کاربر.
فیلدها | |
---|---|
name | مورد نیاز. نام منبع کاربر برای یافتن پیام مستقیم با. قالب: |
GetAttachmentRequest
درخواست دریافت پیوست.
فیلدها | |
---|---|
name | مورد نیاز. نام منبع ضمیمه ، در |
GetMembershipRequest
درخواست عضویت در یک فضا.
فیلدها | |
---|---|
name | مورد نیاز. نام منابع عضویت برای بازیابی. برای به دست آوردن عضویت خود برنامه با استفاده از تأیید اعتبار کاربر ، می توانید به صورت اختیاری از قالب: هنگامی که به عنوان کاربر تأیید می شود ، می توانید از ایمیل کاربر به عنوان نام مستعار برای |
use_admin_access | در صورت کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد. نیاز به دریافت عضویت در برنامه در یک فضا هنگام استفاده از Admin Access پشتیبانی نمی شود. |
GetMessagerEquest
درخواست دریافت پیام
فیلدها | |
---|---|
name | مورد نیاز. نام منبع پیام. قالب: اگر یک شناسه سفارشی را برای پیام خود تنظیم کرده اید ، می توانید از قسمت |
getSpaceEventRequest
برای دریافت یک رویداد فضایی پیام را درخواست کنید.
فیلدها | |
---|---|
name | مورد نیاز. نام منابع رویداد فضایی. قالب: |
getSpacereadStaterequest
درخواست پیام برای API GetSpacereadState.
فیلدها | |
---|---|
name | مورد نیاز. نام منابع از حالت خوانده شده برای بازیابی. فقط از خواندن حالت خوانده شده برای کاربر فراخوانی پشتیبانی می کند. برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید:
قالب: کاربران/{کاربر}/فضاها/{فضا}/SpacereadState |
GetSpacereQuest
درخواست بازگشت یک فضای واحد.
فیلدها | |
---|---|
name | مورد نیاز. نام منبع فضا ، در قالب: |
use_admin_access | در صورت کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد. به Scopes |
getThreadReadStateRequest
پیام درخواست GetThreadReadStateRequest API.
فیلدها | |
---|---|
name | مورد نیاز. نام منبع موضوع موضوع را برای بازیابی. فقط از خواندن حالت خوانده شده برای کاربر فراخوانی پشتیبانی می کند. برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید:
فرمت: کاربران/{کاربر}/فضاها/{فضا}/موضوع/{موضوع}/ThreadReadState |
گروه
یک گروه Google در Google Chat.
فیلدها | |
---|---|
name | نام منابع برای یک گروه Google. گروهی در گروه های هویت ابری API را نشان می دهد. قالب: گروه ها/{گروه} |
تاریخچه
وضعیت تاریخ برای پیام ها و فضاها. مشخص می کند که چه مدت پیام ها و موضوعات مکالمه پس از ایجاد نگهداری می شوند.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED | مقدار پیش فرض استفاده نکنید. |
HISTORY_OFF | تاریخ خاموش. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند . |
HISTORY_ON | تاریخ در. قوانین حفظ طاق سازمان مشخص می کند که چه مدت پیام ها و موضوعات نگه داشته می شوند. |
listmembershipsrequest
درخواست پیام برای لیست عضویت.
فیلدها | |
---|---|
parent | مورد نیاز. نام منبع فضایی که می توانید لیست عضویت را بدست آورید. قالب: فضاها/{فضا} |
page_size | اختیاری. حداکثر تعداد عضویت برای بازگشت. این سرویس ممکن است کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 100 عضویت بازگردانده می شوند. حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد. مقادیر منفی یک خطای |
page_token | اختیاری. یک نشان صفحه ، از یک تماس قبلی برای لیست عضویت دریافت شده است. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود. |
filter | اختیاری. یک فیلتر پرس و جو. شما می توانید عضویت در نقش ( برای فیلتر کردن بر اساس نقش ، برای فیلتر کردن بر اساس نوع ، برای فیلتر کردن توسط هر دو نقش و نوع ، از اپراتور هر دو به عنوان مثال ، نمایش داده های زیر معتبر است:
نمایش داده های زیر نامعتبر است:
نمایش داده شدگان نامعتبر توسط سرور با یک خطای |
show_groups | اختیاری. در صورت |
show_invited | اختیاری. هنگامی که در حال حاضر به تأیید اعتبار کاربر نیاز دارد. |
use_admin_access | در صورت کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد. به لیست عضویت در برنامه در یک فضا هنگام استفاده از Admin Access پشتیبانی نمی شود. |
listmembershipsresponse
پاسخ به لیست عضویت در فضا.
فیلدها | |
---|---|
memberships[] | لیست بدون هماهنگ. لیست عضویت در صفحه درخواست شده (یا اول). |
next_page_token | نشانه ای که می توانید به عنوان |
ListMessagesRequest
پیام ها را در فضای مشخص شده لیست می کند ، که کاربر عضو آن است.
فیلدها | |
---|---|
parent | مورد نیاز. نام منبع فضا برای لیست پیام ها از. قالب: |
page_size | حداکثر تعداد پیام های برگشت یافته. این سرویس ممکن است پیام های کمتری از این مقدار بازگرداند. در صورت نامشخص ، حداکثر 25 نفر بازگردانده می شوند. حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد. مقادیر منفی یک خطای |
page_token | اختیاری ، در صورت از سرگیری از یک پرس و جو قبلی. یک صفحه صفحه دریافت شده از تماس پیام های لیست قبلی. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود. |
filter | یک فیلتر پرس و جو. می توانید پیام ها را بر اساس تاریخ ( برای فیلتر کردن پیام ها در تاریخ ایجاد شده ، برای فیلتر کردن بر روی نخ ، برای فیلتر کردن توسط موضوع و تاریخ ، از اپراتور به عنوان مثال ، نمایش داده های زیر معتبر است:
نمایش داده شدگان نامعتبر توسط سرور با یک خطای |
order_by | اختیاری ، در صورت از سرگیری از یک پرس و جو قبلی. نحوه سفارش لیست پیام ها. یک مقدار برای سفارش توسط یک عملیات سفارش را مشخص کنید. مقادیر عملیاتی سفارش معتبر به شرح زیر است:
سفارش پیش فرض |
show_deleted | آیا پیام های حذف شده را شامل می شود. پیام های حذف شده شامل زمان حذف شده و ابرداده در مورد حذف آنها هستند ، اما محتوای پیام در دسترس نیست. |
listMessagesResponse
پیام پاسخ برای لیست پیام ها.
فیلدها | |
---|---|
messages[] | لیست پیام ها |
next_page_token | برای بازیابی صفحه بعدی نتایج می توانید یک نشانه را به عنوان |
خطی
واکنش های یک پیام را لیست می کند.
فیلدها | |
---|---|
parent | مورد نیاز. کاربران پیام به آنها واکنش نشان دادند. قالب: |
page_size | اختیاری. حداکثر تعداد واکنشهای برگشت یافته. این سرویس می تواند واکنش های کمتری نسبت به این مقدار بازگرداند. اگر نامشخص باشد ، مقدار پیش فرض 25 است. حداکثر مقدار 200 است. مقادیر بالاتر از 200 به 200 تغییر می یابد. |
page_token | اختیاری. (در صورت از سرگیری از یک پرس و جو قبلی.) یک نشان صفحه دریافت شده از تماس واکنش لیست قبلی. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، مقدار فیلتر باید با تماس ارائه شده با صفحه مطابقت داشته باشد. عبور از یک مقدار متفاوت ممکن است منجر به نتایج غیر منتظره شود. |
filter | اختیاری. یک فیلتر پرس و جو. می توانید واکنش های emoji ( برای فیلتر کردن واکنش برای چندین ایموجی یا کاربران ، به قسمتهای مشابه با اپراتور برای فیلتر کردن واکنش توسط ایموجی و کاربر ، از اپراتور اگر پرس و جو شما از هر به عنوان مثال ، نمایش داده های زیر معتبر است:
نمایش داده های زیر نامعتبر است:
نمایش داده شدگان نامعتبر توسط سرور با یک خطای |
پاسخ
پاسخ به درخواست واکنش لیست.
فیلدها | |
---|---|
reactions[] | لیست واکنش ها در صفحه درخواست شده (یا اول). |
next_page_token | نشانه ادامه برای بازیابی صفحه بعدی نتایج. برای آخرین صفحه نتایج خالی است. |
listSpaceEventSrequest
درخواست پیام برای لیست رویدادهای فضایی.
فیلدها | |
---|---|
parent | مورد نیاز. نام منبع فضای چت Google که در آن وقایع رخ داده است. قالب: |
page_size | اختیاری. حداکثر تعداد وقایع فضایی برگشت. این سرویس ممکن است کمتر از این مقدار برگردد. مقادیر منفی یک خطای |
page_token | یک صفحه صفحه ، که از لیست قبلی رویدادهای فضایی دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده برای لیست رویدادهای فضایی باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود. |
filter | مورد نیاز. یک فیلتر پرس و جو. شما باید حداقل یک نوع رویداد ( به صورت اختیاری ، می توانید با زمان شروع (
برای مشخص کردن زمان شروع یا پایان ، از Equals به عنوان مثال ، نمایش داده های زیر معتبر است:
نمایش داده های زیر نامعتبر است:
نمایش داده شدگان نامعتبر توسط سرور با یک خطای |
فضیلت
پیام پاسخ برای لیست رویدادهای فضایی.
فیلدها | |
---|---|
space_events[] | نتایج به ترتیب زمانی بازگردانده می شوند (قدیمی ترین رویداد اول). |
next_page_token | توکن ادامه برای واکشی رویدادهای بیشتر. اگر این قسمت از بین برود ، هیچ صفحه بعدی وجود ندارد. |
ListSpacesRequest
درخواستی برای لیست فضاهایی که تماس گیرنده عضو آن است.
فیلدها | |
---|---|
page_size | اختیاری. حداکثر تعداد فضاها برای بازگشت. این سرویس ممکن است کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 100 فضای بازگردانده می شوند. حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد. مقادیر منفی یک خطای |
page_token | اختیاری. یک صفحه صفحه ، که از تماس فضاهای لیست قبلی دریافت شده است. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، مقدار فیلتر باید با تماس ارائه شده با صفحه مطابقت داشته باشد. عبور از یک مقدار متفاوت ممکن است منجر به نتایج غیر منتظره شود. |
filter | اختیاری. یک فیلتر پرس و جو. می توانید فضاها را بر اساس نوع فضایی ( برای فیلتر کردن بر اساس نوع فضایی ، باید مقدار معتبر Enum مانند به عنوان مثال ، نمایش داده های زیر معتبر است:
نمایش داده شدگان نامعتبر توسط سرور با یک خطای |
لیست
پاسخ درخواست فضاهای لیست.
فیلدها | |
---|---|
spaces[] | لیست فضاهای موجود در صفحه درخواست شده (یا اول). |
next_page_token | برای بازیابی صفحه بعدی نتایج می توانید یک نشانه را به عنوان |
کابوس
یک URL همسان در یک پیام گپ. برنامه های چت می توانند URL های همسان را پیش نمایش کنند. برای اطلاعات بیشتر ، به پیوندهای پیش نمایش مراجعه کنید.
فیلدها | |
---|---|
url | فقط خروجی URL که مطابقت داشت. |
عضویت
یک رابطه عضویت در Google Chat را نشان می دهد ، مانند اینکه کاربر یا برنامه چت به بخشی از آن دعوت شده است ، یا از یک فضا غایب است.
فیلدها | |
---|---|
name | نام منابع عضویت ، اختصاص داده شده توسط سرور. قالب: |
state | فقط خروجی وضعیت عضویت. |
role | اختیاری. نقش کاربر در یک فضای گپ ، که اقدامات مجاز آنها را در فضا تعیین می کند. این قسمت فقط می تواند به عنوان ورودی در |
create_time | اختیاری. تغییر ناپذیر زمان ایجاد عضویت ، مانند زمانی که یک عضو به آن پیوست یا برای پیوستن به یک فضا دعوت شده بود. این قسمت فقط خروجی است ، به جز در مواردی که برای وارد کردن عضویت های تاریخی در فضاهای حالت واردات استفاده می شود. |
delete_time | اختیاری. تغییر ناپذیر زمان حذف عضویت ، مانند زمانی که یک عضو از آنجا خارج شد یا از یک فضا خارج شد. این قسمت فقط خروجی است ، به جز در مواردی که برای وارد کردن عضویت های تاریخی در فضاهای حالت واردات استفاده می شود. |
عضو اتحادیه memberType . عضو مرتبط با این عضویت. انواع دیگر اعضا ممکن است در آینده پشتیبانی شوند. memberType می تواند تنها یکی از موارد زیر باشد: | |
member | کاربر یا برنامه Google CHAT که عضویت دارد با آن مطابقت دارد. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی |
group_member | گروه 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[] | لیستی از عضویت های حذف شده. |
عضویت batchupdatedeventdata
بارگذاری رویداد برای چندین عضویت به روز شده.
نوع رویداد: google.workspace.chat.membership.v1.batchUpdated
فیلدها | |
---|---|
memberships[] | لیستی از عضویت به روز شده. |
عضویت
بارگیری رویداد برای عضویت جدید.
نوع رویداد: google.workspace.chat.membership.v1.created
.
فیلدها | |
---|---|
membership | عضویت جدید |
عضویت deletedeventdata
بارگذاری رویداد برای عضویت حذف شده.
نوع رویداد: google.workspace.chat.membership.v1.deleted
فیلدها | |
---|---|
membership | عضویت حذف شده. فقط |
عضویت
بارگیری رویداد برای عضویت به روز شده.
نوع رویداد: google.workspace.chat.membership.v1.updated
فیلدها | |
---|---|
membership | عضویت به روز شده |
پیام
پیامی در فضای گپ گوگل.
فیلدها | |
---|---|
name | نام منبع پیام. قالب: جایی که اگر هنگام ایجاد پیام ، شناسه سفارشی را تنظیم کنید ، می توانید با جایگزینی |
sender | فقط خروجی کاربر که پیام را ایجاد کرده است. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی |
create_time | اختیاری. تغییر ناپذیر برای فضاهای ایجاد شده در گپ ، زمانی که پیام ایجاد شده است. این قسمت فقط خروجی است ، به استثنای زمانی که در فضاهای حالت واردات استفاده می شود. برای فضاهای حالت واردات ، این قسمت را روی جدول زمانی تاریخی قرار دهید که در آن پیام در منبع ایجاد شده است تا زمان ایجاد اصلی ایجاد شود. |
last_update_time | فقط خروجی زمان آخرین پیام توسط یک کاربر ویرایش شده است. اگر پیام هرگز ویرایش نشده باشد ، این قسمت خالی است. |
delete_time | فقط خروجی زمان حذف پیام در Google Chat. اگر پیام هرگز حذف نشود ، این قسمت خالی است. |
text | متن ساده پیام از پیام. اولین لینک به یک تصویر ، فیلم یا صفحه وب تراشه پیش نمایش را ایجاد می کند. همچنین می توانید Mention یک کاربر Google Chat یا همه افراد موجود در فضا. برای کسب اطلاعات در مورد ایجاد پیام های متنی ، به ارسال پیام مراجعه کنید. |
formatted_text | فقط خروجی حاوی
برای اطلاعات بیشتر ، به مشاهده قالب بندی متن ارسال شده در یک پیام مراجعه کنید |
cards[] | deprecated: به جای آن از کارتهای غنی ، فرمت شده و تعاملی که می توانید برای نمایش عناصر UI مانند: متون فرمت ، دکمه ها و تصاویر قابل کلیک استفاده کنید. کارتها به طور معمول در زیر بدنه متن ساده پیام نمایش داده می شوند. |
cards_v2[] | مجموعه ای از کارت ها . فقط برنامه های چت می توانند کارت ایجاد کنند. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، پیام ها نمی توانند حاوی کارت باشند. برای یادگیری نحوه ایجاد پیامی که حاوی کارت است ، به ارسال پیام مراجعه کنید. کارت های طراحی و پیش نمایش با سازنده کارت. کارت ساز را باز کنید |
annotations[] | فقط خروجی حاشیه نویسی های مرتبط با |
thread | موضوع پیام متعلق به آن است. به عنوان مثال استفاده ، به شروع یا پاسخ به موضوع پیام مراجعه کنید. |
space | اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی |
fallback_text | شرح متن ساده از کارتهای پیام ، که در هنگام نمایش کارتهای واقعی استفاده نمی شود-برای مثال ، اعلان های موبایل. |
action_response | فقط ورودی پارامترهایی که یک برنامه گپ می تواند برای پیکربندی نحوه ارسال پاسخ آن استفاده کند. |
argument_text | فقط خروجی متن ساده پیام با تمام برنامه های چت که از آن خارج شده است. |
slash_command | فقط خروجی در صورت وجود اطلاعات فرمان Slash. |
attachment[] | ضمیمه کاربر بارگیری شده. |
matched_url | فقط خروجی URL در |
thread_reply | فقط خروجی هنگامی که اگر فضا از پاسخ در موضوعات پشتیبانی نمی کند ، این قسمت همیشه |
client_assigned_message_id | اختیاری. شناسه سفارشی برای پیام. می توانید از فیلد برای شناسایی یک پیام استفاده کنید ، یا برای دریافت ، حذف یا به روزرسانی پیام استفاده کنید. برای تنظیم شناسه سفارشی ، هنگام ایجاد پیام ، قسمت |
emoji_reaction_summaries[] | فقط خروجی لیست خلاصه واکنش ایموجی در پیام. |
private_message_viewer | تغییر ناپذیر ورودی برای ایجاد پیام ، در غیر این صورت فقط خروجی. کاربر که می تواند پیام را مشاهده کند. هنگام تنظیم ، پیام خصوصی است و فقط برای کاربر مشخص شده و برنامه چت قابل مشاهده است. پیش نمایش ها و پیوست های پیوند برای پیام های خصوصی پشتیبانی نمی شوند. فقط برنامه های چت می توانند پیام های خصوصی ارسال کنند. اگر برنامه چت شما به عنوان کاربر برای ارسال پیام تأیید می شود ، پیام نمی تواند خصوصی باشد و باید این قسمت را حذف کند. برای جزئیات بیشتر ، به ارسال پیام خصوصی مراجعه کنید. |
deletion_metadata | فقط خروجی اطلاعات مربوط به یک پیام حذف شده. هنگام تنظیم |
quoted_message_metadata | فقط خروجی اطلاعات مربوط به پیامی که توسط یک کاربر Google Chat در یک فضا نقل شده است. کاربران Google CHAT می توانند برای پاسخ به آن پیامی را نقل کنند. |
attached_gifs[] | فقط خروجی تصاویر GIF که به پیام پیوست شده اند. |
accessory_widgets[] | یک یا چند ابزارک تعاملی که در پایین یک پیام ظاهر می شوند. می توانید ویجت های لوازم جانبی را به پیام هایی که حاوی متن ، کارت یا متن و کارت هستند اضافه کنید. برای پیام هایی که حاوی گفتگو هستند پشتیبانی نمی شوند. برای جزئیات بیشتر ، به افزودن ابزارک های تعاملی در پایین یک پیام مراجعه کنید. ایجاد پیام با ابزارک های لوازم جانبی نیاز به تأیید اعتبار برنامه دارد. |
پیام batchcreatedeventdata
بارگذاری رویداد برای چندین پیام جدید.
نوع رویداد: google.workspace.chat.message.v1.batchCreated
فیلدها | |
---|---|
messages[] | لیستی از پیام های جدید |
پیام batchdeletedeventdata
بار رویداد برای چندین پیام حذف شده.
نوع رویداد: google.workspace.chat.message.v1.batchDeleted
فیلدها | |
---|---|
messages[] | لیستی از پیام های حذف شده. |
پیام batchupdatedeventdata
بارگذاری رویداد برای چندین پیام به روز شده.
نوع رویداد: google.workspace.chat.message.v1.batchUpdated
فیلدها | |
---|---|
messages[] | لیستی از پیام های به روز شده. |
adgecreatedeventdata
بارگیری رویداد برای یک پیام جدید.
نوع رویداد: google.workspace.chat.message.v1.created
فیلدها | |
---|---|
message | پیام جدید |
sessagedeletedeventdata
بارگیری رویداد برای یک پیام حذف شده.
نوع رویداد: google.workspace.chat.message.v1.deleted
فیلدها | |
---|---|
message | پیام حذف شده فقط زمینه های |
messageupdatedeventdata
بارگیری رویداد برای یک پیام به روز شده.
نوع رویداد: google.workspace.chat.message.v1.updated
فیلدها | |
---|---|
message | پیام به روز شده |
به نقل از messagemetadata
اطلاعات مربوط به یک پیام نقل شده.
فیلدها | |
---|---|
name | فقط خروجی نام منبع پیام نقل شده. قالب: |
last_update_time | فقط خروجی زمانی که پیام نقل شده ایجاد شد یا آخرین پیام نقل شده به روز شد. |
واکنش
واکنشی به یک پیام.
فیلدها | |
---|---|
name | نام منبع واکنش. قالب: |
user | فقط خروجی کاربر که واکنش را ایجاد کرده است. |
emoji | ایموجی های مورد استفاده در واکنش. |
واکنش
بار رویداد برای چندین واکنش جدید.
نوع رویداد: google.workspace.chat.reaction.v1.batchCreated
فیلدها | |
---|---|
reactions[] | لیستی از واکنشهای جدید. |
واکنش
بار رویداد برای چندین واکنش حذف شده.
نوع رویداد: google.workspace.chat.reaction.v1.batchDeleted
فیلدها | |
---|---|
reactions[] | لیستی از واکنشهای حذف شده. |
واکنش نشان داد
بارگذاری رویداد برای یک واکنش جدید.
نوع رویداد: google.workspace.chat.reaction.v1.created
فیلدها | |
---|---|
reaction | واکنش جدید |
واکنشدهم
بارگذاری رویداد برای یک واکنش حذف شده.
نوع: google.workspace.chat.reaction.v1.deleted
فیلدها | |
---|---|
reaction | واکنش حذف شده |
ریچلینکمتاداتا
پیوند غنی به یک منبع.
فیلدها | |
---|---|
uri | URI این لینک. |
rich_link_type | نوع لینک غنی. |
data میدانی اتحادیه. داده ها برای منبع مرتبط. data فقط می توانند یکی از موارد زیر باشند: | |
drive_link_data | داده ها برای یک لینک درایو. |
chat_space_link_data | داده ها برای یک لینک فضایی چت. |
نوع غنی
نوع لینک غنی. انواع بیشتری ممکن است در آینده اضافه شود.
Enums | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED | مقدار پیش فرض برای enum. استفاده نکنید |
DRIVE_FILE | یک نوع پیوند غنی از Google Drive. |
CHAT_SPACE | یک نوع پیوند غنی از فضای چت. به عنوان مثال ، یک تراشه هوشمند فضایی. |
SearchspacesRequest
درخواست برای جستجوی لیستی از فضاها بر اساس یک پرس و جو کنید.
فیلدها | |
---|---|
use_admin_access | در صورت کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد. به دامنه این روش در حال حاضر فقط از دسترسی سرپرست پشتیبانی می کند ، بنابراین |
page_size | حداکثر تعداد فضاها برای بازگشت. این سرویس ممکن است کمتر از این مقدار برگردد. در صورت نامشخص ، حداکثر 100 فضای بازگردانده می شوند. حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد. |
page_token | یک نشانه ، دریافت شده از تماس های فضاهای جستجوی قبلی. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید. هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود. |
query | مورد نیاز. یک پرس و جو جستجو می توانید با استفاده از پارامترهای زیر جستجو کنید:
در زمینه های مختلف ، فقط در میان همان زمینه ، نمایشگاه های مثال زیر معتبر هستند:
|
order_by | اختیاری. نحوه سفارش لیست فضاها. ویژگی های پشتیبانی شده برای سفارش توسط:
مقادیر عملیاتی سفارش معتبر عبارتند از:
نحو پشتیبانی شده عبارتند از:
|
جستجو
پاسخ با لیستی از فضاهای مربوط به درخواست فضاهای جستجو.
فیلدها | |
---|---|
spaces[] | صفحه ای از فضاهای درخواست شده. |
next_page_token | نشانه ای که می تواند برای بازیابی صفحه بعدی استفاده شود. اگر این قسمت خالی باشد ، هیچ صفحه بعدی وجود ندارد. |
total_size | تعداد کل فضاهایی که با پرس و جو مطابقت دارند ، در تمام صفحات. اگر نتیجه بیش از 10،000 فضای باشد ، این مقدار تخمین است. |
setupspacerequest
درخواست ایجاد یک فضا و اضافه کردن کاربران مشخص به آن.
فیلدها | |
---|---|
space | مورد نیاز. قسمت برای ایجاد یک فضا ، برای ایجاد یک گپ گروهی ، برای ایجاد یک مکالمه 1: 1 بین انسان ، برای ایجاد یک مکالمه 1: 1 بین یک برنامه چت انسان و فراخوان ، اگر یک فضای |
request_id | اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می شود. مشخص کردن شناسه درخواست موجود ، فضای ایجاد شده با آن شناسه را به جای ایجاد یک فضای جدید باز می گرداند. مشخص کردن شناسه درخواست موجود از همان برنامه چت با کاربر معتبر متفاوت خطایی را برمی گرداند. |
memberships[] | اختیاری. کاربران یا گروه های Google Chat برای دعوت به پیوستن به فضا. کاربر فراخوانی را حذف کنید ، زیرا آنها به طور خودکار اضافه می شوند. این مجموعه در حال حاضر تا 20 عضویت (علاوه بر تماس گیرنده) اجازه می دهد. برای عضویت در انسانی ، قسمت برای عضویت در Google Group ، قسمت اختیاری هنگام تنظیم در هنگام تنظیم در هنگام تنظیم هنگام ایجاد مکالمه 1: 1 بین یک برنامه چت انسان و تماس (هنگام تنظیم |
ازمون
یک دستور slash در Google Chat.
فیلدها | |
---|---|
command_id | شناسه فرمان Slash فراخوانی شد. |
Slashcommandmetadata
ابرداده حاشیه نویسی برای دستورات slash (/).
فیلدها | |
---|---|
bot | برنامه چت که فرمان آن فراخوانی شده است. |
type | نوع فرمان slash. |
command_name | نام فرمان slash فراخوانی شده. |
command_id | شناسه فرمان فرمان Slash فراخوانی شده. |
triggers_dialog | نشان می دهد که آیا دستور slash برای یک گفتگو است یا خیر. |
تایپ کنید
Enums | |
---|---|
TYPE_UNSPECIFIED | مقدار پیش فرض برای enum. استفاده نکنید |
ADD | برنامه چت را به فضا اضافه کنید. |
INVOKE | از دستور Slash در فضا استفاده کنید. |
فضا
فضایی در گپ گوگل. فضاها مکالمه بین دو یا چند کاربر یا پیام 1: 1 بین کاربر و یک برنامه چت هستند.
فیلدها | |
---|---|
name | نام منبع فضا. قالب: جایی که |
type | فقط خروجی Deprecated: Use |
space_type | 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 | اختیاری. Whether the space is a DM between a Chat app and a single human. |
threaded | فقط خروجی Deprecated: Use |
display_name | The space's display name. Required when creating a space . If you receive the error message For direct messages, this field might be empty. Supports up to 128 characters. |
external_user_allowed | Immutable. 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:
For existing spaces, this field is output only. |
space_threading_state | فقط خروجی The threading state in the Chat space. |
space_details | Details about the space including description and rules. |
space_history_state | The message history state for messages and threads in this space. |
import_mode | اختیاری. Whether this space is created in |
create_time | اختیاری. Immutable. 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 |
last_active_time | فقط خروجی Timestamp of the last message in the space. |
admin_installed | فقط خروجی 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 | فقط خروجی The count of joined memberships grouped by member type. Populated when the |
access_settings | اختیاری. Specifies the access setting of the space. Only populated when the |
space_uri | فقط خروجی The URI for a user to access the space. |
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 | اختیاری. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in the |
permission_settings | اختیاری. Exact permission settings which can be set to update the space. Input for updating a space. Otherwise, output only. For space creation, use |
AccessSettings
Represents the access setting of the space.
فیلدها | |
---|---|
access_state | فقط خروجی Indicates the access state of the space. |
audience | اختیاری. 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: To use the default target audience for the Google Workspace organization, set to |
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 . |
MembershipCount
Represents the count of memberships of a space, grouped into categories.
فیلدها | |
---|---|
joined_direct_human_user_count | Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. |
joined_group_count | Count of all groups that have directly joined the space. |
PermissionSetting
Represents a space permission setting.
فیلدها | |
---|---|
managers_allowed | Whether spaces managers have this permission. |
members_allowed | Whether non-manager members have this permission. |
PermissionSettings
Permission settings for a named space. To set permission settings when creating a space, specify the PredefinedPermissionSettings
field in your request.
فیلدها | |
---|---|
manage_members_and_groups | Setting for managing members and groups in a space. |
modify_space_details | Setting for updating space name, avatar, description and guidelines. |
toggle_history | Setting for toggling space history on and off. |
use_at_mention_all | Setting for using @all in a space. |
manage_apps | Setting for managing apps in a space. |
manage_webhooks | Setting for managing webhooks in a space. |
post_messages | فقط خروجی Setting for posting messages in a space. |
reply_messages | Setting for replying to messages in a space. |
PredefinedPermissionSettings
The space permission settings that you can 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 | نامشخص Don't use. |
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 | اختیاری. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. |
guidelines | اختیاری. 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[] | 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 | Resource name of the space event. Format: |
event_time | Time when the event occurred. |
event_type | 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 Supported event types for messages :
Supported event types for memberships :
Supported event types for reactions :
Supported event types about the space :
|
Union field | |
message_created_event_data | Event payload for a new message. Event type: |
message_updated_event_data | Event payload for an updated message. Event type: |
message_deleted_event_data | Event payload for a deleted message. Event type: |
message_batch_created_event_data | Event payload for multiple new messages. Event type: |
message_batch_updated_event_data | Event payload for multiple updated messages. Event type: |
message_batch_deleted_event_data | Event payload for multiple deleted messages. Event type: |
space_updated_event_data | Event payload for a space update. Event type: |
space_batch_updated_event_data | Event payload for multiple updates to a space. Event type: |
membership_created_event_data | Event payload for a new membership. Event type: |
membership_updated_event_data | Event payload for an updated membership. Event type: |
membership_deleted_event_data | Event payload for a deleted membership. Event type: |
membership_batch_created_event_data | Event payload for multiple new memberships. Event type: |
membership_batch_updated_event_data | Event payload for multiple updated memberships. Event type: |
membership_batch_deleted_event_data | Event payload for multiple deleted memberships. Event type: |
reaction_created_event_data | Event payload for a new reaction. Event type: |
reaction_deleted_event_data | Event payload for a deleted reaction. Event type: |
reaction_batch_created_event_data | Event payload for multiple new reactions. Event type: |
reaction_batch_deleted_event_data | Event payload for multiple deleted reactions. Event type: |
SpaceReadState
A user's read state within a space, used to identify read and unread messages.
فیلدها | |
---|---|
name | Resource name of the space read state. Format: |
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 | Resource name of the thread. Example: |
thread_key | اختیاری. 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 |
ThreadReadState
A user's read state within a thread, used to identify read and unread messages.
فیلدها | |
---|---|
name | Resource name of the thread read state. Format: |
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 | مورد نیاز. The field paths to update. Separate multiple values with commas or use Currently supported field paths:
|
use_admin_access | When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the |
UpdateMessageRequest
Request to update a message.
فیلدها | |
---|---|
message | مورد نیاز. Message with fields updated. |
update_mask | مورد نیاز. The field paths to update. Separate multiple values with commas or use Currently supported field paths:
|
allow_missing | اختیاری. If |
UpdateSpaceReadStateRequest
Request message for UpdateSpaceReadState API.
فیلدها | |
---|---|
space_read_state | مورد نیاز. 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:
Format: users/{user}/spaces/{space}/spaceReadState |
update_mask | مورد نیاز. The field paths to update. Currently supported field paths:
When the To mark the space as read, set |
UpdateSpaceRequest
A request to update a single space.
فیلدها | |
---|---|
space | مورد نیاز. Space with fields to be updated. |
update_mask | مورد نیاز. The updated field paths, comma separated if there are multiple. You can update the following fields for a space:
|
use_admin_access | When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the Some |
کاربر
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 | Resource name for a Google Chat Format: For
|
display_name | فقط خروجی The user's display name. |
domain_id | Unique identifier of the user's Google Workspace domain. |
type | User type. |
is_anonymous | فقط خروجی When |
تایپ کنید
Enums | |
---|---|
TYPE_UNSPECIFIED | Default value for the enum. استفاده نکنید. |
HUMAN | Human user. |
BOT | Chat app user. |
UserMentionMetadata
Annotation metadata for user mentions (@).
فیلدها | |
---|---|
user | The user mentioned. |
type | The type of user mention. |
تایپ کنید
Enums | |
---|---|
TYPE_UNSPECIFIED | Default value for the enum. Don't use. |
ADD | Add user to space. |
MENTION | Mention user in space. |
WidgetMarkup
A widget is a UI element that presents text and images.
فیلدها | |
---|---|
buttons[] | A list of buttons. Buttons is also |
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 | Display a text paragraph in this widget. |
image | Display an image in this widget. |
key_value | Display a key value item in this widget. |
دکمه
A button. Can be a text button or an image button.
فیلدها | |
---|---|
Union field | |
text_button | A button with text and |
image_button | A button with image and |
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 | 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[] | 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 | The name of the parameter for the action script. |
value | 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 | The URL of the image. |
on_click | The |
aspect_ratio | 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. |
ImageButton
An image button with an onclick
action.
فیلدها | |
---|---|
on_click | The |
name | The name of this |
Union field icons . The icon can be specified by an Icon enum or a URL. icons can be only one of the following: | |
icon | The icon specified by an |
icon_url | 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 | 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 | 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 | If the content should be multiline. |
bottom_label | 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 | The |
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 | An enum value that's replaced by the Chat API with the corresponding icon image. |
icon_url | 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 | A button that can be clicked to trigger an action. |
OnClick
An onclick
action (for example, open a link).
فیلدها | |
---|---|
Union field | |
action | A form action is triggered by this |
open_link | This |
OpenLink
A link that opens a new window.
فیلدها | |
---|---|
url | The URL to open. |
TextButton
A button with text and onclick
action.
فیلدها | |
---|---|
text | The text of the button. |
on_click | The |
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 | |