REST Resource: spaces.messages

منبع: پیام

پیامی در فضای Google Chat.

نمایش JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
فیلدها
name

string

شناسه. نام منبع پیام.

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

که در آن {space} شناسه فضایی است که پیام در آن پست شده است و {message} شناسه اختصاص‌داده‌شده توسط سیستم برای پیام است. به‌عنوان مثال، spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

اگر هنگام ایجاد پیام، شناسه سفارشی تنظیم کنید، می‌توانید از این شناسه برای مشخص کردن پیام در درخواست استفاده کنید. برای این کار، {message} را با مقدار فیلد clientAssignedMessageId جایگزین کنید. به‌عنوان مثال، spaces/AAAAAAAAAAA/messages/client-custom-name. برای جزئیات، به نام‌گذاری پیام مراجعه کنید.
sender

object (User)

فقط خروجی. کاربری که پیام را ایجاد کرده است. اگر برنامه Chat شما به‌عنوان کاربر اصالت‌سنجی کند، خروجی فقط فیلدهای کاربر name و type را برای کاربران داخلی و خارجی پر می‌کند، مگراینکه آن‌ها عضو فضا باشند یا ازقبل با کاربر تماس‌گیرنده ارتباطی داشته باشند، مثلاً مکالمه پیام مستقیم (DM).
createTime

string (Timestamp format)

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

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

string (Timestamp format)

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

string (Timestamp format)

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

string

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

برای آشنایی با نحوه ایجاد پیامک، ارسال پیام را ببینید.
formattedText

string

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

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

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

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

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

  • موارد فهرست گلوله‌ای بااستفاده از ستاره (*)—برای مثال، * item.

برای اطلاعات بیشتر، مشاهده قالب‌بندی نوشتار ارسال‌شده در پیام را ببینید
cards[]
(deprecated)

object (Card)

منسوخ‌شده: درعوض از cardsV2 استفاده کنید.

کارت‌های غنی، قالب‌بندی‌شده، و تعاملی که می‌توانید از آن‌ها برای نمایش عناصر واسط کاربر مانند نوشتارهای قالب‌بندی‌شده، دکمه‌ها، و تصاویر کلیک‌کردنی استفاده کنید. کارت‌ها معمولاً زیر متن ساده پیام نمایش داده می‌شوند. cards و cardsV2 می‌توانند حداکثر اندازه ۳۲ کیلوبایت داشته باشند.
cardsV2[]

object (CardWithId)

اختیاری. آرایه‌ای از کارت‌ها.

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

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

کارت‌ها را با «کارت‌ساز» طراحی و پیش‌نمایش کنید.

باز کردن «کارت‌ساز»
annotations[]

object (Annotation)

فقط خروجی. حاشیه‌نویسی‌ها می‌توانند با متن ساده بدنه پیام یا با تراشه‌هایی که به منابع Google Workspace مانند «سندنگار Google» یا «کاربرگ‌نگار Google» با startIndex و length صفر پیوند دارند مرتبط شوند.
thread

object (Thread)

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

object (Space)

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

string

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

object (ActionResponse)

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

string

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

object (SlashCommand)

فقط خروجی. اطلاعات فرمان خط مورب، درصورت وجود.
attachment[]

object (Attachment)

اختیاری. پیوست بارگذاری‌شده توسط کاربر.
matchedUrl

object (MatchedUrl)

فقط خروجی. نشانی وبی در فیلد پیام Chat text که با الگوی پیش‌نمایش پیوند مطابقت دارد. برای اطلاعات بیشتر، به پیش‌دید کردن پیوندها مراجعه کنید.
threadReply

boolean

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

اگر فضا از پاسخ در رشته‌ها پشتیبانی نکند، این فیلد همیشه false است.
silent

boolean

فقط خروجی. اینکه این پیام بی‌صدا است یا نه. پیام‌های بی‌صدا پیام‌هایی هستند که Chat اعلان‌های لحظه‌ای آن‌ها را برای گیرندگان متوقف می‌کند.
clientAssignedMessageId

string

اختیاری. شناسه سفارشی برای پیام. می‌توانید از فیلد برای شناسایی پیام، یا دریافت، حذف، یا به‌روزرسانی پیام استفاده کنید. برای تنظیم شناسه سفارشی، فیلد messageId را هنگام ایجاد پیام مشخص کنید. برای جزئیات، به نام‌گذاری پیام مراجعه کنید.
emojiReactionSummaries[]

object (EmojiReactionSummary)

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

object (User)

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

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

اختیاری. اطلاعات مربوط به پیامی که پیام دیگری آن را نقل‌قول می‌کند.

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

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

برای مشاهده نمونه استفاده، به نقل‌قول کردن پیام دیگر مراجعه کنید.
attachedGifs[]

object (AttachedGif)

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

object (AccessoryWidget)

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

ایجاد پیام با ابزاره‌های جانبی به اصالت‌سنجی برنامه نیاز دارد.
elements

object (Elements)

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

markupSyntax

enum (MarkupSyntax)

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

هنگام فراخوانی UpdateMessage، markupSyntax و text را در منبع Message تنظیم کنید و text (نه markupSyntax) را در updateMask قرار دهید.

حاشیه‌نویسی

حاشیه‌نویسی‌ها می‌توانند با بدنه نوشتار ساده پیام یا با تراشه‌هایی که به منابع Google Workspace مانند «سندنگار» یا «کاربرگ‌نگار Google» پیوند دارند با startIndex و length صفر مرتبط شوند. برای افزودن قالب‌بندی پایه به پیامک، به قالب‌بندی پیامک مراجعه کنید.

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

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"
   }
}]
نمایش JSON 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
فیلدها
type

enum (AnnotationType)

نوع این حاشیه‌نویسی.
length

integer

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

integer

نمایه شروع (مبتنی بر ۰، شامل) در بدنه پیام نوشتار ساده که این حاشیه‌نویسی با آن مطابقت دارد.
فراداده اضافی درباره حاشیه‌نویسی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
userMention

object (UserMentionMetadata)

فراداده نام بردن از کاربر.
slashCommand

object (SlashCommandMetadata)

فراداده برای فرمان خط مورب.
customEmojiMetadata

object (CustomEmojiMetadata)

فراداده برای اموجی سفارشی.
پایان فیلدهای متقابلاً انحصاری.

AnnotationType

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

شمارشی‌ها
ANNOTATION_TYPE_UNSPECIFIED مقدار پیش‌فرض برای enum. استفاده نشود.
USER_MENTION از کاربری نام برده شده است.
SLASH_COMMAND فرمان خط مورب فراخوانی می‌شود.
CUSTOM_EMOJI حاشیه‌نویسی اموجی سفارشی.

UserMentionMetadata

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

نمایش JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
فیلدها
user

object (User)

کاربر نامبرده.
type

enum (Type)

نوع نام بردن از کاربر.

نوع

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

SlashCommandMetadata

فراداده حاشیه‌نویسی برای فرمان‌های خط مورب (/).

نمایش JSON 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
فیلدها
bot

object (User)

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

enum (Type)

نوع فرمان خط مورب.
commandName

string

نام فرمان خط مورب فراخوانده‌شده.
commandId

string (int64 format)

شناسه فرمانِ فرمان خط مورب فراخوانده‌شده.
triggersDialog

boolean

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

نوع

شمارشی‌ها
TYPE_UNSPECIFIED مقدار پیش‌فرض برای enum. استفاده نشود.
ADD افزودن برنامه Chat به فضا.
INVOKE فراخوانی فرمان خط مورب در فضا.

RichLinkMetadata

پیوند غنی به منبع. پیوندهای غنی را می‌توان با متن ساده بدنه پیام مرتبط کرد یا آن‌ها را به‌صورت تراشه‌هایی نشان داد که به منابع Google Workspace مثل «سندنگار» یا «کاربرگ‌نگار Google» با startIndex و length صفر پیوند می‌دهند.

نمایش JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
فیلدها
uri

string

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

RichLinkType

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

شمارشی‌ها
DRIVE_FILE نوع پیوند غنی Google Drive.
CHAT_SPACE نوع پیوند غنی فضای Chat. برای مثال، تراشه هوشمند فضا.
GMAIL_MESSAGE نوع پیوند غنی پیام Gmail. به‌طور خاص، تراشه Gmail از هم‌رسانی در Chat. این API فقط از خواندن پیام‌های دارای پیوند غنی GMAIL_MESSAGE پشتیبانی می‌کند.
MEET_SPACE نوع پیوند غنی پیام Meet. برای مثال، تراشه Meet.
CALENDAR_EVENT نوع پیوند غنی پیام «تقویم». برای مثال، تراشه «تقویم».

DriveLinkData

داده‌های پیوندهای Google Drive.

نمایش JSON 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
فیلدها
driveDataRef

object (DriveDataRef)

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

string

نوع رسانه منبع Google Drive پیوندشده.

ChatSpaceLinkData

داده‌های پیوندهای فضای Chat.

نمایش JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
فیلدها
space

string

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

قالب: spaces/{space}
thread

string

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

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

string

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

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

MeetSpaceLinkData

داده‌های پیوندهای فضای Meet.

نمایش JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
فیلدها
meetingCode

string

کد جلسه فضای Meet پیوندشده.
type

enum (Type)

نوع فضای Meet را نشان می‌دهد.
huddleStatus

enum (HuddleStatus)

اختیاری. فقط خروجی. اگر Meet از نوع Huddle باشد، وضعیت huddle را نشان می‌دهد. درغیراین‌صورت، این مقدار تنظیم نشده است.

نوع

نوع فضای Meet.

شمارشی‌ها
TYPE_UNSPECIFIED مقدار پیش‌فرض برای enum. استفاده نشود.
MEETING فضای Meet یک جلسه است.
HUDDLE فضای Meet از نوع جلسه سریع است.

HuddleStatus

وضعیت جلسه سریع

شمارشی‌ها
HUDDLE_STATUS_UNSPECIFIED مقدار پیش‌فرض برای enum. استفاده نشود.
STARTED جلسه سریع شروع شده است.
ENDED جلسه سریع پایان یافت. در این حالت، شناسه منبع یکسان و شناسه‌های فضای Meet دیگر معتبر نخواهند بود.
MISSED جلسه سریع ازدست رفت. در این حالت، شناسه منبع یکسان و شناسه‌های فضای Meet دیگر معتبر نخواهند بود.

CalendarEventLinkData

داده‌های پیوندهای رویداد «تقویم».

نمایش JSON 
{
  "calendarId": string,
  "eventId": string
}
فیلدها
calendarId

string

شناسه تقویم مربوط به «تقویم» پیوندشده.
eventId

string

شناسه رویداد مربوط به رویداد «تقویم» پیوندشده.

CustomEmojiMetadata

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

نمایش JSON 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
فیلدها
customEmoji

object (CustomEmoji)

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

نخ

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

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

نمایش JSON 
{
  "name": string,
  "threadKey": string
}
فیلدها
name

string

شناسه. نام منبع رشته.

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

string

اختیاری. ورودی برای ایجاد یا به‌روزرسانی رشته. درغیراین‌صورت، فقط برونداد. شناسه رشته. حداکثر ۴۰۰۰ نویسه را پشتیبانی می‌کند.

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

ActionResponse

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

نمایش JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
فیلدها
type

enum (ResponseType)

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

string

فقط ورودی. نشانی وب برای اصالت‌سنجی یا پیکربندی کاربران. (فقط برای انواع پاسخ REQUEST_CONFIG.)
dialogAction

object (DialogAction)

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

object (UpdatedWidget)

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

ResponseType

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

شمارشی‌ها
TYPE_UNSPECIFIED نوع پیش‌فرضی که به‌عنوان NEW_MESSAGE مدیریت می‌شود.
NEW_MESSAGE به‌عنوان پیام جدید در موضوع پست کنید.
UPDATE_MESSAGE پیام برنامه Chat را به‌روز کنید. این فقط در رویداد CARD_CLICKED که نوع فرستنده پیام BOT است مجاز است.
UPDATE_USER_MESSAGE_CARDS کارت‌های پیام کاربر را به‌روز کنید. این فقط به‌عنوان پاسخی به رویداد MESSAGE با نشانی وب منطبق، یا رویداد CARD_CLICKED که نوع فرستنده پیام HUMAN است مجاز است. نوشتار نادیده گرفته می‌شود.
REQUEST_CONFIG به‌طور خصوصی از کاربر بخواهید اصالت‌سنجی یا پیکربندی بیشتری انجام دهد.
DIALOG کادر گفتگویی را ارائه می‌دهد.
UPDATE_WIDGET پُرسمان گزینه‌های تکمیل خودکار نوشتار ابزاره.

DialogAction

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

نمایش JSON 
{
  "actionStatus": {
    object (ActionStatus)
  },

  "dialog": {
    object (Dialog)
  }
}
فیلدها
actionStatus

object (ActionStatus)

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

object (Dialog)

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

کادر گفتگو

پوشاننده اطراف بدنه کارت کادر گفتگو.

نمایش JSON 
{
  "body": {
    object (Card)
  }
}
فیلدها
body

object (Card)

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

ActionStatus

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

نمایش JSON 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
فیلدها
statusCode

enum (Code)

رمز وضعیت.
userFacingMessage

string

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

کد

کدهای خطای متعارف برای میاناهای برنامه‌سازی کاربردی gRPC.

گاهی اوقات ممکن است چند کد خطا اعمال شود. سرویس‌ها باید خاص‌ترین کد خطای مربوطه را برگردانند. برای مثال، اگر هر دو کد اعمال می‌شود، OUT_OF_RANGE را به FAILED_PRECONDITION ترجیح دهید. به‌طور مشابه، NOT_FOUND یا ALREADY_EXISTS را به FAILED_PRECONDITION ترجیح می‌دهند.

شمارشی‌ها
OK

خطا نیست؛ درصورت موفقیت برگردانده می‌شود.

نگاشت HTTP: ‏۲۰۰ OK
CANCELLED

عملیات لغو شد، معمولاً توسط تماس‌گیرنده.

نگاشت HTTP: ‏۴۹۹ درخواست بسته‌شده کارخواه
UNKNOWN

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

نگاشت HTTP: خطای سرور داخلی ۵۰۰
INVALID_ARGUMENT

کارخواه متغیر مستقل نامعتبری را مشخص کرده است. توجه داشته باشید که این با FAILED_PRECONDITION متفاوت است. INVALID_ARGUMENT نشان‌دهنده متغیرهای مستقلی است که صرف‌نظر از وضعیت سیستم مشکل‌ساز هستند (برای مثال، نام فایل با قالب‌بندی نادرست).

نگاشت HTTP: خطای ۴۰۰ - درخواست نامناسب
DEADLINE_EXCEEDED

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

نگاشت HTTP: ‏۵۰۴ اتمام مهلت دروازه
NOT_FOUND

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

نکته برای توسعه‌دهندگان سرور: اگر درخواستی برای کل کلاس کاربران رد شود، مثلاً عرضه تدریجی ویژگی یا فهرست مجاز غیرمستند، ممکن است از NOT_FOUND استفاده شود. اگر درخواستی برای برخی‌از کاربران در یک کلاس از کاربران رد شود، مثلاً کنترل دسترسی مبتنی بر کاربر، باید از PERMISSION_DENIED استفاده شود.

نگاشت HTTP: ‏۴۰۴ یافت نشد
ALREADY_EXISTS

نهادی که مشتری سعی کرد ایجاد کند (مثلاً فایل یا دایرکتوری) ازقبل وجود دارد.

نگاشت HTTP: تداخل ۴۰۹
PERMISSION_DENIED

فراخواننده اجازه اجرای عملیات مشخص‌شده را ندارد. PERMISSION_DENIED نباید برای رد شدن‌های ناشی از اتمام برخی منابع استفاده شود (برای این خطاها از RESOURCE_EXHAUSTED استفاده کنید). اگر تماس‌گیرنده قابل‌شناسایی نباشد، نباید از PERMISSION_DENIED استفاده شود (برای این خطاها، به‌جای آن از UNAUTHENTICATED استفاده کنید). این کد خطا به این معنی نیست که درخواست معتبر است یا نهاد درخواستی وجود دارد یا سایر پیش‌شرط‌ها را برآورده می‌کند.

نگاشت HTTP: ‏403 Forbidden
UNAUTHENTICATED

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

نگاشت HTTP: ‏۴۰۱ غیرمجاز
RESOURCE_EXHAUSTED

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

نگاشت HTTP: ‏۴۲۹ درخواست‌های بسیار زیاد
FAILED_PRECONDITION

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

پیاده‌سازان سرویس می‌توانند از دستورالعمل‌های زیر برای تصمیم‌گیری بین FAILED_PRECONDITION، ABORTED، و UNAVAILABLE استفاده کنند: (الف) اگر کارخواه بتواند فقط تماس ناموفق را دوباره امتحان کند، از UNAVAILABLE استفاده کنید. (ب) اگر کارخواه باید در سطح بالاتری دوباره امتحان کند، از ABORTED استفاده کنید. برای مثال، وقتی آزمایش و تنظیم مشخص‌شده توسط کارخواه ناموفق باشد، نشان می‌دهد که کارخواه باید توالی خواندن-اصلاح-نوشتن را بازراه‌اندازی کند. (ج) اگر کارخواه نباید تا زمانی که وضعیت سیستم به‌طور صریح اصلاح نشده است دوباره امتحان کند، از FAILED_PRECONDITION استفاده کنید. برای مثال، اگر «rmdir» به‌دلیل خالی نبودن فهرست راهنما ناموفق باشد، باید FAILED_PRECONDITION برگردانده شود زیرا کارخواه نباید دوباره امتحان کند مگراینکه فایل‌ها از فهرست راهنما حذف شده باشند.

نگاشت HTTP: خطای ۴۰۰ - درخواست نامناسب
ABORTED

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

برای تصمیم‌گیری بین FAILED_PRECONDITION، ABORTED، و UNAVAILABLE، دستورالعمل‌های بالا را ببینید.

نگاشت HTTP: تداخل ۴۰۹
OUT_OF_RANGE

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

برخلاف INVALID_ARGUMENT، این خطا نشان‌دهنده مشکلی است که ممکن است درصورت تغییر وضعیت سیستم برطرف شود. برای مثال، اگر از سیستم فایل ۳۲ بیتی خواسته شود که در آفستی که در محدوده [0,2^32-1] نیست بخواند، INVALID_ARGUMENT تولید می‌کند، اما اگر از آن خواسته شود که از آفستی فراتر از اندازه فایل فعلی بخواند، OUT_OF_RANGE تولید می‌کند.

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

نگاشت HTTP: ‏۴۰۰ درخواست نامناسب
UNIMPLEMENTED

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

نگاشت HTTP: ‏۵۰۱ اجرا نشده است
INTERNAL

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

نگاشت HTTP: خطای سرور داخلی ۵۰۰
UNAVAILABLE

این سرویس درحال‌حاضر دردسترس نیست. این احتمالاً شرایطی گذرا است که می‌توان آن را با امتحان مجدد با عقب‌نشینی اصلاح کرد. توجه داشته باشید که امتحان مجدد عملیات غیریکسان‌توان همیشه ایمن نیست.

برای تصمیم‌گیری بین FAILED_PRECONDITION، ABORTED، و UNAVAILABLE، دستورالعمل‌های بالا را ببینید.

نگاشت HTTP: ‏۵۰۳ سرویس دردسترس نیست
DATA_LOSS

ازدست رفتن یا خراب شدن غیرقابل‌بازیابی داده‌ها.

نگاشت HTTP: خطای سرور داخلی ۵۰۰

UpdatedWidget

برای ابزاره‌های selectionInput، پیشنهادهای تکمیل خودکار را برای منو چندانتخابی برمی‌گرداند.

نمایش JSON 
{
  "widget": string,

  "suggestions": {
    object (SelectionItems)
  }
}
فیلدها
widget

string

شناسه ابزاره به‌روزشده. شناسه باید با شناسه ابزاره‌ای که درخواست به‌روزرسانی را راه‌اندازی کرده است مطابقت داشته باشد.
ابزاره در پاسخ به کنش کاربر به‌روز شد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
suggestions

object (SelectionItems)

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

SelectionItems

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

نمایش JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
فیلدها
items[]

object (SelectionItem)

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

SlashCommand

فراداده درباره فرمان خط مورب در Google Chat.

نمایش JSON 
{
  "commandId": string
}
فیلدها
commandId

string (int64 format)

شناسه فرمان خط مورب.

MatchedUrl

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

نمایش JSON 
{
  "url": string
}
فیلدها
url

string

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

EmojiReactionSummary

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

نمایش JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
فیلدها
emoji

object (Emoji)

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

integer

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

DeletionMetadata

اطلاعات مربوط به پیام حذف‌شده. وقتی deleteTime تنظیم شده باشد، پیام حذف می‌شود.

نمایش JSON 
{
  "deletionType": enum (DeletionType)
}
فیلدها
deletionType

enum (DeletionType)

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

DeletionType

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

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

QuotedMessageMetadata

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

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

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

نمایش JSON 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
فیلدها
name

string

الزامی. نام منبع پیامی که نقل‌قول شده است.

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

string (Timestamp format)

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

اگر پیام ویرایش شده است، از این فیلد استفاده کنید، lastUpdateTime. اگر پیام هرگز ویرایش نشده است، از createTime استفاده کنید.

اگر lastUpdateTime با جدیدترین نسخه پیام نقل‌شده مطابقت نداشته باشد، درخواست ناموفق خواهد بود.
quoteType

enum (QuoteType)

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

object (QuotedMessageSnapshot)

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

object (ForwardedMetadata)

فقط خروجی. فراداده مربوط به فضای منبع پیام نقل‌شده. فقط برای نوع مظنه «آتی» درج می‌شود.

QuoteType

نوع نقل‌قول پیام نقل‌شده.

شمارشی‌ها
QUOTE_TYPE_UNSPECIFIED رزروشده. از این مقدار استفاده نمی‌شود.
REPLY

وقتی quoteType REPLY است، می‌توانید کارهای زیر را انجام دهید:

  • اگر در رشته‌ای پاسخ می‌دهید، می‌توانید پیام دیگری را در آن رشته نقل‌قول کنید.

  • اگر درحال ایجاد پیام ریشه هستید، می‌توانید پیام ریشه دیگری را در آن فضا نقل‌قول کنید.
FORWARD

وقتی quoteType FORWARD است، می‌توانید این موارد را نقل‌قول کنید:

  • پیام از فضایی دیگر.

  • پاسخ پیام از رشته‌ای دیگر در همان فضا.

QuotedMessageSnapshot

عکسی آنی از محتوای پیام نقل‌قول‌شده در زمان نقل‌قول یا بازارسال ارائه می‌دهد

نمایش JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
فیلدها
sender

string

فقط خروجی. نام نویسنده پیام نقل‌شده. برای هر دو نوع نقل‌قول «پاسخ» و «بازارسال» پر شده است.
text

string

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

string

فقط خروجی. حاوی پیام نقل‌قول‌شده text با نشان‌گذاری‌های اضافه‌شده برای پشتیبانی از قالب‌بندی غنی مانند اَبَرپیوندها، اموجی‌های سفارشی، نشان‌گذاری، و غیره است. فقط برای نوع نقل‌قول «بازارسال» پر می‌شود.
annotations[]

object (Annotation)

فقط خروجی. حاشیه‌نویسی‌های تجزیه‌شده از متن پیام نقل‌قول‌شده. فقط برای نوع مظنه «آتی» درج می‌شود.
attachments[]

object (Attachment)

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

ForwardedMetadata

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

نمایش JSON 
{
  "space": string,
  "spaceDisplayName": string
}
فیلدها
space

string

فقط خروجی. نام منبع فضای مبدأ. قالب: spaces/{space}
spaceDisplayName

string

فقط خروجی. نام نمایشی فضا یا پیام مستقیم منبع در زمان بازارسال. برای SPACE، این نام فضا است. برای DIRECT_MESSAGE، این نام شرکت‌کننده دیگر است (برای مثال، «کاربر الف»). برای GROUP_CHAT، این نامی تولیدشده براساس نام کوچک اعضا است که به ۵ نفر ازجمله ایجادکننده محدود می‌شود (برای مثال، «کاربر الف، کاربر ب»).

AttachedGif

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

نمایش JSON 
{
  "uri": string
}
فیلدها
uri

string

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

عناصر

عناصر مؤلفه‌های اضافی هستند که ممکن است با نوشتار پیام ارائه‌شده درطول ایجاد پیام مرتبط باشند یا نباشند.

نمایش JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
فیلدها
citedSources[]

object (CitedSource)

فهرستی از منابع که به‌عنوان پیوندهای پانویس در زیر پیام نمایش داده می‌شود. این موارد به‌صورت درون‌خطی ارجاع داده نمی‌شوند. برای ارجاع‌های درون‌خطی، از citations استفاده کنید.
citations[]

object (Citation)

فهرستی از نقل‌قول‌های درون‌خطی که در نوشتار پیام (ازطریق برچسب‌های <chat-citation>) به آن‌ها ارجاع داده شده است و به‌صورت کارت‌های اطلاعات تعاملی نمایش داده می‌شوند.

روش‌ها

create

 پیامی در فضای Google Chat ایجاد می‌کند.

delete

 پیامی را حذف می‌کند.

get

 جزئیات مربوط به پیام را برمی‌گرداند.

list

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

patch

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

replaceCards

 کارت‌های موجود در پیام را جایگزین می‌کند.
پیام‌هایی را در Google Chat جستجو می‌کند که کاربر تماس‌گیرنده به آن‌ها دسترسی دارد.

update

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