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,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ]
}
ช่อง
name

string

ชื่อทรัพยากรในรูปแบบ spaces/*/messages/*

เช่น spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB
sender

object (User)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างข้อความ หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตจะแสดงค่าผู้ใช้ name และ type
createTime

string (Timestamp format)

สำหรับพื้นที่ทำงานที่สร้างใน Chat เวลาที่สร้างข้อความ ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ที่นำเข้า

สําหรับพื้นที่ทำงานที่นําเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาในอดีตที่ข้อความสร้างขึ้นในแหล่งที่มาเพื่อรักษาเวลาที่สร้างไว้ในตอนแรก
lastUpdateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ผู้ใช้แก้ไขข้อความครั้งล่าสุด หากไม่เคยแก้ไขข้อความ ช่องนี้จะว่างเปล่า
deleteTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ข้อความถูกลบใน Google Chat หากไม่ได้ลบข้อความ ช่องนี้ก็จะว่างเปล่า
text

string

เนื้อหาข้อความล้วนเป็นข้อความธรรมดา ลิงก์แรกที่ไปยังรูปภาพ วิดีโอ หรือหน้าเว็บจะสร้างชิปตัวอย่าง นอกจากนี้ยังใช้การ @พูดถึงผู้ใช้ Google Chat หรือทุกคนในพื้นที่ทำงานได้ด้วย

หากต้องการเรียนรู้เกี่ยวกับการสร้างข้อความ โปรดดูสร้างข้อความ
formattedText

string

เอาต์พุตเท่านั้น มีข้อความ text โดยเพิ่มมาร์กอัปเพื่อสื่อสารการจัดรูปแบบ ช่องนี้อาจไม่ได้บันทึกการจัดรูปแบบทั้งหมดใน UI แต่รวมถึงการจัดรูปแบบต่อไปนี้

  • ไวยากรณ์มาร์กอัปสำหรับตัวหนา ตัวเอียง ขีดทับ โมโนสเปซ และบล็อกตัวอักษรเดี่ยว
  • ผู้ใช้พูดถึงโดยใช้รูปแบบ <users/{user}>
  • ไฮเปอร์ลิงก์ที่กำหนดเองโดยใช้รูปแบบ <{url}|{rendered_text}> โดยที่สตริงแรกเป็น URL และไฮเปอร์ลิงก์ที่ 2 คือข้อความที่แสดงผล เช่น <http://example.com|custom text>
  • อีโมจิที่กำหนดเองโดยใช้รูปแบบ :{emoji_name}: เช่น :smile: การดำเนินการนี้ใช้ไม่ได้กับอีโมจิแบบ Unicode เช่น U+1F600 สำหรับอีโมจิรูปหน้ายิ้ม

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดูการจัดรูปแบบข้อความที่ส่งในข้อความ
cards[]
(deprecated)

object (Card)

เลิกใช้งานแล้ว: ใช้ cardsV2 แทน

การ์ดสื่อสมบูรณ์ การจัดรูปแบบ และแบบอินเทอร์แอกทีฟที่คุณสามารถใช้เพื่อแสดงองค์ประกอบ UI เช่น ข้อความที่จัดรูปแบบ ปุ่ม และรูปภาพที่คลิกได้ โดยปกติแล้วการ์ดจะแสดงอยู่ใต้เนื้อหาข้อความธรรมดาของข้อความ cards และ cardsV2 มีขนาดได้ไม่เกิน 32 KB
cardsV2[]

object (CardWithId)

อาร์เรย์ของการ์ด

มีเพียงแอปใน Chat เท่านั้นที่สามารถสร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ ข้อความจะไม่มีการ์ด

ดูข้อมูลเกี่ยวกับการ์ดและวิธีสร้างการ์ดได้ที่ออกแบบ UI แบบไดนามิก อินเทอร์แอกทีฟ และสอดคล้องกัน
annotations[]

object (Annotation)

เอาต์พุตเท่านั้น คำอธิบายประกอบที่เชื่อมโยงกับ text ในข้อความนี้
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)

เอาต์พุตเท่านั้น URL ใน spaces.messages.text ที่ตรงกับรูปแบบตัวอย่างลิงก์ ดูข้อมูลเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์
threadReply

boolean

เอาต์พุตเท่านั้น เมื่อ true ข้อความจะเป็นการตอบกลับในชุดข้อความตอบกลับ เมื่อ false ข้อความจะปรากฏในการสนทนาระดับบนสุดของพื้นที่ทำงานในรูปแบบข้อความแรกของชุดข้อความหรือข้อความที่ไม่มีการตอบกลับแบบแยกชุดข้อความ

หากพื้นที่ทำงานไม่รองรับการตอบกลับในชุดข้อความ ช่องนี้จะเป็น false เสมอ
clientAssignedMessageId

string

ชื่อที่กำหนดเองของข้อความใน Chat ที่กำหนดขณะสร้าง ต้องขึ้นต้นด้วย client- และประกอบด้วยตัวอักษรพิมพ์เล็ก ตัวเลข และขีดกลางโดยมีความยาวไม่เกิน 63 อักขระ ระบุช่องนี้เพื่อรับ อัปเดต หรือลบข้อความที่มีค่าที่ระบุ การกำหนดชื่อที่กำหนดเองจะช่วยให้แอป Chat เรียกคืนข้อความได้โดยไม่ต้องบันทึกข้อความ name จากเนื้อหาการตอบกลับที่แสดงผลเมื่อสร้างข้อความ การกําหนดชื่อที่กําหนดเองจะไม่แทนที่ช่อง name ที่สร้างขึ้น ซึ่งเป็นชื่อทรัพยากรของข้อความ แต่จะตั้งชื่อที่กําหนดเองเป็นช่อง clientAssignedMessageId แทน ซึ่งคุณสามารถใช้อ้างอิงขณะประมวลผลในภายหลัง เช่น การอัปเดตหรือการลบข้อความ ดูตัวอย่างการใช้งานได้ที่หัวข้อตั้งชื่อข้อความที่สร้างขึ้น
emojiReactionSummaries[]

object (EmojiReactionSummary)

เอาต์พุตเท่านั้น รายการสรุปการแสดงความรู้สึกด้วยอีโมจิในข้อความ
deletionMetadata

object (DeletionMetadata)

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ถูกลบ ระบบจะลบข้อความเมื่อตั้งค่า deleteTime
quotedMessageMetadata

object (QuotedMessageMetadata)

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ยกมาโดยผู้ใช้ Google Chat ในพื้นที่ทำงาน ผู้ใช้ Google Chat จะยกข้อความมาตอบได้
attachedGifs[]

object (AttachedGif)

เอาต์พุตเท่านั้น GIF ที่แนบมากับข้อความ

CardWithId

การ์ดในข้อความ Google Chat

มีเพียงแอปใน Chat เท่านั้นที่สามารถสร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ ข้อความจะไม่มีการ์ด

การแสดง JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
ช่อง
cardId

string

ต้องระบุหากข้อความมีการ์ดหลายใบ ตัวระบุที่ไม่ซ้ำกันสำหรับการ์ดในข้อความ
card

object (Card)

การ์ด ขนาดสูงสุดคือ 32 KB

หมายเหตุ

เอาต์พุตเท่านั้น คำอธิบายประกอบที่เกี่ยวข้องกับเนื้อหาข้อความธรรมดาของข้อความ หากต้องการเพิ่มการจัดรูปแบบพื้นฐานให้กับข้อความ โปรดดูหัวข้อจัดรูปแบบข้อความ

ตัวอย่างเนื้อหาข้อความธรรมดา

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)
  }
  // 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)

ข้อมูลเมตาสำหรับคำสั่งเครื่องหมายทับ

ประเภทหมายเหตุ

ประเภทของคำอธิบายประกอบ

Enum
ANNOTATION_TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
USER_MENTION มีการพูดถึงผู้ใช้
SLASH_COMMAND ระบบจะเรียกใช้คําสั่งเครื่องหมายทับ

ข้อมูลเมตาที่กล่าวถึงของผู้ใช้

ข้อมูลเมตาคำอธิบายประกอบสำหรับการพูดถึงของผู้ใช้ (@)

การแสดง JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
ช่อง
user

object (User)

ผู้ใช้พูดถึง
type

enum (Type)

ประเภทการพูดถึงของผู้ใช้

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
ADD เพิ่มผู้ใช้ไปยังพื้นที่ทำงาน
MENTION พูดถึงผู้ใช้ในพื้นที่ทำงาน

ข้อมูลเมตาคําสั่งเครื่องหมายทับ

ข้อมูลเมตาคำอธิบายประกอบสำหรับคำสั่งเครื่องหมายทับ (/)

การแสดง 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

ระบุว่าเป็นคําสั่งเครื่องหมายทับสําหรับกล่องโต้ตอบหรือไม่

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
ADD เพิ่มแอป Chat ไปยังพื้นที่ทำงาน
INVOKE เรียกใช้คําสั่งเครื่องหมายทับในพื้นที่ทํางาน

ชุดข้อความ

ชุดข้อความจากพื้นที่ทำงานใน Google Chat ตัวอย่างการใช้งาน โปรดดูหัวข้อเริ่มต้นหรือตอบกลับชุดข้อความ

หากคุณระบุชุดข้อความเมื่อสร้างข้อความ คุณจะตั้งค่าช่อง messageReplyOption ได้เพื่อให้ระบุสิ่งที่จะเกิดขึ้นหากไม่พบชุดข้อความที่ตรงกัน

การแสดง JSON 
{
  "name": string,
  "threadKey": string
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของชุดข้อความ

เช่น spaces/{space}/threads/{thread}
threadKey

string

ไม่บังคับ อินพุตสําหรับการสร้างหรืออัปเดตชุดข้อความ มิเช่นนั้น ให้แสดงผลเท่านั้น รหัสของชุดข้อความ รองรับอักขระสูงสุด 4,000 ตัว

ซึ่งจะเป็นรหัสเฉพาะของแอป Chat ที่ตั้งค่ารหัสดังกล่าว เช่น หากแอป Chat หลายแอปสร้างข้อความโดยใช้คีย์ชุดข้อความเดียวกัน ระบบจะโพสต์ข้อความในชุดข้อความที่ต่างกัน หากต้องการตอบกลับในชุดข้อความที่สร้างโดยบุคคลหรือแอป Chat อื่น ให้ระบุช่องชุดข้อความ name แทน

การตอบสนองการดำเนินการ

พารามิเตอร์ที่แอป Chat ใช้เพื่อกำหนดค่าวิธีโพสต์การตอบกลับได้

การแสดง JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}
ช่อง
type

enum (ResponseType)

อินพุตเท่านั้น ประเภทการตอบกลับของแอป Chat
url

string

อินพุตเท่านั้น URL สำหรับให้ผู้ใช้ตรวจสอบสิทธิ์หรือกำหนดค่า (สำหรับคำตอบ REQUEST_CONFIG ประเภทเท่านั้น)
dialogAction

object (DialogAction)

อินพุตเท่านั้น การตอบกลับเหตุการณ์ที่เกี่ยวข้องกับกล่องโต้ตอบ ต้องมี ResponseType.Dialog

ประเภทการตอบสนอง

ประเภทการตอบกลับของแอป Chat

Enum
TYPE_UNSPECIFIED ประเภทเริ่มต้นที่จัดการแบบ NEW_MESSAGE
NEW_MESSAGE โพสต์เป็นข้อความใหม่ในหัวข้อ
UPDATE_MESSAGE อัปเดตข้อความของแอป Chat การดำเนินการนี้ทำได้เฉพาะในเหตุการณ์ CARD_CLICKED ซึ่งประเภทผู้ส่งข้อความคือ BOT
UPDATE_USER_MESSAGE_CARDS อัปเดตการ์ดในข้อความของผู้ใช้ วิธีนี้จะช่วยตอบเฉพาะเหตุการณ์ MESSAGE ที่มี URL ที่ตรงกัน หรือเหตุการณ์ CARD_CLICKED ที่มีประเภทผู้ส่งข้อความเป็น HUMAN เท่านั้น ข้อความจะถูกละเว้น
REQUEST_CONFIG ขอการตรวจสอบสิทธิ์หรือการกำหนดค่าเพิ่มเติมจากผู้ใช้แบบส่วนตัว
DIALOG แสดงกล่องโต้ตอบ

การดำเนินการโต้ตอบ

มีกล่องโต้ตอบและรหัสสถานะคำขอ

การแสดง 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)

อินพุตเท่านั้น กล่องโต้ตอบสำหรับคำขอ

Dialog

ใส่กรอบล้อมรอบเนื้อหาการ์ดของกล่องโต้ตอบ

การแสดง JSON 
{
  "body": {
    object (Card)
  }
}
ช่อง
body

object (Card)

อินพุตเท่านั้น เนื้อหาของกล่องโต้ตอบ ซึ่งแสดงผลในโมดัล แอป Google Chat ไม่รองรับเอนทิตีของบัตรต่อไปนี้: DateTimePicker, OnChangeAction

สถานะการดำเนินการ

แสดงสถานะของคำขอในการเรียกใช้หรือส่งกล่องโต้ตอบ

การแสดง JSON 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
ช่อง
statusCode

enum (Code)

รหัสสถานะ
userFacingMessage

string

ข้อความที่จะให้ผู้ใช้เกี่ยวกับสถานะคำขอ หากไม่ได้ตั้งค่า ระบบจะส่งข้อความทั่วไปตาม statusCode

รหัส

รหัสข้อผิดพลาดตามรูปแบบบัญญัติสำหรับ gRPC API

บางครั้งอาจมีรหัสข้อผิดพลาดหลายรายการ บริการควรแสดงรหัสข้อผิดพลาดที่เกี่ยวข้องและเฉพาะเจาะจงมากที่สุด เช่น เลือกใช้ OUT_OF_RANGE แทน FAILED_PRECONDITION หากใช้รหัสทั้งสองแบบ ในทำนองเดียวกัน ชอบ NOT_FOUND หรือ ALREADY_EXISTS มากกว่า FAILED_PRECONDITION

Enum
OK

ไม่ใช่ข้อผิดพลาด แต่ส่งคืนสำเร็จ

การจับคู่ HTTP: 200 OK
CANCELLED

โดยปกติผู้โทรจะยกเลิกการดำเนินการ

การแมป HTTP: 499 คำขอปิดไคลเอ็นต์โดยไคลเอ็นต์
UNKNOWN

ข้อผิดพลาดที่ไม่รู้จัก ตัวอย่างเช่น ระบบอาจแสดงข้อผิดพลาดนี้เมื่อค่า Status ที่ได้รับจากพื้นที่ที่อยู่อื่นอยู่ในพื้นที่ข้อผิดพลาดที่ระบบไม่รู้จักในพื้นที่ที่อยู่นี้ นอกจากนี้ข้อผิดพลาดที่เกิดจาก API ที่ไม่แสดงผลข้อมูลข้อผิดพลาดอย่างเพียงพออาจถูกแปลงเป็นข้อผิดพลาดนี้

การแมป HTTP: 500 ข้อผิดพลาดภายในเซิร์ฟเวอร์
INVALID_ARGUMENT

ไคลเอ็นต์ระบุอาร์กิวเมนต์ไม่ถูกต้อง โปรดทราบว่าจำนวนนี้จะแตกต่างจาก FAILED_PRECONDITION INVALID_ARGUMENT จะระบุอาร์กิวเมนต์ที่เป็นปัญหาไม่ว่าระบบอยู่ในสถานะใด (เช่น ชื่อไฟล์มีรูปแบบไม่ถูกต้อง)

การแมป HTTP: 400 คำขอไม่ถูกต้อง
DEADLINE_EXCEEDED

กําหนดเวลาหมดอายุก่อนที่การดําเนินการจะเสร็จสิ้น สำหรับการดำเนินการที่เปลี่ยนสถานะของระบบ ข้อผิดพลาดนี้อาจปรากฏขึ้นแม้ว่าจะดำเนินการสำเร็จแล้วก็ตาม เช่น การตอบกลับที่สำเร็จจากเซิร์ฟเวอร์อาจล่าช้าไปนานพอที่กำหนดเวลาจะหมดอายุ

การแมป HTTP: 504 เกตเวย์หมดเวลา
NOT_FOUND

ไม่พบเอนทิตีที่ขอ (เช่น ไฟล์หรือไดเรกทอรี) บางรายการ

หมายเหตุสําหรับนักพัฒนาเซิร์ฟเวอร์: หากคําขอถูกปฏิเสธสําหรับผู้ใช้ทั้งชั้นเรียน เช่น การทยอยเปิดตัวฟีเจอร์หรือรายการที่อนุญาตที่ไม่ได้ระบุไว้ ระบบอาจใช้ NOT_FOUND หากระบบปฏิเสธคำขอสำหรับผู้ใช้บางรายภายในกลุ่มผู้ใช้ เช่น การควบคุมการเข้าถึงจากผู้ใช้ จะต้องมีการใช้ PERMISSION_DENIED

การแมป HTTP: 404 ไม่พบ
ALREADY_EXISTS

มีเอนทิตีที่ไคลเอ็นต์พยายามสร้าง (เช่น ไฟล์หรือไดเรกทอรี) อยู่แล้ว

การแมป HTTP: 409 เกิดความขัดแย้ง
PERMISSION_DENIED

ผู้โทรไม่มีสิทธิ์ดำเนินการที่ระบุ ต้องไม่ใช้ PERMISSION_DENIED สำหรับการปฏิเสธที่เกิดจากการใช้ทรัพยากรบางส่วนจนหมด (ใช้ RESOURCE_EXHAUSTED แทนสำหรับข้อผิดพลาดเหล่านั้น) ระบบจะไม่ใช้ PERMISSION_DENIED หากไม่สามารถระบุผู้โทรได้ (ใช้ UNAUTHENTICATED แทนสำหรับข้อผิดพลาดเหล่านั้น) รหัสข้อผิดพลาดนี้ไม่ได้บอกเป็นนัยว่าคำขอถูกต้อง หรือมีเอนทิตีที่ขออยู่แล้ว หรือเป็นไปตามเงื่อนไขเบื้องต้นอื่นๆ

การแมป HTTP: 403 Forbidden
UNAUTHENTICATED

คำขอไม่มีข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ที่ถูกต้องสำหรับการดำเนินการ

การแมป HTTP: 401 ไม่ได้รับอนุญาต
RESOURCE_EXHAUSTED

ทรัพยากรบางส่วนหมดไป อาจมีโควต้าต่อผู้ใช้หรือพื้นที่เก็บข้อมูลทั้งระบบไฟล์เต็มแล้ว

การแมป HTTP: 429 มีคำขอมากเกินไป
FAILED_PRECONDITION

การดำเนินการถูกปฏิเสธเนื่องจากระบบไม่อยู่ในสถานะที่จำเป็นสำหรับการดำเนินการ เช่น ไดเรกทอรีที่จะลบไม่ว่างเปล่า มีการใช้การดำเนินการ rmdir กับไดเรกทอรีที่ไม่ใช่ไดเรกทอรี เป็นต้น

ผู้ติดตั้งใช้งานบริการสามารถใช้หลักเกณฑ์ต่อไปนี้ในการตัดสินใจระหว่าง FAILED_PRECONDITION, ABORTED และ UNAVAILABLE ดังนี้ (ก) ใช้ UNAVAILABLE หากไคลเอ็นต์ลองเรียกที่ไม่สำเร็จอีกครั้ง (ข) ใช้ ABORTED หากลูกค้าควรลองอีกครั้งในระดับที่สูงกว่า ตัวอย่างเช่น เมื่อการทดสอบและตั้งค่าที่ระบุโดยไคลเอ็นต์ล้มเหลว ซึ่งบ่งชี้ว่าไคลเอ็นต์ควรรีสตาร์ทลำดับ Read-modify-write (ค) ใช้ FAILED_PRECONDITION หากลูกค้าไม่ควรลองอีกครั้งจนกว่าสถานะระบบจะได้รับการแก้ไขอย่างชัดเจน เช่น หากคำสั่ง "rmdir" ล้มเหลวเนื่องจากไดเรกทอรีไม่ว่างเปล่า ระบบจะแสดงผล FAILED_PRECONDITION เนื่องจากไคลเอ็นต์จะไม่ลองอีกครั้ง เว้นแต่จะมีการลบไฟล์ออกจากไดเรกทอรี

การแมป HTTP: 400 คำขอไม่ถูกต้อง
ABORTED

การดำเนินการถูกล้มเลิก ซึ่งโดยปกติจะเกิดจากปัญหาการเกิดขึ้นพร้อมกัน เช่น ความล้มเหลวในการตรวจสอบตัวลำดับหรือล้มเลิกธุรกรรม

ดูหลักเกณฑ์ด้านบนในการตัดสินใจระหว่าง FAILED_PRECONDITION, ABORTED และ UNAVAILABLE

การแมป HTTP: 409 เกิดความขัดแย้ง
OUT_OF_RANGE

การดำเนินการผ่านช่วงที่ถูกต้องแล้ว เช่น การกรอวิดีโอหรือการอ่านส่วนท้ายของไฟล์

ข้อผิดพลาดนี้ต่างจาก INVALID_ARGUMENT ตรงที่บ่งบอกถึงปัญหาที่อาจได้รับการแก้ไขหากสถานะของระบบเปลี่ยนแปลง ตัวอย่างเช่น ระบบไฟล์ 32 บิตจะสร้าง INVALID_ARGUMENT หากระบบขอให้อ่านค่าออฟเซ็ตที่ไม่อยู่ในช่วง [0,2^32-1] แต่จะสร้าง OUT_OF_RANGE หากระบบขอให้อ่านจากออฟเซ็ตหลังจากขนาดไฟล์ปัจจุบัน

FAILED_PRECONDITION และ OUT_OF_RANGE ค่อนข้างทับซ้อนกันเล็กน้อย เราขอแนะนำให้ใช้ OUT_OF_RANGE (ยิ่งมีข้อผิดพลาดที่เจาะจงมากขึ้น) เพื่อให้ผู้โทรที่กำลังปรับปรุงพื้นที่ทำงานสามารถตรวจหาข้อผิดพลาด OUT_OF_RANGE เพื่อตรวจหาเมื่อเสร็จสิ้นการดำเนินการได้อย่างง่ายดาย

การแมป HTTP: 400 คำขอไม่ถูกต้อง
UNIMPLEMENTED

การดำเนินการยังใช้ไม่ได้หรือไม่รองรับ/เปิดใช้ในบริการนี้

การแมป HTTP: 501 ไม่ได้นำมาใช้
INTERNAL

ข้อผิดพลาดภายใน ซึ่งหมายความว่าตัวแปรบางอย่างที่คาดว่าจะได้รับจากระบบที่สำคัญไม่ทำงาน รหัสข้อผิดพลาดนี้สงวนไว้สำหรับข้อผิดพลาดร้ายแรงเท่านั้น

การแมป HTTP: 500 ข้อผิดพลาดภายในเซิร์ฟเวอร์
UNAVAILABLE

ไม่พร้อมให้บริการนี้ในขณะนี้ เหตุการณ์นี้น่าจะเป็นเงื่อนไขชั่วคราว ซึ่งแก้ไขได้ด้วยการลองอีกครั้งโดยใช้ Backoff โปรดทราบว่าการลองดำเนินการที่ไม่ใช่แบบกำหนดอีกครั้งอาจไม่ปลอดภัยเสมอไป

ดูหลักเกณฑ์ด้านบนในการตัดสินใจระหว่าง FAILED_PRECONDITION, ABORTED และ UNAVAILABLE

การแมป HTTP: 503 ไม่พร้อมให้บริการ
DATA_LOSS

ข้อมูลเสียหายหรือสูญหายโดยกู้คืนไม่ได้

การแมป HTTP: 500 ข้อผิดพลาดภายในเซิร์ฟเวอร์

คำสั่งเครื่องหมายทับ

คำสั่งเครื่องหมายทับใน Google Chat

การแสดง JSON 
{
  "commandId": string
}
ช่อง
commandId

string (int64 format)

รหัสของคำสั่งเครื่องหมายทับที่เรียกใช้

URL ที่ตรงกัน

URL ที่ตรงกันในข้อความแชท แอป Chat สามารถดูตัวอย่าง 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)

ระบุผู้ที่ลบข้อความ

ประเภทการลบ

ใครลบข้อความและวิธีที่ข้อความถูกลบ

Enum
DELETION_TYPE_UNSPECIFIED ไม่ได้ใช้ค่านี้
CREATOR ผู้ใช้ลบข้อความของตนเองแล้ว
SPACE_OWNER เจ้าของพื้นที่ทำงานลบข้อความแล้ว
ADMIN ผู้ดูแลระบบ Google Workspace เป็นผู้ลบข้อความ
APP_MESSAGE_EXPIRY แอป Chat ลบข้อความของตนเองเมื่อหมดอายุ
CREATOR_VIA_APP แอป Chat ลบข้อความในนามของผู้ใช้
SPACE_OWNER_VIA_APP แอป Chat ลบข้อความในนามของเจ้าของพื้นที่ทำงาน

quodMessageMetadata

ข้อมูลเกี่ยวกับข้อความที่ยกมา

การแสดง JSON 
{
  "name": string,
  "lastUpdateTime": string
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อแหล่งข้อมูลของข้อความที่ยกมา

รูปแบบ: spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาเมื่อสร้างข้อความที่ยกมาหรือเวลาที่ข้อความที่ยกมาอัปเดตล่าสุด

GIF ที่แนบมา

รูปภาพ GIF ที่ระบุโดย URL

การแสดง JSON 
{
  "uri": string
}
ช่อง
uri

string

เอาต์พุตเท่านั้น URL ที่โฮสต์รูปภาพ GIF

วิธีการ

create

 สร้างข้อความในพื้นที่ใน Google Chat

delete

 ลบข้อความ

get

 แสดงรายละเอียดเกี่ยวกับข้อความ

list

 แสดงข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก รวมถึงข้อความจากสมาชิกและพื้นที่ทำงานที่ถูกบล็อก

patch

 อัปเดตข้อความ

update

 อัปเดตข้อความ