Package google.chat.v1

شاخص

سرویس چت

به برنامه‌نویسان امکان می‌دهد تا برنامه‌ها و ادغام‌های Chat را در Google Chat Platform بسازند.

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse )

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

محدوده مجوز

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

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

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

ایجاد عضویت

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership )

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

برای مثال استفاده، نگاه کنید به:

محدوده مجوز

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

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

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

ایجاد پیام

rpc CreateMessage( CreateMessageRequest ) returns ( Message )

پیامی را در فضای چت Google ایجاد می کند. برای مثال، به ارسال پیام مراجعه کنید.

متد create() به احراز هویت کاربر یا برنامه نیاز دارد. Chat بسته به نوع احراز هویتی که در درخواست خود استفاده می کنید، فرستنده پیام را متفاوت نسبت می دهد.

تصویر زیر نشان می دهد که چگونه Chat هنگام استفاده از احراز هویت برنامه، پیامی را نسبت می دهد. Chat برنامه چت را به عنوان فرستنده پیام نمایش می دهد. محتوای پیام می‌تواند شامل متن ( text )، کارت‌ها ( cardsV2 ) و ابزارک‌های جانبی ( accessoryWidgets ) باشد.

پیام با احراز هویت برنامه ارسال شد

تصویر زیر نشان می‌دهد که چگونه Chat هنگام استفاده از احراز هویت کاربر، یک پیام را مشخص می‌کند. Chat کاربر را به عنوان فرستنده پیام نمایش می دهد و برنامه Chat را با نمایش نام پیام به آن نسبت می دهد. محتوای پیام فقط می تواند حاوی متن ( text ) باشد.

پیام با احراز هویت کاربر ارسال شد

حداکثر اندازه پیام، با احتساب محتوای پیام، 32000 بایت است.

محدوده مجوز

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

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

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

CreateReaction

rpc CreateReaction( CreateReactionRequest ) returns ( Reaction )

یک واکنش ایجاد می کند و آن را به یک پیام اضافه می کند. فقط ایموجی های یونیکد پشتیبانی می شوند. برای مثال، افزودن واکنش به پیام را ببینید. نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

CreateSpace

rpc CreateSpace( CreateSpaceRequest ) returns ( Space )

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

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

اگر عضو برنامه Developer Preview هستید، می توانید با استفاده از spaceType.GROUP_CHAT یک چت گروهی در حالت واردات ایجاد کنید.

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

حذف عضویت

rpc DeleteMembership( DeleteMembershipRequest ) returns ( Membership )

عضویت را حذف می کند. برای مثال، به حذف یک کاربر یا برنامه چت Google از یک فضا مراجعه کنید.

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

DeleteMessage

rpc DeleteMessage( DeleteMessageRequest ) returns ( Empty )

یک پیام را حذف می کند. برای مثال، حذف یک پیام را ببینید.

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

محدوده مجوز

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

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

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

DeleteReaction

rpc DeleteReaction( DeleteReactionRequest ) returns ( Empty )

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

محدوده مجوز

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

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

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

DeleteSpace

rpc DeleteSpace( DeleteSpaceRequest ) returns ( Empty )

فضای نامگذاری شده را حذف می کند. همیشه یک حذف آبشاری انجام می دهد، به این معنی که منابع فرزند فضا - مانند پیام های ارسال شده در فضا و عضویت در فضا - نیز حذف می شوند. برای مثال، حذف یک فاصله را ببینید. نیاز به احراز هویت کاربر از کاربری دارد که اجازه حذف فضا را دارد.

محدوده مجوز

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

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

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

FindDirectMessage

rpc FindDirectMessage( FindDirectMessageRequest ) returns ( Space )

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

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

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

به احراز هویت کاربر یا تأیید اعتبار برنامه نیاز دارد.

محدوده مجوز

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

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

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

GetAttachment

rpc GetAttachment( GetAttachmentRequest ) returns ( Attachment )

فراداده یک پیوست پیام را دریافت می کند. داده‌های پیوست با استفاده از API رسانه واکشی می‌شوند. برای مثال، به دریافت فراداده درباره پیوست پیام مراجعه کنید. به احراز هویت برنامه نیاز دارد.

محدوده مجوز

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

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

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

GetMembership

rpc GetMembership( GetMembershipRequest ) returns ( Membership )

جزئیات عضویت را برمی‌گرداند. برای مثال، به دریافت جزئیات درباره عضویت کاربر یا برنامه چت Google مراجعه کنید.

نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.

محدوده مجوز

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

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

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

GetMessage

rpc GetMessage( GetMessageRequest ) returns ( Message )

جزئیات یک پیام را برمی گرداند. برای مثال، به دریافت جزئیات درباره یک پیام مراجعه کنید.

نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.

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

محدوده مجوز

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

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

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

GetSpace

rpc GetSpace( GetSpaceRequest ) returns ( Space )

جزئیات یک فضا را برمی‌گرداند. برای مثال، به دریافت جزئیات در مورد یک فضا مراجعه کنید.

نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.

محدوده مجوز

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

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

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

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent )

رویدادی را از فضای گپ Google برمی‌گرداند. بارگذاری رویداد حاوی جدیدترین نسخه منبعی است که تغییر کرده است. به عنوان مثال، اگر رویدادی را درباره یک پیام جدید درخواست کنید اما پیام بعداً به‌روزرسانی شد، سرور منبع Message به‌روز شده را در بارگذاری رویداد برمی‌گرداند.

نیاز به احراز هویت کاربر دارد. برای دریافت یک رویداد، کاربر احراز هویت شده باید عضوی از فضا باشد.

برای مثال، به دریافت جزئیات یک رویداد از فضای گپ Google مراجعه کنید.

محدوده مجوز

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

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

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

GetSpaceReadState

rpc GetSpaceReadState( GetSpaceReadStateRequest ) returns ( SpaceReadState )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

GetThreadReadState

rpc GetThreadReadState( GetThreadReadStateRequest ) returns ( ThreadReadState )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

لیست اعضا

rpc ListMemberships( ListMembershipsRequest ) returns ( ListMembershipsResponse )

عضویت ها را در یک فضا فهرست می کند. برای مثال، فهرست کاربران و برنامه‌های چت Google را در یک فضا ببینید. فهرست کردن عضویت‌ها با احراز هویت برنامه ، عضویت‌ها را در فضاهایی فهرست می‌کند که برنامه Chat به آنها دسترسی دارد، اما عضویت‌های برنامه Chat، از جمله عضویت خود را استثنا نمی‌کند. فهرست کردن عضویت‌ها با احراز هویت کاربر ، عضویت‌ها را در فضاهایی فهرست می‌کند که کاربر احراز هویت شده به آنها دسترسی دارد.

نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.

محدوده مجوز

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

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

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

ListMessages

rpc ListMessages( ListMessagesRequest ) returns ( ListMessagesResponse )

پیام‌ها را در فضایی فهرست می‌کند که تماس‌گیرنده عضو آن است، از جمله پیام‌های اعضای مسدود شده و فضاها. اگر پیام‌هایی را از یک فضای بدون پیام فهرست کنید، پاسخ یک شی خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی، {} است. برای مثال، فهرست پیام‌ها را ببینید. نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

ListReactions

rpc ListReactions( ListReactionsRequest ) returns ( ListReactionsResponse )

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

محدوده مجوز

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

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

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

ListSpaceEvents

rpc ListSpaceEvents( ListSpaceEventsRequest ) returns ( ListSpaceEventsResponse )

رویدادها را از فضای چت Google فهرست می کند. برای هر رویداد، محموله حاوی جدیدترین نسخه منبع چت است. برای مثال، اگر رویدادهای مربوط به اعضای جدید فضایی را فهرست کنید، سرور منابع Membership را که حاوی آخرین جزئیات عضویت است، برمی‌گرداند. اگر اعضای جدید در طول دوره درخواستی حذف شوند، بار رویداد حاوی یک منبع Membership خالی است.

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

برای مثال، فهرست رویدادها را از فضای گپ Google ببینید.

محدوده مجوز

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

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

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

ListSpaces

rpc ListSpaces( ListSpacesRequest ) returns ( ListSpacesResponse )

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

نیاز به احراز هویت از احراز هویت برنامه و احراز هویت کاربر پشتیبانی می کند.

فضاهای قابل مشاهده برای تماس گیرنده یا کاربر تأیید شده را فهرست می کند. تا زمانی که اولین پیام ارسال نشود، چت‌های گروهی و پیام‌های پیامکی فهرست نمی‌شوند.

برای فهرست کردن همه فضاهای نامگذاری شده توسط سازمان Google Workspace، به جای آن از روش spaces.search() با استفاده از امتیازات سرپرست Workspace استفاده کنید.

محدوده مجوز

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

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

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

فضاهای جستجو

rpc SearchSpaces( SearchSpacesRequest ) returns ( SearchSpacesResponse )

فهرستی از فضاها را بر اساس جستجوی کاربر برمی‌گرداند. نیاز به احراز هویت کاربر دارد. کاربر باید یک سرپرست برای سازمان Google Workspace باشد. در درخواست، use_admin_access روی true تنظیم کنید.

محدوده مجوز

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

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

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

SetUpSpace

rpc SetUpSpace( SetUpSpaceRequest ) returns ( Space )

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

برای تعیین اعضای انسانی برای افزودن، عضویت هایی را با membership.member.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 کاربر را به فضا اضافه کنید.

برای تعیین گروه‌های Google برای افزودن، عضویت‌ها را با membership.group_member.name مناسب اضافه کنید. برای افزودن یا دعوت یک گروه Google، از groups/{group} استفاده کنید، جایی که {group} id گروه از Cloud Identity Groups API است. برای مثال، می‌توانید از API جستجوی Cloud Identity Groups برای بازیابی شناسه 123456789 برای ایمیل گروهی group@example.com استفاده کنید، سپس می‌توانید با تنظیم membership.group_member.name به groups/123456789 گروه را به فضا اضافه کنید. ایمیل گروهی پشتیبانی نمی‌شود و گروه‌های Google را فقط می‌توان به‌عنوان عضو در فضاهای نام‌گذاری شده اضافه کرد.

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

برای ایجاد یک پیام مستقیم (DM) بین کاربر تماس گیرنده و کاربر انسانی دیگر، دقیقاً یک عضویت را برای نشان دادن کاربر انسانی مشخص کنید. اگر یکی از کاربران دیگری را مسدود کند، درخواست با شکست مواجه می شود و DM ایجاد نمی شود.

برای ایجاد DM بین کاربر تماس گیرنده و برنامه تماس گیرنده، Space.singleUserBotDm را روی true تنظیم کنید و هیچ عضویتی را مشخص نکنید. شما فقط می توانید از این روش برای تنظیم DM با برنامه تماس استفاده کنید. برای افزودن برنامه تماس به عنوان عضوی از یک فضا یا یک DM موجود بین دو کاربر انسانی، به دعوت کردن یا افزودن یک کاربر یا برنامه به یک فضا مراجعه کنید.

اگر یک DM از قبل بین دو کاربر وجود داشته باشد، حتی زمانی که یک کاربر در زمان درخواست، دیگری را مسدود کند، DM موجود برگردانده می شود.

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

به روز رسانی عضویت

rpc UpdateMembership( UpdateMembershipRequest ) returns ( Membership )

عضویت را به روز می کند. برای مثال، به‌روزرسانی عضویت کاربر در یک فضا را ببینید.

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

UpdateMessage

rpc UpdateMessage( UpdateMessageRequest ) returns ( Message )

یک پیام را به روز می کند. بین روش های patch و update تفاوت وجود دارد. متد patch از یک درخواست patch استفاده می کند در حالی که روش update از یک درخواست put استفاده می کند. توصیه می کنیم از روش patch استفاده کنید. برای مثال، به‌روزرسانی یک پیام را ببینید.

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

محدوده مجوز

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

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

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

UpdateSpace

rpc UpdateSpace( UpdateSpaceRequest ) returns ( Space )

یک فضا را به روز می کند. برای مثال، به‌روزرسانی یک فاصله را ببینید.

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

UpdateSpaceReadState

rpc UpdateSpaceReadState( UpdateSpaceReadStateRequest ) returns ( SpaceReadState )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

ابزارک لوازم جانبی

یک یا چند ویجت تعاملی که در پایین یک پیام ظاهر می شود. برای جزئیات، به افزودن ویجت‌های تعاملی در پایین پیام رجوع کنید.

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

ButtonList

لیستی از دکمه ها

ActionResponse

پارامترهایی که یک برنامه چت می تواند برای پیکربندی نحوه ارسال پاسخ خود استفاده کند.

فیلدها
type

ResponseType

فقط ورودی نوع پاسخ برنامه چت.

url

string

فقط ورودی URL برای احراز هویت یا پیکربندی کاربران. (فقط برای انواع پاسخ REQUEST_CONFIG .)

dialog_action

DialogAction

فقط ورودی پاسخی به یک رویداد تعاملی مربوط به یک گفتگو . باید با ResponseType.Dialog همراه باشد.

updated_widget

UpdatedWidget

فقط ورودی پاسخ ویجت به روز شده.

نوع پاسخ

نوع پاسخ برنامه چت.

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

آرایه ای از اشیاء SelectionItem.

ویجت به روز شده

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

فیلدها
widget

string

شناسه ویجت به روز شده. شناسه باید با شناسه ویجتی که درخواست به‌روزرسانی را راه‌اندازی کرده، مطابقت داشته باشد.

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

SelectionItems

فهرست نتایج تکمیل خودکار ویجت

ActionStatus

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

فیلدها
status_code

Code

کد وضعیت.

user_facing_message

string

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

حاشیه نویسی

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

مثال متن پیام ساده:

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

AnnotationType

نوع این حاشیه نویسی

length

int32

طول رشته فرعی در متن پیام متنی ساده با این حاشیه نویسی مطابقت دارد.

start_index

int32

نمایه شروع (بر اساس 0، شامل) در متن پیام متنی ساده که این حاشیه نویسی با آن مطابقت دارد.

metadata میدان اتحادیه فراداده اضافی در مورد حاشیه نویسی. metadata تنها می تواند یکی از موارد زیر باشد:
user_mention

UserMentionMetadata

فراداده ذکر کاربر.

slash_command

SlashCommandMetadata

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

AnnotationType

نوع حاشیه نویسی

Enums
ANNOTATION_TYPE_UNSPECIFIED مقدار پیش فرض برای enum. استفاده نکنید.
USER_MENTION یک کاربر ذکر شده است.
SLASH_COMMAND یک دستور اسلش فراخوانی می شود.

گیف پیوست شده

یک تصویر GIF که توسط یک URL مشخص شده است.

فیلدها
uri

string

فقط خروجی URL که میزبان تصویر GIF است.

پیوست

یک پیوست در Google Chat.

فیلدها
name

string

نام منبع پیوست، به شکل spaces/{space}/messages/{message}/attachments/{attachment} .

content_name

string

فقط خروجی نام فایل اصلی برای محتوا، نه مسیر کامل.

content_type

string

فقط خروجی نوع محتوا (نوع MIME) فایل.

thumbnail_uri

string

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

download_uri

string

فقط خروجی URL دانلودی که باید از آن استفاده شود تا کاربر انسانی بتواند پیوست را دانلود کند. برنامه‌های گپ نباید از این نشانی اینترنتی برای دانلود محتوای پیوست استفاده کنند.

source

Source

فقط خروجی منبع پیوست

فیلد اتحادیه data_ref . ارجاع داده به پیوست data_ref تنها می تواند یکی از موارد زیر باشد:
attachment_data_ref

AttachmentDataRef

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

drive_data_ref

DriveDataRef

فقط خروجی ارجاع به پیوست Google Drive. این فیلد با Google Drive API استفاده می شود.

منبع

منبع پیوست

Enums
SOURCE_UNSPECIFIED رزرو شده است.
DRIVE_FILE فایل یک فایل گوگل درایو است.
UPLOADED_CONTENT فایل در چت آپلود می شود.

AttachmentDataRef

ارجاع به داده های پیوست

فیلدها
resource_name

string

نام منبع داده های پیوست. این فیلد با API رسانه برای دانلود داده های پیوست استفاده می شود.

attachment_upload_token

string

نشانه مات حاوی ارجاع به پیوست آپلود شده. توسط کلاینت‌ها به‌عنوان یک رشته غیرشفاف تلقی می‌شود و برای ایجاد یا به‌روزرسانی پیام‌های چت با پیوست‌ها استفاده می‌شود.

CardWithId

کارتی در پیام چت Google.

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

طراحی و پیش نمایش کارت ها با Card Builder.

کارت ساز را باز کنید

فیلدها
card_id

string

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

card

Card

یک کارت حداکثر حجم 32 کیلوبایت است.

ChatSpaceLinkData

داده برای پیوندهای فضای چت.

فیلدها
space

string

فضای منبع فضای چت پیوند شده.

قالب: spaces/{space}

thread

string

رشته منبع فضای چت پیوند شده.

قالب: spaces/{space}/threads/{thread}

message

string

پیام منبع فضای چت پیوند شده.

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

CompleteImportSpaceRequest

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

فیلدها
name

string

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

قالب: spaces/{space}

CompleteImportSpaceResponse

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

فیلدها
space

Space

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

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

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

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

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

فیلدها
parent

string

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

قالب: spaces/{space}

membership

Membership

مورد نیاز. رابطه عضویت برای ایجاد. فیلد memberType باید دارای کاربری با فیلدهای user.name و user.type باشد. سرور یک نام منبع اختصاص می دهد و هر چیزی را که مشخص شده است، بازنویسی می کند. وقتی یک برنامه Chat یک رابطه عضویت برای یک کاربر انسانی ایجاد می‌کند، باید از محدوده chat.memberships استفاده کند، 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 کاربر را به فضا اضافه کنید. وقتی یک برنامه Chat برای خود یک رابطه عضویت ایجاد می‌کند، باید از محدوده 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 برگردانده می شود.

CreateReactionRequest

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

فیلدها
parent

string

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

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

reaction

Reaction

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

CreateSpaceRequest

درخواست ایجاد فضایی بدون عضو.

فیلدها
space

Space

مورد نیاز. فیلدهای spaceType باید پر شوند. فقط SpaceType.SPACE پشتیبانی می شود.

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

اگر عضو برنامه Developer Preview هستید، اگر importMode روی true تنظیم شده باشد، SpaceType.GROUP_CHAT می تواند استفاده شود.

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

request_id

string

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

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

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

فیلدها
uid

string

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

DeleteMembership Request

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

فیلدها
name

string

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

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

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

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

use_admin_access

bool

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

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

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

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

DeleteMessageRequest

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

فیلدها
name

string

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

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

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

force

bool

وقتی true ، حذف یک پیام پاسخ‌های رشته‌ای آن را نیز حذف می‌کند. هنگامی که false ، اگر پیامی دارای پاسخ های رشته ای باشد، حذف انجام نمی شود.

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

DeleteReactionRequest

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

فیلدها
name

string

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

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

DeleteSpaceRequest

درخواست حذف فاصله

فیلدها
name

string

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

قالب: spaces/{space}

use_admin_access

bool

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

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

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

حذف متادیتا

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

فیلدها
deletion_type

DeletionType

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

نوع حذف

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

Enums
DELETION_TYPE_UNSPECIFIED این مقدار استفاده نشده است.
CREATOR کاربر پیام خود را حذف کرد.
SPACE_OWNER مالک فضا پیام را حذف کرد.
ADMIN یک سرپرست Google Workspace پیام را حذف کرد.
APP_MESSAGE_EXPIRY یک برنامه چت پیام خود را پس از انقضا حذف کرد.
CREATOR_VIA_APP یک برنامه چت پیام را از طرف کاربر حذف کرد.
SPACE_OWNER_VIA_APP یک برنامه چت پیام را از طرف مالک فضا حذف کرد.

گفتگو

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

فیلدها
body

Card

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

DialogAction

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

فیلدها
action_status

ActionStatus

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

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

Dialog

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

DriveDataRef

ارجاع به داده های پیوست درایو.

فیلدها
drive_file_id

string

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

DriveLinkData

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

فیلدها
drive_data_ref

DriveDataRef

یک DriveDataRef که به یک فایل Google Drive ارجاع می دهد.

mime_type

string

نوع mime منبع Google Drive پیوند شده.

ایموجی

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

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

string

یک ایموجی اصلی که با یک رشته یونیکد نمایش داده می شود.

custom_emoji

CustomEmoji

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

EmojiReactionSummary

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

فیلدها
emoji

Emoji

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

reaction_count

int32

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

FindDirectMessageRequest

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

فیلدها
name

string

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

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

GetAttachmentRequest

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

فیلدها
name

string

مورد نیاز. نام منبع پیوست، به شکل spaces/{space}/messages/{message}/attachments/{attachment} .

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 Workspace کاربر اجرا می‌شود.

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

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

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

GetMessageRequest

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

فیلدها
name

string

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

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

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

GetSpaceEventRequest

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

فیلدها
name

string

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

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

GetSpaceReadStateRequest

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

فیلدها
name

string

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

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

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

  • me مستعار من برای مثال، users/me/spaces/{space}/spaceReadState .

  • آدرس ایمیل Workspace آنها. برای مثال، users/user@example.com/spaces/{space}/spaceReadState .

  • شناسه کاربری آنها به عنوان مثال، users/123456789/spaces/{space}/spaceReadState .

قالب: users/{user}/space/{space}/spaceReadState

GetSpaceRequest

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

فیلدها
name

string

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

قالب: spaces/{space}

use_admin_access

bool

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

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

به دامنه chat.admin.spaces یا chat.admin.spaces.readonly OAuth 2.0 نیاز دارد.

GetThreadReadStateRequest

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

فیلدها
name

string

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

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

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

  • me مستعار من برای مثال، users/me/spaces/{space}/threads/{thread}/threadReadState .

  • آدرس ایمیل Workspace آنها. برای مثال، users/user@example.com/spaces/{space}/threads/{thread}/threadReadState .

  • شناسه کاربری آنها به عنوان مثال، users/123456789/spaces/{space}/threads/{thread}/threadReadState .

قالب: users/{user}/space/{space}/threads/{thread}/threadReadState

گروه

یک گروه گوگل در چت گوگل.

فیلدها
name

string

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

یک گروه را در Cloud Identity Groups API نشان می دهد.

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

History State

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

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

ListMembershipsRequest

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

فیلدها
parent

string

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

قالب: spaces/{space}

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 روی true تنظیم شده است، مورد نیاز است. سایر فیلترهای نوع عضو رد خواهند شد.

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

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 Workspace کاربر اجرا می‌شود.

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

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

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

ListMembershipsResponse

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

فیلدها
memberships[]

Membership

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

next_page_token

string

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

ListMessagesRequest

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

فیلدها
parent

string

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

قالب: spaces/{space}

page_size

int32

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

اگر مشخص نشده باشد، حداکثر 25 عدد برگردانده می شود.

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

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

page_token

string

اختیاری است، در صورت از سرگیری درخواست قبلی.

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

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

filter

string

یک فیلتر پرس و جو

می توانید پیام ها را بر اساس تاریخ ( create_time ) و رشته ( thread.name ) فیلتر کنید.

برای فیلتر کردن پیام ها بر اساس تاریخ ایجاد آنها، create_time با یک مهر زمانی در قالب RFC-3339 و دو علامت نقل قول مشخص کنید. به عنوان مثال، "2023-04-21T11:30:00-04:00" . می توانید از بزرگتر از عملگر > برای فهرست کردن پیام هایی که پس از مهر زمانی ایجاد شده اند یا کمتر از عملگر < برای فهرست کردن پیام هایی که قبل از مهر زمانی ایجاد شده اند استفاده کنید. برای فیلتر کردن پیام ها در یک بازه زمانی، از عملگر AND بین دو مهر زمانی استفاده کنید.

برای فیلتر کردن بر اساس رشته، thread.name را مشخص کنید که به صورت spaces/{space}/threads/{thread} قالب‌بندی شده است. شما فقط می توانید یک thread.name در هر پرس و جو تعیین کنید.

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

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

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

order_by

string

اختیاری است، در صورت از سرگیری درخواست قبلی.

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

  • ASC برای صعود.

  • DESC برای نزول.

ترتیب پیش فرض create_time ASC است.

show_deleted

bool

آیا شامل پیام های حذف شده است یا خیر. پیام‌های حذف‌شده شامل زمان حذف شده و ابرداده‌های مربوط به حذف آن‌ها است، اما محتوای پیام در دسترس نیست.

ListMessagesResponse

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

فیلدها
messages[]

Message

لیست پیام ها

next_page_token

string

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

ListReactionsRequest

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

فیلدها
parent

string

مورد نیاز. پیامی که کاربران به آن واکنش نشان دادند.

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

page_size

int32

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

page_token

string

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

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

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

filter

string

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

می‌توانید واکنش‌ها را بر اساس شکلک (یا 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 رد می‌شوند.

ListReactionsResponse

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

فیلدها
reactions[]

Reaction

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

next_page_token

string

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

ListSpaceEventsRequest

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

فیلدها
parent

string

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

قالب: spaces/{space} .

page_size

int32

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

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

page_token

string

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

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

filter

string

مورد نیاز. یک فیلتر پرس و جو

شما باید حداقل یک نوع رویداد ( event_type ) را با استفاده از عملگر has : مشخص کنید. برای فیلتر کردن بر اساس چندین نوع رویداد، از عملگر OR استفاده کنید. انواع رویداد دسته‌ای را در فیلتر خود حذف کنید. درخواست به طور خودکار هر رویداد دسته ای مرتبط را برمی گرداند. برای مثال، اگر بر اساس واکنش‌های جدید فیلتر کنید ( google.workspace.chat.reaction.v1.created )، سرور رویدادهای واکنش‌های جدید دسته‌ای را نیز برمی‌گرداند ( google.workspace.chat.reaction.v1.batchCreated ). برای لیستی از انواع رویدادهای پشتیبانی شده، به مستندات مرجع SpaceEvents مراجعه کنید.

به صورت اختیاری، می‌توانید بر اساس زمان شروع ( start_time ) و زمان پایان ( end_time ) نیز فیلتر کنید:

  • start_time : مُهر زمانی انحصاری که از آن فهرست رویدادهای فضایی شروع می شود. می توانید رویدادهایی را که تا 28 روز پیش رخ داده اند فهرست کنید. اگر مشخص نباشد، رویدادهای فضایی 28 روز گذشته را فهرست می‌کند.
  • end_time : مُهر زمانی شامل تا زمانی که رویدادهای فضایی فهرست می‌شوند. اگر مشخص نشده باشد، رویدادها را تا زمان درخواست فهرست می کند.

برای تعیین زمان شروع یا پایان، از عملگر و فرمت برابر = در 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 رد می‌شوند.

ListSpaceEventsResponse

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

فیلدها
space_events[]

SpaceEvent

نتایج به ترتیب زمانی برگردانده می شوند (ابتدا قدیمی ترین رویداد).

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 رد می‌شوند.

ListSpacesResponse

پاسخ برای یک لیست درخواست فاصله.

فیلدها
spaces[]

Space

فهرست فضاهای موجود در صفحه درخواستی (یا اول).

next_page_token

string

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

MatchedUrl

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

فیلدها
url

string

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

عضویت

نشان دهنده یک رابطه عضویت در 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 که عضویت با آن مطابقت دارد.

نقش عضویت

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

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

کشور عضویت

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

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

MembershipBatchCreatedEventData

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

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

فیلدها
memberships[]

MembershipCreatedEventData

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

MembershipBatchDeletedEventData

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

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

فیلدها
memberships[]

MembershipDeletedEventData

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

MembershipBatchUpdatedEventData

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

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

فیلدها
memberships[]

MembershipUpdatedEventData

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

MembershipCreatedEventData

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

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

فیلدها
membership

Membership

عضویت جدید

MembershipDeletedEventData

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

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

فیلدها
membership

Membership

عضویت حذف شده فقط فیلدهای name و state پر شده است.

MembershipUpdatedEventData

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

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

فیلدها
membership

Membership

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

پیام

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

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

فقط خروجی زمانی که پیام در چت گوگل حذف شد. اگر پیام هرگز حذف نشود، این قسمت خالی است.

text

string

متن ساده متن پیام اولین پیوند به یک تصویر، ویدیو یا صفحه وب، یک تراشه پیش‌نمایش تولید می‌کند. همچنین می‌توانید از یک کاربر گپ Google یا همه افراد حاضر در فضا @ نام ببرید .

برای آشنایی با ایجاد پیام های متنی، به ارسال پیام مراجعه کنید.

formatted_text

string

فقط خروجی حاوی text پیام با نشانه‌گذاری‌هایی است که برای قالب‌بندی ارتباط اضافه شده است. این فیلد ممکن است تمام قالب‌بندی‌های قابل مشاهده در UI را ثبت نکند، اما شامل موارد زیر است:

  • نحو نشانه گذاری برای پررنگ، مورب، خط خطی، تک فاصله، بلوک تک فضا، و لیست گلوله‌ای.

  • نام کاربر با استفاده از قالب <users/{user}> .

  • ابرپیوندهای سفارشی با استفاده از قالب <{url}|{rendered_text}> که در آن اولین رشته URL و رشته دوم متن ارائه شده است — برای مثال، <http://example.com|custom text> .

  • شکلک سفارشی با استفاده از قالب :{emoji_name}: —به عنوان مثال، :smile: . این مورد برای شکلک‌های یونیکد، مانند U+1F600 برای شکلک‌های چهره خندان، صدق نمی‌کند.

برای اطلاعات بیشتر، مشاهده قالب بندی متن ارسال شده در پیام را ببینید

cards[]
(deprecated)

Card

منسوخ شده: به جای آن از cards_v2 استفاده کنید.

کارت‌های غنی، قالب‌بندی‌شده و تعاملی که می‌توانید برای نمایش عناصر رابط کاربری مانند: متون قالب‌بندی شده، دکمه‌ها و تصاویر قابل کلیک استفاده کنید. کارت‌ها معمولاً در زیر متن ساده پیام نمایش داده می‌شوند. cards و cards_v2 می توانند حداکثر 32 کیلوبایت حجم داشته باشند.

cards_v2[]

CardWithId

آرایه ای از کارت ها

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

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

طراحی و پیش نمایش کارت ها با Card Builder.

کارت ساز را باز کنید

annotations[]

Annotation

فقط خروجی حاشیه نویسی مرتبط با text در این پیام.

thread

Thread

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

space

Space

اگر برنامه چت شما به عنوان کاربر احراز هویت شود ، خروجی name فضا را پر می کند.

fallback_text

string

شرح متن ساده کارت‌های پیام، که زمانی استفاده می‌شود که کارت‌های واقعی نمایش داده نمی‌شوند - به عنوان مثال، اعلان‌های تلفن همراه.

action_response

ActionResponse

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

argument_text

string

فقط خروجی متن ساده پیام با تمام اشاره‌های برنامه Chat حذف شده است.

slash_command

SlashCommand

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

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

تغییرناپذیر. ورودی برای ایجاد یک پیام، در غیر این صورت فقط خروجی. کاربری که می تواند پیام را مشاهده کند. پس از تنظیم، پیام خصوصی است و فقط برای کاربر مشخص شده و برنامه چت قابل مشاهده است. برای گنجاندن این فیلد در درخواست خود، باید با استفاده از احراز هویت برنامه با Chat API تماس بگیرید و موارد زیر را حذف کنید:

برای جزئیات، به ارسال پیام خصوصی مراجعه کنید.

deletion_metadata

DeletionMetadata

فقط خروجی اطلاعاتی در مورد پیام حذف شده زمانی که delete_time تنظیم شده باشد، پیامی حذف می شود.

quoted_message_metadata

QuotedMessageMetadata

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

attached_gifs[]

AttachedGif

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

accessory_widgets[]

AccessoryWidget

یک یا چند ویجت تعاملی که در پایین یک پیام ظاهر می شود. می‌توانید ویجت‌های جانبی را به پیام‌هایی که حاوی متن، کارت یا هر دو متن و کارت هستند اضافه کنید. برای پیام هایی که حاوی گفتگو هستند پشتیبانی نمی شود. برای جزئیات، به افزودن ویجت‌های تعاملی در پایین پیام رجوع کنید.

ایجاد پیام با ویجت های جانبی نیاز به احراز هویت برنامه دارد.

MessageBatchCreatedEventData

بار رویداد برای چندین پیام جدید.

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

فیلدها
messages[]

MessageCreatedEventData

لیستی از پیام های جدید

MessageBatchDeletedEventData

بار رویداد برای چندین پیام حذف شده

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

فیلدها
messages[]

MessageDeletedEventData

لیستی از پیام های حذف شده

MessageBatchUpdatedEventData

بار رویداد برای چندین پیام به روز شده.

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

فیلدها
messages[]

MessageUpdatedEventData

لیستی از پیام های به روز شده

MessageCreatedEventData

بار رویداد برای یک پیام جدید.

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

فیلدها
message

Message

پیام جدید.

MessageDeletedEventData

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

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

فیلدها
message

Message

پیام حذف شده فقط فیلدهای name ، createTime ، deleteTime و deletionMetadata پر شده است.

MessageUpdatedEventData

بار رویداد برای یک پیام به روز شده.

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

فیلدها
message

Message

پیام به روز شده

QuotedMessageMetadata

اطلاعات در مورد یک پیام نقل قول.

فیلدها
name

string

فقط خروجی نام منبع پیام نقل شده.

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

last_update_time

Timestamp

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

واکنش

واکنش به یک پیام

فیلدها
name

string

نام منبع واکنش.

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

user

User

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

emoji

Emoji

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

ReactionBatchCreatedEventData

بار رویداد برای چندین واکنش جدید.

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

فیلدها
reactions[]

ReactionCreatedEventData

لیستی از واکنش های جدید

ReactionBatchDeletedEventData

بار رویداد برای چندین واکنش حذف شده.

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

فیلدها
reactions[]

ReactionDeletedEventData

لیستی از واکنش های حذف شده

ReactionCreatedEventData

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

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

فیلدها
reaction

Reaction

واکنش جدید

ReactionDeletedEventData

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

نوع: google.workspace.chat.reaction.v1.deleted

فیلدها
reaction

Reaction

واکنش حذف شده

RichLink Metadata

یک پیوند غنی به یک منبع.

فیلدها
uri

string

URI این لینک.

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

RichLinkType

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

Enums
DRIVE_FILE یک نوع پیوند غنی از Google Drive.
CHAT_SPACE نوع پیوند غنی از فضای چت. به عنوان مثال، یک تراشه هوشمند فضایی.

SearchSpacesRequest

درخواست جستجوی فهرستی از فضاها بر اساس پرس و جو.

فیلدها
use_admin_access

bool

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

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

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

این روش در حال حاضر فقط از دسترسی ادمین پشتیبانی می کند، بنابراین فقط true برای این فیلد پذیرفته می شود.

page_size

int32

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

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

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

page_token

string

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

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

query

string

مورد نیاز. یک جست و جو

می توانید با استفاده از پارامترهای زیر جستجو کنید:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time و last_active_time یک مهر زمانی را در قالب RFC-3339 می پذیرند و عملگرهای مقایسه پشتیبانی شده عبارتند از: = , < , > , <= , >= .

customer مورد نیاز است و برای نشان دادن فضاها از کدام مشتری استفاده می شود. customers/my_customer تنها ارزش پشتیبانی شده است.

display_name فقط عملگر HAS ( : ) را می پذیرد. متنی که باید مطابقت داده شود ابتدا به توکن تبدیل می شود و هر نشانه به صورت غیرحساس به حروف بزرگ و مستقل به عنوان یک رشته فرعی در هر نقطه از display_name فضا با پیشوند مطابقت داده می شود. برای مثال، Fun Eve با Fun event یا The evening was fun مطابقت دارد، اما نه notFun event یا even .

external_user_allowed true یا false را می پذیرد.

space_history_state فقط مقادیر را از قسمت historyState یک منبع space می پذیرد.

space_type مورد نیاز است و تنها مقدار معتبر SPACE است.

در زمینه های مختلف، فقط اپراتورهای AND پشتیبانی می شوند. یک مثال معتبر space_type = "SPACE" AND display_name:"Hello" و یک مثال نامعتبر space_type = "SPACE" OR display_name:"Hello" .

در میان همان فیلد، space_type از عملگرهای AND یا OR پشتیبانی نمی‌کند. display_name ، "space_history_state" و "external_user_allowed" فقط از عملگرهای OR پشتیبانی می کنند. last_active_time و create_time از هر دو عملگر AND و OR پشتیبانی می کنند. AND فقط می تواند برای نشان دادن یک بازه استفاده شود، مانند last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" .

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

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

اختیاری. نحوه ترتیب لیست فضاها

ویژگی های پشتیبانی شده برای سفارش عبارتند از:

  • membership_count.joined_direct_human_user_count — تعداد کاربران انسانی را که مستقیماً به یک فضا ملحق شده اند را نشان می دهد.
  • last_active_time - نشان دهنده زمانی است که آخرین مورد واجد شرایط به هر موضوعی از این فضا اضافه می شود.
  • create_time - زمان ایجاد فضا را نشان می دهد.

مقادیر عملیات سفارش معتبر عبارتند از:

  • ASC برای صعود. مقدار پیش فرض

  • DESC برای نزول.

نحو پشتیبانی شده عبارتند از:

  • 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

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

فیلدها
spaces[]

Space

صفحه ای از فضاهای درخواستی

next_page_token

string

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

total_size

int32

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

SetUpSpaceRequest

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

فیلدها
space

Space

مورد نیاز. فیلد Space.spaceType لازم است.

برای ایجاد فاصله، Space.spaceType را روی SPACE تنظیم کنید و Space.displayName را تنظیم کنید. اگر هنگام تنظیم یک فاصله، پیام خطای ALREADY_EXISTS را دریافت کردید، یک displayName دیگر را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند.

برای ایجاد یک چت گروهی، Space.spaceType را روی GROUP_CHAT تنظیم کنید. Space.displayName را تنظیم نکنید.

برای ایجاد مکالمه 1:1 بین انسان ها، Space.spaceType را روی DIRECT_MESSAGE و Space.singleUserBotDm را روی false تنظیم کنید. Space.displayName یا Space.spaceDetails را تنظیم نکنید.

برای ایجاد مکالمه 1:1 بین یک انسان و برنامه چت در حال تماس، Space.spaceType را روی DIRECT_MESSAGE و Space.singleUserBotDm را روی true تنظیم کنید. Space.displayName یا Space.spaceDetails را تنظیم نکنید.

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

request_id

string

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

memberships[]

Membership

اختیاری. کاربران یا گروه‌های چت Google را دعوت کنید تا به فضا بپیوندند. کاربر تماس گیرنده را حذف کنید، زیرا آنها به طور خودکار اضافه می شوند.

این مجموعه در حال حاضر حداکثر 20 عضویت (علاوه بر تماس گیرنده) را امکان پذیر می کند.

برای عضویت انسانی، فیلد Membership.member باید شامل user با name پر شده (قالب: users/{user} ) و type تنظیم شده روی User.Type.HUMAN باشد. فقط هنگام تنظیم یک فضا می‌توانید کاربران انسانی اضافه کنید (افزودن برنامه‌های چت فقط برای تنظیم پیام مستقیم با برنامه تماس پشتیبانی می‌شود). همچنین می توانید با استفاده از ایمیل کاربر به عنوان نام مستعار برای {user} اعضا اضافه کنید. به عنوان مثال، user.name می تواند users/example@gmail.com باشد. برای دعوت از کاربران Gmail یا کاربران از دامنه های Google Workspace خارجی، ایمیل کاربر باید برای {user} استفاده شود.

برای عضویت در گروه Google، قسمت Membership.group_member باید group با name پر شده باشد ( groups/{group} ). وقتی Space.spaceType را روی SPACE تنظیم کنید، فقط می‌توانید گروه‌های Google را اضافه کنید.

هنگام تنظیم Space.spaceType روی SPACE اختیاری است.

هنگام تنظیم Space.spaceType روی GROUP_CHAT ، همراه با حداقل دو عضویت، ضروری است.

هنگام تنظیم Space.spaceType روی DIRECT_MESSAGE با یک کاربر انسانی، همراه با دقیقاً یک عضویت ضروری است.

هنگام ایجاد مکالمه 1:1 بین یک انسان و برنامه چت در حال تماس، باید خالی باشد (هنگامی که Space.spaceType را روی DIRECT_MESSAGE و Space.singleUserBotDm را روی true تنظیم کنید).

SlashCommand

یک دستور اسلش در چت گوگل.

فیلدها
command_id

int64

شناسه فرمان اسلش فراخوانی شده است.

SlashCommandMetadata

فراداده حاشیه نویسی برای دستورات اسلش (/).

فیلدها
bot

User

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

type

Type

نوع دستور اسلش.

command_name

string

نام دستور اسلش فراخوانی شده.

command_id

int64

شناسه فرمان دستور اسلش فراخوانی شده.

triggers_dialog

bool

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

تایپ کنید

Enums
TYPE_UNSPECIFIED مقدار پیش فرض برای enum. استفاده نکنید.
ADD برنامه چت را به فضا اضافه کنید.
INVOKE فراخوانی دستور اسلش در فضا.

فضا

فضایی در چت گوگل. Spaces مکالمه بین دو یا چند کاربر یا پیام های 1:1 بین یک کاربر و یک برنامه چت است.

فیلدها
name

string

نام منبع فضا

قالب: spaces/{space}

جایی که {space} شناسه اختصاص داده شده توسط سیستم برای فضا را نشان می دهد. شما می توانید ID space را با فراخوانی متد spaces.list() یا از URL space بدست آورید. به عنوان مثال، اگر URL فاصله https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA باشد، شناسه فاصله AAAAAAAAA است.

type
(deprecated)

Type

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

space_type

SpaceType

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

single_user_bot_dm

bool

اختیاری. این که آیا فضای یک DM بین یک برنامه چت و یک انسان مجرد است.

threaded
(deprecated)

bool

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

display_name

string

نام نمایشی فضا هنگام ایجاد فضایی با spaceType SPACE مورد نیاز است. اگر هنگام ایجاد فاصله یا به‌روزرسانی displayName ، پیام خطای ALREADY_EXISTS دریافت کردید، یک displayName دیگر را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند.

برای پیام های مستقیم، این قسمت ممکن است خالی باشد.

پشتیبانی از 128 کاراکتر

external_user_allowed

bool

تغییرناپذیر. آیا این فضا به هر کاربر گپ Google اجازه عضویت می دهد یا خیر. ورودی هنگام ایجاد یک فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر این فیلد را حذف کنید:

  • کاربر احراز هویت شده از یک حساب مصرف کننده (حساب کاربری مدیریت نشده) استفاده می کند. به‌طور پیش‌فرض، فضایی که توسط حساب مصرف‌کننده ایجاد می‌شود، به هر کاربر چت Google اجازه می‌دهد.

برای فضاهای موجود، این فیلد فقط خروجی است.

space_threading_state

SpaceThreadingState

فقط خروجی حالت رشته در فضای چت.

space_details

SpaceDetails

جزئیات در مورد فضا از جمله توضیحات و قوانین.

space_history_state

HistoryState

وضعیت تاریخچه پیام برای پیام ها و رشته ها در این فضا.

import_mode

bool

اختیاری. آیا این فضا در Import Mode به عنوان بخشی از انتقال داده به Google Workspace ایجاد شده است یا خیر. وقتی فضاها وارد می‌شوند، تا زمانی که وارد کردن کامل نشود برای کاربران قابل مشاهده نیستند.

create_time

Timestamp

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

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

فقط زمانی در خروجی پر می شود که spaceType GROUP_CHAT یا SPACE باشد.

last_active_time

Timestamp

فقط خروجی مهر زمانی آخرین پیام در فضا.

admin_installed

bool

فقط خروجی برای فضاهای پیام مستقیم (DM) با برنامه چت، خواه این فضا توسط سرپرست Google Workspace ایجاد شده باشد. مدیران می‌توانند یک پیام مستقیم را با یک برنامه چت از طرف کاربران سازمان خود نصب و راه‌اندازی کنند.

برای پشتیبانی از نصب سرپرست، برنامه چت شما باید پیام‌رسانی مستقیم داشته باشد.

membership_count

MembershipCount

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

access_settings

AccessSettings

اختیاری. تنظیمات دسترسی فضا را مشخص می کند. فقط زمانی پر می شود که space_type SPACE باشد.

space_uri

string

فقط خروجی URI برای دسترسی کاربر به فضا.

فیلد اتحادیه space_permission_settings . تنظیمات مجوز یک فضا را نشان می دهد. فقط زمانی پر می شود که space_type SPACE باشد. space_permission_settings فقط می تواند یکی از موارد زیر باشد:
predefined_permission_settings

PredefinedPermissionSettings

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

permission_settings

PermissionSettings

اختیاری. تنظیمات دقیق مجوز که می تواند برای به روز رسانی فضا تنظیم شود. ورودی برای به روز رسانی یک فضا. در غیر این صورت فقط خروجی. برای ایجاد فضا، به جای آن از predefined_permission_settings استفاده کنید.

AccessSettings

نشان دهنده تنظیمات دسترسی به فضا است.

فیلدها
access_state

AccessState

فقط خروجی وضعیت دسترسی فضا را نشان می دهد.

audience

string

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

قالب: audiences/{audience}

برای استفاده از مخاطبان هدف پیش‌فرض برای سازمان Google Workspace، روی audiences/default تنظیم کنید.

AccessState

وضعیت دسترسی فضا را نشان می دهد.

Enums
ACCESS_STATE_UNSPECIFIED وضعیت دسترسی ناشناخته است یا در این API پشتیبانی نمی شود.
PRIVATE فقط کاربران یا گروه‌های Google که توسط سایر کاربران یا مدیران Google Workspace به‌صورت جداگانه اضافه یا دعوت شده‌اند، می‌توانند فضا را پیدا کرده و به آن دسترسی داشته باشند.
DISCOVERABLE یک مدیر فضایی به یک مخاطب هدف اجازه دسترسی به فضا را داده است. کاربران یا گروه‌های Google که به صورت جداگانه به فضا اضافه یا دعوت شده‌اند نیز می‌توانند فضا را کشف کرده و به آن دسترسی داشته باشند. برای کسب اطلاعات بیشتر، به ایجاد فضای قابل کشف برای کاربران خاص مراجعه کنید.

تعداد عضویت

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

فیلدها
joined_direct_human_user_count

int32

تعداد کاربران انسانی که مستقیماً به فضا ملحق شده اند، بدون احتساب کاربرانی که با عضویت در یک گروه ملحق شده اند.

joined_group_count

int32

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

PermissionSetting

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

فیلدها
managers_allowed

bool

آیا مدیران فضاها این مجوز را دارند یا خیر.

members_allowed

bool

آیا اعضای غیر مدیر این مجوز را دارند.

PermissionSettings

تنظیمات مجوز برای یک فضای نامگذاری شده. برای تنظیم تنظیمات مجوز هنگام ایجاد یک فضا، قسمت PredefinedPermissionSettings را در درخواست خود مشخص کنید.

فیلدها
manage_members_and_groups

PermissionSetting

تنظیم برای مدیریت اعضا و گروه ها در یک فضا.

modify_space_details

PermissionSetting

تنظیم برای به‌روزرسانی نام فضا، آواتار، توضیحات و دستورالعمل‌ها.

toggle_history

PermissionSetting

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

use_at_mention_all

PermissionSetting

تنظیم برای استفاده از @all در یک فاصله.

manage_apps

PermissionSetting

تنظیم برای مدیریت برنامه ها در یک فضا.

manage_webhooks

PermissionSetting

تنظیماتی برای مدیریت وب هوک ها در یک فضا.

post_messages

PermissionSetting

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

reply_messages

PermissionSetting

تنظیم برای پاسخ دادن به پیام ها در یک فاصله.

PredefinedPermissionSettings

تنظیمات مجوز فضا که می توانید هنگام ایجاد یک فضای نامگذاری شده مشخص کنید. ممکن است در آینده تنظیمات بیشتری اضافه شود. برای جزئیات بیشتر در مورد تنظیمات مجوز برای فضاهای نامگذاری شده، به اطلاعات درباره فضاها مراجعه کنید.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED نامشخص استفاده نکنید.
COLLABORATION_SPACE تنظیم برای تبدیل فضا به فضای همکاری که در آن همه اعضا می توانند پیام ارسال کنند.
ANNOUNCEMENT_SPACE تنظیم برای تبدیل فضا به فضای اعلامیه ای که فقط مدیران فضا می توانند پیام ارسال کنند.

جزئیات فضایی

جزئیات در مورد فضا از جمله توضیحات و قوانین.

فیلدها
description

string

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

تا 150 کاراکتر را پشتیبانی می کند.

guidelines

string

اختیاری. قوانین، انتظارات و آداب فضا.

پشتیبانی از 5000 کاراکتر

SpaceThreadingState

نوع حالت threading را در فضای چت مشخص می کند.

Enums
SPACE_THREADING_STATE_UNSPECIFIED رزرو شده است.
THREADED_MESSAGES فضاهای نامگذاری شده که از رشته های پیام پشتیبانی می کنند. هنگامی که کاربران به یک پیام پاسخ می‌دهند، می‌توانند در درون رشته پاسخ دهند، که پاسخ آنها را در متن پیام اصلی نگه می‌دارد.
GROUPED_MESSAGES فضاهای نامگذاری شده که مکالمه بر اساس موضوع سازماندهی می شود. موضوعات و پاسخ های آنها با هم گروه بندی می شوند.
UNTHREADED_MESSAGES پیام های مستقیم (DM) بین دو نفر و مکالمات گروهی بین 3 نفر یا بیشتر.

SpaceType

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

Enums
SPACE_TYPE_UNSPECIFIED رزرو شده است.
SPACE مکانی که در آن افراد پیام می فرستند، فایل ها را به اشتراک می گذارند و با هم همکاری می کنند. یک SPACE می تواند شامل برنامه های چت باشد.
GROUP_CHAT مکالمات گروهی بین 3 نفر یا بیشتر. یک GROUP_CHAT می‌تواند شامل برنامه‌های چت باشد.
DIRECT_MESSAGE پیام های 1:1 بین دو انسان یا یک انسان و یک برنامه چت.

تایپ کنید

منسوخ شده: به جای آن از SpaceType استفاده کنید.

Enums
TYPE_UNSPECIFIED رزرو شده است.
ROOM مکالمات بین دو یا چند انسان.
DM 1:1 پیام مستقیم بین یک انسان و یک برنامه چت، که در آن همه پیام ها مسطح هستند. توجه داشته باشید که این شامل پیام های مستقیم بین دو انسان نمی شود.

SpaceBatchUpdatedEventData

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

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

فیلدها
spaces[]

SpaceUpdatedEventData

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

رویداد فضایی

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

فیلدها
name

string

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

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

event_time

Timestamp

زمانی که رویداد رخ داده است.

event_type

string

نوع رویداد فضایی هر نوع رویداد یک نسخه دسته‌ای دارد که نمونه‌های متعددی از نوع رویداد را نشان می‌دهد که در مدت زمان کوتاهی رخ می‌دهند. برای درخواست های spaceEvents.list() ، انواع رویداد دسته ای را در فیلتر پرس و جو خود حذف کنید. به طور پیش فرض، سرور هم نوع رویداد و هم نسخه دسته ای آن را برمی گرداند.

انواع رویداد پشتیبانی شده برای پیام ها :

  • پیام جدید: google.workspace.chat.message.v1.created
  • پیام به روز شده: google.workspace.chat.message.v1.updated
  • پیام حذف شده: google.workspace.chat.message.v1.deleted
  • چند پیام جدید: google.workspace.chat.message.v1.batchCreated
  • چند پیام به روز شده: google.workspace.chat.message.v1.batchUpdated
  • چند پیام حذف شده: google.workspace.chat.message.v1.batchDeleted

انواع رویدادهای پشتیبانی شده برای عضویت :

  • عضویت جدید: google.workspace.chat.membership.v1.created
  • عضویت به روز شده: google.workspace.chat.membership.v1.updated
  • عضویت حذف شده: google.workspace.chat.membership.v1.deleted
  • چندین عضویت جدید: google.workspace.chat.membership.v1.batchCreated
  • چند عضویت به روز شده: google.workspace.chat.membership.v1.batchUpdated
  • چند عضویت حذف شده: google.workspace.chat.membership.v1.batchDeleted

انواع رویداد پشتیبانی شده برای واکنش ها :

  • واکنش جدید: google.workspace.chat.reaction.v1.created
  • واکنش حذف شده: google.workspace.chat.reaction.v1.deleted
  • چندین واکنش جدید: google.workspace.chat.reaction.v1.batchCreated
  • چندین واکنش حذف شده: google.workspace.chat.reaction.v1.batchDeleted

انواع رویدادهای پشتیبانی شده درباره فضا :

  • فضای به روز شده: google.workspace.chat.space.v1.updated
  • به روز رسانی فضای چندگانه: google.workspace.chat.space.v1.batchUpdated

payload میدان اتحادیه

payload می تواند تنها یکی از موارد زیر باشد:

message_created_event_data

MessageCreatedEventData

بار رویداد برای یک پیام جدید.

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

message_updated_event_data

MessageUpdatedEventData

بار رویداد برای یک پیام به روز شده.

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

message_deleted_event_data

MessageDeletedEventData

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

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

message_batch_created_event_data

MessageBatchCreatedEventData

بار رویداد برای چندین پیام جدید.

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

بار رویداد برای چندین پیام به روز شده.

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

بار رویداد برای چندین پیام حذف شده

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

space_updated_event_data

SpaceUpdatedEventData

محموله رویداد برای به‌روزرسانی فضایی.

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

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

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

membership_created_event_data

MembershipCreatedEventData

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

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

membership_updated_event_data

MembershipUpdatedEventData

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

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

membership_deleted_event_data

MembershipDeletedEventData

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

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

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

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

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

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

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

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

reaction_created_event_data

ReactionCreatedEventData

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

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

reaction_deleted_event_data

ReactionDeletedEventData

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

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

reaction_batch_created_event_data

ReactionBatchCreatedEventData

بار رویداد برای چندین واکنش جدید.

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

بار رویداد برای چندین واکنش حذف شده.

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

SpaceReadState

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

فیلدها
name

string

نام منبع وضعیت خواندن فضا.

قالب: users/{user}/spaces/{space}/spaceReadState

last_read_time

Timestamp

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

SpaceUpdatedEventData

محموله رویداد برای یک فضای به روز شده.

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

فیلدها
space

Space

فضای به روز شده

موضوع

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

اگر در هنگام ایجاد یک پیام، رشته ای را مشخص کنید، می توانید فیلد messageReplyOption را تنظیم کنید تا تعیین کنید اگر رشته منطبقی پیدا نشد چه اتفاقی می افتد.

فیلدها
name

string

نام منبع موضوع.

مثال: spaces/{space}/threads/{thread}

thread_key

string

اختیاری. ورودی برای ایجاد یا به روز رسانی یک موضوع. در غیر این صورت فقط خروجی. شناسه تاپیک پشتیبانی از حداکثر 4000 کاراکتر

این شناسه منحصر به برنامه چت است که آن را تنظیم می کند. برای مثال، اگر چندین برنامه چت با استفاده از یک کلید رشته پیامی ایجاد کنند، پیام‌ها در رشته‌های مختلف پست می‌شوند. برای پاسخ دادن به رشته ای که توسط شخص یا برنامه گپ دیگری ایجاد شده است، به جای آن قسمت name رشته را مشخص کنید.

ThreadReadState

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

فیلدها
name

string

نام منبع وضعیت خوانده شده موضوع.

قالب: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

Timestamp

زمانی که وضعیت خواندن موضوع کاربر به روز شد. معمولاً این با مهر زمانی آخرین پیام خوانده شده در یک رشته مطابقت دارد.

UpdateMembership Request

درخواست پیام برای به روز رسانی عضویت.

فیلدها
membership

Membership

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

update_mask

FieldMask

مورد نیاز. مسیرهای میدانی برای به روز رسانی چندین مقدار را با کاما جدا کنید یا از * برای به روز رسانی تمام مسیرهای فیلد استفاده کنید.

مسیرهای فیلد پشتیبانی شده در حال حاضر:

  • role
use_admin_access

bool

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

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

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

UpdateMessageRequest

درخواست به روز رسانی یک پیام

فیلدها
message

Message

مورد نیاز. پیام با فیلدها به روز شده است.

update_mask

FieldMask

مورد نیاز. مسیرهای میدانی برای به روز رسانی چندین مقدار را با کاما جدا کنید یا از * برای به روز رسانی تمام مسیرهای فیلد استفاده کنید.

مسیرهای فیلد پشتیبانی شده در حال حاضر:

allow_missing

bool

اختیاری. اگر true و پیام پیدا نشد، یک پیام جدید ایجاد می شود و updateMask نادیده گرفته می شود. شناسه پیام مشخص شده باید به مشتری اختصاص داده شود در غیر این صورت درخواست انجام نمی شود.

UpdateSpaceReadStateRequest

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

فیلدها
space_read_state

SpaceReadState

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

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

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

  • me مستعار من برای مثال، users/me/spaces/{space}/spaceReadState .

  • آدرس ایمیل Workspace آنها. برای مثال، users/user@example.com/spaces/{space}/spaceReadState .

  • شناسه کاربری آنها به عنوان مثال، users/123456789/spaces/{space}/spaceReadState .

قالب: users/{user}/space/{space}/spaceReadState

update_mask

FieldMask

مورد نیاز. مسیرهای میدانی برای به روز رسانی مسیرهای فیلد پشتیبانی شده در حال حاضر:

  • last_read_time

وقتی last_read_time قبل از زمان ایجاد آخرین پیام باشد، فضا به صورت خوانده نشده در UI ظاهر می شود.

برای علامت‌گذاری فضا به‌عنوان خوانده‌شده، last_read_time روی هر مقدار دیرتر (بزرگ‌تر) از زمان ایجاد آخرین پیام تنظیم کنید. last_read_time مجبور است با آخرین زمان ایجاد پیام مطابقت داشته باشد. توجه داشته باشید که وضعیت خواندن فاصله فقط بر وضعیت خواندن پیام‌هایی که در مکالمه سطح بالای فضا قابل مشاهده هستند تأثیر می‌گذارد. پاسخ‌های موجود در رشته‌ها تحت تأثیر این مُهر زمانی قرار نمی‌گیرند، و در عوض به وضعیت خواندن رشته متکی هستند.

UpdateSpaceRequest

درخواستی برای به روز رسانی یک فضای واحد.

فیلدها
space

Space

مورد نیاز. فضایی با فیلدهایی که باید به روز شوند. Space.name باید به شکل spaces/{space} پر شود. فقط فیلدهایی که توسط update_mask مشخص شده اند به روز می شوند.

update_mask

FieldMask

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

می توانید فیلدهای زیر را برای یک فاصله به روز کنید:

  • space_details

  • display_name : فقط از به روز رسانی نام نمایشی برای فضاهایی که قسمت spaceType SPACE است پشتیبانی می کند. اگر پیام خطای ALREADY_EXISTS را دریافت کردید، مقدار دیگری را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند.

  • space_type : فقط از تغییر نوع فضای GROUP_CHAT به SPACE پشتیبانی می کند. display_name همراه با space_type در ماسک به‌روزرسانی قرار دهید و مطمئن شوید که فضای مشخص شده دارای یک نام نمایشی غیرخالی و نوع فضای SPACE باشد. اگر فضای موجود از قبل دارای نوع SPACE باشد، قرار دادن ماسک space_type و نوع SPACE در فضای مشخص شده هنگام به‌روزرسانی نام نمایشی اختیاری است. تلاش برای به روز رسانی نوع فاصله به روش های دیگر منجر به خطای آرگومان نامعتبر می شود. space_type با دسترسی ادمین پشتیبانی نمی شود.

  • space_history_state : تنظیمات تاریخچه فضا را با روشن یا خاموش کردن تاریخچه برای فضا به‌روزرسانی می‌کند. فقط در صورتی پشتیبانی می‌شود که تنظیمات سابقه برای سازمان Google Workspace فعال باشد. برای به‌روزرسانی وضعیت تاریخچه فضا، باید سایر ماسک‌های فیلد را در درخواست خود حذف کنید. space_history_state با دسترسی ادمین پشتیبانی نمی شود.

  • access_settings.audience : تنظیمات دسترسی افرادی را که می توانند فضا را کشف کنند، به فضا ملحق شوند و پیام ها را در فضای نامگذاری شده پیش نمایش کنند به روز می کند، جایی که قسمت spaceType SPACE است. اگر فضای موجود مخاطب هدف دارد، می‌توانید با حذف مقداری برای این فیلد ماسک، مخاطب را حذف کرده و دسترسی به فضا را محدود کنید. برای به‌روزرسانی تنظیمات دسترسی برای یک فضا، کاربر احراز هویت باید یک مدیر فضا باشد و همه ماسک‌های فیلد دیگر را در درخواست شما حذف کند. اگر فضا در حالت واردات باشد، نمی‌توانید این فیلد را به‌روزرسانی کنید. برای کسب اطلاعات بیشتر، به ایجاد فضای قابل کشف برای کاربران خاص مراجعه کنید. access_settings.audience با دسترسی سرپرست پشتیبانی نمی شود.

  • پیش‌نمایش برنامه‌نویس: از تغییر تنظیمات مجوز یک فضا پشتیبانی می‌کند، مسیرهای فیلد پشتیبانی‌شده عبارتند از: permission_settings.manage_members_and_groups ، permission_settings.modify_space_details ، permission_settings.toggle_history ، permission_settings.use_at_mention_all , permission_settings.manage_webhooks permission_settings.manage_apps permission_settings.reply_messages (هشدار: متقابل با تمام مسیرهای فیلد تنظیمات بدون مجوز). permission_settings با دسترسی ادمین پشتیبانی نمی شود.

use_admin_access

bool

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

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

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

برخی از مقادیر FieldMask با استفاده از دسترسی مدیر پشتیبانی نمی شوند. برای جزئیات، به توضیحات update_mask مراجعه کنید.

کاربر

کاربر در چت گوگل. هنگامی که به عنوان خروجی از یک درخواست برگردانده می شود، اگر برنامه چت شما به عنوان یک کاربر احراز هویت شود ، خروجی یک منبع User فقط name و type کاربر را پر می کند.

فیلدها
name

string

نام منبع برای user گپ Google .

قالب: users/{user} . users/app را می توان به عنوان نام مستعار برای کاربر bot برنامه تماس گیرنده استفاده کرد.

برای human users ، {user} همان شناسه کاربری است که:

  • id Person in the People API. به عنوان مثال، users/123456789 در Chat API همان شخص را نشان می‌دهد که شناسه نمایه 123456789 شخص در People API.

  • id یک کاربر در Admin SDK Directory API.

  • آدرس ایمیل کاربر را می توان به عنوان نام مستعار برای {user} در درخواست های API استفاده کرد. به عنوان مثال، اگر شناسه نمایه افراد API People برای user@example.com 123456789 باشد، می‌توانید از users/user@example.com به عنوان نام مستعار برای مرجع users/123456789 استفاده کنید. فقط نام منبع متعارف (به عنوان مثال users/123456789 ) از API بازگردانده خواهد شد.

display_name

string

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

domain_id

string

شناسه منحصر به فرد دامنه Google Workspace کاربر.

type

Type

نوع کاربر

is_anonymous

bool

فقط خروجی وقتی true ، کاربر حذف می شود یا نمایه او قابل مشاهده نیست.

تایپ کنید

Enums
TYPE_UNSPECIFIED مقدار پیش فرض برای enum. استفاده نکنید.
HUMAN کاربر انسانی.
BOT کاربر برنامه چت.

UserMentionMetadata

فراداده حاشیه نویسی برای اشاره های کاربر (@).

فیلدها
user

User

کاربر اشاره کرد.

type

Type

نوع ذکر کاربر

تایپ کنید

Enums
TYPE_UNSPECIFIED مقدار پیش فرض برای enum. استفاده نکنید.
ADD کاربر را به فضا اضافه کنید.
MENTION نام کاربر در فضا

WidgetMarkup

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

فیلدها
buttons[]

Button

لیستی از دکمه ها دکمه ها نیز oneof data هستند و فقط یکی از این فیلدها باید تنظیم شود.

data میدان اتحادیه WidgetMarkup فقط می تواند یکی از موارد زیر را داشته باشد. می توانید از چندین فیلد WidgetMarkup برای نمایش موارد بیشتر استفاده کنید. data فقط می توانند یکی از موارد زیر باشند:
text_paragraph

TextParagraph

یک پاراگراف متنی را در این ویجت نمایش دهید.

image

Image

یک تصویر را در این ویجت نمایش دهید.

key_value

KeyValue

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

دکمه

یک دکمه می تواند یک دکمه متن یا یک دکمه تصویر باشد.

فیلدها

type فیلد اتحادیه

type می تواند تنها یکی از موارد زیر باشد:

text_button

TextButton

یک دکمه با متن و عمل onclick .

image_button

ImageButton

یک دکمه با عکس و عمل onclick .

FormAction

یک کنش فرم رفتار را هنگام ارسال فرم توصیف می کند. برای مثال، می‌توانید از Apps Script برای مدیریت فرم استفاده کنید.

فیلدها
action_method_name

string

از نام روش برای تشخیص اینکه کدام قسمت از فرم باعث ارسال فرم شده است استفاده می شود. این اطلاعات به عنوان بخشی از رویداد کلیک کارت به برنامه چت بازتاب داده می شود. می‌توانید از یک نام متد برای چندین عنصر استفاده کنید که یک رفتار مشترک را تحریک می‌کنند.

parameters[]

ActionParameter

لیست پارامترهای عمل

ActionParameter

فهرست پارامترهای رشته ای که باید هنگام فراخوانی متد اقدام ارائه شوند. به عنوان مثال، سه دکمه چرت زدن را در نظر بگیرید: چرت زدن اکنون، چرت زدن یک روز، چرت زدن هفته آینده. شما ممکن است از action method = snooze() استفاده کنید، از نوع snooze و زمان snooze در لیست پارامترهای رشته استفاده کنید.

فیلدها
key

string

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

value

string

مقدار پارامتر.

نماد

مجموعه ای از آیکون های پشتیبانی شده

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

تصویر

تصویری که توسط یک URL مشخص می‌شود و می‌تواند یک عمل onclick داشته باشد.

فیلدها
image_url

string

آدرس تصویر.

on_click

OnClick

عمل onclick .

aspect_ratio

double

نسبت ابعاد این تصویر (عرض و ارتفاع). این فیلد به شما این امکان را می دهد که ارتفاع مناسب را برای تصویر در زمانی که منتظر بارگذاری آن هستید، رزرو کنید. این به معنای نادیده گرفتن نسبت ابعاد داخلی تصویر نیست. اگر تنظیم نشده باشد، سرور با واکشی اولیه تصویر آن را پر می کند.

دکمه تصویر

یک دکمه تصویر با یک عمل onclick .

فیلدها
on_click

OnClick

عمل onclick .

name

string

نام این image_button که برای دسترسی استفاده می شود. اگر این نام مشخص نشده باشد، مقدار پیش‌فرض ارائه می‌شود.

icons فیلد اتحادیه نماد را می توان با یک enum Icon یا یک URL مشخص کرد. icons فقط می توانند یکی از موارد زیر باشند:
icon

Icon

نماد مشخص شده توسط یک enum که به نماد ارائه شده توسط Chat API نشان می دهد.

icon_url

string

نماد مشخص شده توسط یک URL.

KeyValue

یک عنصر UI حاوی یک کلید (برچسب) و یک مقدار (محتوا) است. این عنصر همچنین می تواند شامل برخی از اقدامات مانند دکمه onclick باشد.

فیلدها
top_label

string

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

content

string

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

content_multiline

bool

اگر محتوا باید چند خطی باشد.

bottom_label

string

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

on_click

OnClick

عمل onclick . فقط برچسب بالا، برچسب پایین و منطقه محتوا قابل کلیک هستند.

icons فیلد اتحادیه حداقل یکی از نمادها، top_label و bottom_label باید تعریف شود. icons فقط می توانند یکی از موارد زیر باشند:
icon

Icon

یک مقدار enum که توسط Chat API با تصویر نماد مربوطه جایگزین شده است.

icon_url

string

نماد مشخص شده توسط یک URL.

control میدان اتحادیه ویجت کنترلی می توانید button یا switch_widget را تنظیم کنید، اما نه هر دو را. control فقط می تواند یکی از موارد زیر باشد:
button

Button

دکمه ای که می توان روی آن کلیک کرد تا یک عمل فعال شود.

OnClick

یک عمل onclick (به عنوان مثال، باز کردن یک پیوند).

فیلدها

data میدان اتحادیه

data فقط می توانند یکی از موارد زیر باشند:

action

FormAction

در صورتی که مشخص شده باشد، یک کنش فرم با این عمل onclick فعال می شود.

دکمه متن

یک دکمه با متن و عمل onclick .

فیلدها
text

string

متن دکمه.

on_click

OnClick

عمل onclick دکمه.

متن پاراگراف

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

فیلدها
text

string