REST Resource: spaces.messages

منبع: پیام

پیامی در فضای چت Google.

نمایندگی 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 . برای جزئیات، به نام پیام مراجعه کنید.

sender

object ( User )

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

createTime

string ( Timestamp format)

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

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

lastUpdateTime

string ( Timestamp format)

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

deleteTime

string ( Timestamp format)

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

text

string

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

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

formattedText

string

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

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

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

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

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

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

cards[]
(deprecated)

object ( Card )

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

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

cardsV2[]

object ( CardWithId )

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

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

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

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

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

annotations[]

object ( Annotation )

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

thread

object ( Thread )

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

space

object ( Space )

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

fallbackText

string

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

actionResponse

object ( ActionResponse )

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

argumentText

string

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

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 )

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

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

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

deletionMetadata

object ( DeletionMetadata )

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

quotedMessageMetadata

object ( QuotedMessageMetadata )

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

attachedGifs[]

object ( AttachedGif )

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

accessoryWidgets[]

object ( AccessoryWidget )

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

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

CardWithId

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

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

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

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

نمایندگی JSON
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
زمینه های
cardId

string

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

card

object ( Card )

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

حاشیه نویسی

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

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

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)
  }
  // End of list of possible types for union field metadata.
}
زمینه های
type

enum ( AnnotationType )

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

length

integer

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

startIndex

integer

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

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

object ( UserMentionMetadata )

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

slashCommand

object ( SlashCommandMetadata )

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

AnnotationType

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

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

UserMentionMetadata

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

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

object ( User )

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

type

enum ( Type )

نوع ذکر کاربر

تایپ کنید

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

SlashCommandMetadata

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

نمایندگی 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

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

تایپ کنید

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

RichLink Metadata

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

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

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  }
  // End of list of possible types for union field data.
}
زمینه های
uri

string

URI این لینک.

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

RichLinkType

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

Enums
DRIVE_FILE یک نوع پیوند غنی از Google Drive.

DriveLinkData

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

نمایندگی JSON
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
زمینه های
driveDataRef

object ( DriveDataRef )

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

mimeType

string

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

نخ

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

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

نمایندگی JSON
{
  "name": string,
  "threadKey": string
}
زمینه های
name

string

فقط خروجی نام منبع موضوع.

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

threadKey

string

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

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

ActionResponse

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

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

enum ( ResponseType )

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

url

string

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

dialogAction

object ( DialogAction )

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

updatedWidget

object ( 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 پرس و جو گزینه های تکمیل خودکار متن ویجت.

DialogAction

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

نمایندگی 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 )

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

ActionStatus

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

نمایندگی 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 ترجیح دهید.

Enums
OK

خطا نیست؛ با موفقیت بازگشت.

نقشه برداری HTTP: 200 OK

CANCELLED

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

HTTP Mapping: 499 Client Request

UNKNOWN

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

HTTP Mapping: 500 خطای سرور داخلی

INVALID_ARGUMENT

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

نقشه برداری HTTP: 400 درخواست بد

DEADLINE_EXCEEDED

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

HTTP Mapping: 504 Gateway Timeout

NOT_FOUND

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

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

نقشه برداری HTTP: 404 یافت نشد

ALREADY_EXISTS

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

HTTP Mapping: 409 Conflict

PERMISSION_DENIED

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

HTTP Mapping: 403 Forbidden

UNAUTHENTICATED

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

نقشه برداری HTTP: 401 غیر مجاز

RESOURCE_EXHAUSTED

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

نقشه برداری HTTP: 429 درخواست خیلی زیاد

FAILED_PRECONDITION

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

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

نقشه برداری HTTP: 400 درخواست بد

ABORTED

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

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

HTTP Mapping: 409 Conflict

OUT_OF_RANGE

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

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

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

نقشه برداری HTTP: 400 درخواست بد

UNIMPLEMENTED

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

نقشه برداری HTTP: 501 اجرا نشده است

INTERNAL

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

HTTP Mapping: 500 خطای سرور داخلی

UNAVAILABLE

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

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

نقشه برداری HTTP: سرویس 503 در دسترس نیست

DATA_LOSS

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

HTTP Mapping: 500 خطای سرور داخلی

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

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

نمایندگی 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

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

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

object ( SelectionItems )

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

انتخاب آیتم ها

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

نمایندگی JSON
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
زمینه های
items[]

object ( SelectionItem )

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

SlashCommand

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

نمایندگی JSON
{
  "commandId": string
}
زمینه های
commandId

string ( int64 format)

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

MatchedUrl

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

نمایندگی JSON
{
  "url": string
}
زمینه های
url

string

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

EmojiReactionSummary

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

نمایندگی JSON
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
زمینه های
emoji

object ( Emoji )

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

reactionCount

integer

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

حذف متادیتا

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

نمایندگی JSON
{
  "deletionType": enum (DeletionType)
}
زمینه های
deletionType

enum ( DeletionType )

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

نوع حذف

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

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

QuotedMessageMetadata

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

نمایندگی JSON
{
  "name": string,
  "lastUpdateTime": string
}
زمینه های
name

string

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

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

lastUpdateTime

string ( Timestamp format)

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

گیف پیوست شده

یک تصویر 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

 پیامی را در فضای چت Google ایجاد می کند.

delete

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

get

 جزئیات یک پیام را برمی گرداند.

list

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

patch

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

update

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