REST Resource: spaces.messages

منبع: پیام

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

نمایش 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,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
فیلدها
name

string

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

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

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

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

sender

object ( User )

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

createTime

string ( Timestamp format)

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

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

lastUpdateTime

string ( Timestamp format)

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

deleteTime

string ( Timestamp format)

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

text

string

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

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

formattedText

string

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

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

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

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

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

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

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

cards[]
(deprecated)

object ( Card )

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

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

cardsV2[]

object ( CardWithId )

اختیاری. مجموعه‌ای از کارت‌ها .

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

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

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

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

annotations[]

object ( Annotation )

فقط خروجی. حاشیه‌نویسی‌ها می‌توانند با متن ساده پیام یا با تراشه‌هایی که به منابع Google Workspace مانند Google Docs یا Sheets با startIndex و length 0 پیوند دارند، مرتبط شوند.

thread

object ( Thread )

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

space

object ( Space )

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

fallbackText

string

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

actionResponse

object ( ActionResponse )

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

argumentText

string

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

slashCommand

object ( SlashCommand )

فقط خروجی. اطلاعات دستور اسلش، در صورت وجود.

attachment[]

object ( Attachment )

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

matchedUrl

object ( MatchedUrl )

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

threadReply

boolean

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

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

clientAssignedMessageId

string

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

emojiReactionSummaries[]

object ( EmojiReactionSummary )

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

privateMessageViewer

object ( User )

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

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

deletionMetadata

object ( DeletionMetadata )

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

quotedMessageMetadata

object ( QuotedMessageMetadata )

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

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

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

برای مثال، به نقل قول از یک پیام دیگر مراجعه کنید.

attachedGifs[]

object ( AttachedGif )

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

accessoryWidgets[]

object ( AccessoryWidget )

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

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

کارت با شناسه

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

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

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

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

نمایش JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
فیلدها
cardId

string

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

card

object ( Card )

یک کارت. حداکثر اندازه ۳۲ کیلوبایت.

حاشیه‌نویسی

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

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

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,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
  // End of list of possible types for union field metadata.
}
فیلدها
type

enum ( AnnotationType )

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

length

integer

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

startIndex

integer

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

metadata فیلد Union. فراداده اضافی در مورد حاشیه‌نویسی. metadata می‌تواند فقط یکی از موارد زیر باشد:
userMention

object ( UserMentionMetadata )

فراداده‌های مربوط به ذکر نام کاربر.

slashCommand

object ( SlashCommandMetadata )

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

customEmojiMetadata

object ( CustomEmojiMetadata )

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

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

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

انوم‌ها
ANNOTATION_TYPE_UNSPECIFIED مقدار پیش‌فرض برای enum. استفاده نکنید.
USER_MENTION یک کاربر ذکر شده است.
SLASH_COMMAND یک دستور اسلش (/) فراخوانی می‌شود.
CUSTOM_EMOJI یک حاشیه‌نویسی ایموجی سفارشی.

فراداده‌ی اشاره‌ی کاربر

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

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

object ( User )

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

type

enum ( Type )

نوع اشاره کاربر.

نوع

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

فراداده SlashCommand

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

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

object ( User )

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

type

enum ( Type )

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

commandName

string

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

commandId

string ( int64 format)

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

triggersDialog

boolean

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

نوع

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

فراداده RichLink

یک پیوند غنی به یک منبع. پیوندهای غنی می‌توانند با متن ساده پیام مرتبط باشند یا تراشه‌هایی را نشان دهند که به منابع Google Workspace مانند Google Docs یا Sheets با startIndex و length 0 پیوند دارند.

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

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
  // End of list of possible types for union field data.
}
فیلدها
uri

string

آدرس اینترنتی (URI) این لینک.

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

نوع پیوند غنی

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

انوم‌ها
DRIVE_FILE یک نوع لینک غنی از گوگل درایو.
CHAT_SPACE یک نوع لینک غنی از فضای چت. به عنوان مثال، یک تراشه هوشمند فضایی.
MEET_SPACE یک نوع پیوند غنی از پیام Meet. مثلاً یک تراشه Meet.
CALENDAR_EVENT یک نوع پیوند غنی از پیام تقویم. به عنوان مثال، یک تراشه تقویم.

درایولینک دیتا

داده‌های مربوط به لینک‌های گوگل درایو.

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

object ( DriveDataRef )

یک DriveDataRef که به یک فایل گوگل درایو ارجاع می‌دهد.

mimeType

string

نوع MIME منبع گوگل درایو لینک‌شده.

ChatSpaceLinkData

داده‌ها برای لینک‌های فضای چت.

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

string

فضای منبع فضای چت لینک شده.

قالب: spaces/{space}

thread

string

رشته‌ی منبع فضای چتِ لینک‌شده.

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

message

string

پیام منبع فضای چت لینک‌شده.

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

MeetSpaceLinkData

داده‌های مربوط به پیوندهای Meet space.

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

string

کد جلسه فضای Meet مرتبط.

type

enum ( Type )

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

huddleStatus

enum ( HuddleStatus )

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

نوع

نوع فضای ملاقات.

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

وضعیت تجمع

وضعیت گردهمایی

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

تقویمرویدادپیوندداده

داده‌های مربوط به پیوندهای رویداد تقویم.

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

string

شناسه تقویم تقویم پیوند داده شده.

eventId

string

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

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

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

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

object ( CustomEmoji )

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

موضوع

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

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

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

string

شناسه. نام منبعِ نخ.

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

threadKey

string

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

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

اکشن‌ریسپشن

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

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

enum ( ResponseType )

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

url

string

فقط ورودی. آدرس اینترنتی برای تأیید اعتبار یا پیکربندی کاربران. (فقط برای انواع پاسخ REQUEST_CONFIG .)

dialogAction

object ( DialogAction )

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

updatedWidget

object ( UpdatedWidget )

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

نوع پاسخ

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

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

دیالوگ اکشن

شامل یک کادر محاوره‌ای و کد وضعیت درخواست است.

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

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
فیلدها
actionStatus

object ( ActionStatus )

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

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

object ( Dialog )

فقط ورودی. کادر محاوره‌ای برای درخواست.

گفتگو

دور بدنه‌ی کارتِ دیالوگ را می‌پوشاند.

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

object ( Card )

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

وضعیت اقدام

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

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

enum ( Code )

کد وضعیت.

userFacingMessage

string

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

کد

کدهای خطای متعارف برای API های gRPC.

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

انوم‌ها
OK

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

نگاشت HTTP: 200 OK

CANCELLED

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

نگاشت HTTP: درخواست بسته شده کلاینت ۴۹۹

UNKNOWN

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

نگاشت 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: ۴۰۳ ممنوع

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

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

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

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

DATA_LOSS

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

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

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

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

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

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
فیلدها
widget

string

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

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

object ( SelectionItems )

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

موارد انتخابی

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

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

object ( SelectionItem )

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

اسلش کامند

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

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

string ( int64 format)

شناسه‌ی دستور اسلش.

آدرس اینترنتی منطبق

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

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

string

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

خلاصه واکنش ایموجی

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

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

object ( Emoji )

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

reactionCount

integer

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

حذففراداده

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

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

enum ( DeletionType )

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

نوع حذف

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

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

فراداده‌ی پیام نقل‌قول‌شده

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

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

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

برای مثال، به نقل قول از یک پیام دیگر مراجعه کنید.

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

string

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

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

lastUpdateTime

string ( Timestamp format)

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

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

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

گیف پیوست شده

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

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

string

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

ویجت لوازم جانبی

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

نمایش JSON 
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
فیلدها
action میدانی اتحادیه. نوع اقدام. action می‌تواند فقط یکی از موارد زیر باشد:
buttonList

object ( ButtonList )

فهرستی از دکمه‌ها.

روش‌ها

create

 پیامی را در فضای چت گوگل ایجاد می‌کند.

delete

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

get

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

list

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

patch

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

update

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