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 ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะป้อนข้อมูลเฉพาะในช่อง user name และ type สำหรับทั้งผู้ใช้ภายในและภายนอก เว้นแต่ว่าผู้ใช้เหล่านั้นจะเป็นสมาชิกของพื้นที่ทำงานหรือมีความสัมพันธ์ก่อนหน้านี้ เช่น การสนทนาผ่านข้อความส่วนตัว (DM) กับผู้ใช้ที่โทร
createTime

string (Timestamp format)

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

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

string (Timestamp format)

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

string (Timestamp format)

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

string

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

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

string

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

  • ไวยากรณ์มาร์กอัปสำหรับตัวหนา ตัวเอียง ขีดทับ ความกว้างอักษรขนาดเดียว บล็อกความกว้างอักษรขนาดเดียว รายการสัญลักษณ์หัวข้อย่อย และการยกข้อความมาอ้าง

  • การพูดถึงผู้ใช้โดยใช้รูปแบบ <users/{user}>

  • ไฮเปอร์ลิงก์ที่กำหนดเองโดยใช้รูปแบบ <{url}|{rendered_text}> โดยที่สตริงแรกคือ URL และสตริงที่ 2 คือข้อความที่แสดงผล เช่น <http://example.com|custom text>

  • อีโมจิที่กำหนดเองโดยใช้รูปแบบ :{emojiName}: เช่น :smile: แต่จะไม่มีผลกับอีโมจิ Unicode เช่น U+1F600 สำหรับอีโมจิหน้ายิ้มกว้าง

  • รายการสัญลักษณ์หัวข้อย่อยที่ใช้เครื่องหมายดอกจัน (*) เช่น * item

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

object (Card)

เลิกใช้งานแล้ว: โปรดใช้ cardsV2 แทน

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

object (CardWithId)

ไม่บังคับ อาร์เรย์ของการ์ด

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

หากต้องการดูวิธีสร้างข้อความที่มีการ์ด โปรดดูหัวข้อส่งข้อความ

ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด
annotations[]

object (Annotation)

เอาต์พุตเท่านั้น คำอธิบายประกอบสามารถเชื่อมโยงกับเนื้อหาข้อความธรรมดาของข้อความหรือชิปที่ลิงก์ไปยังแหล่งข้อมูล Google Workspace เช่น Google เอกสารหรือชีตที่มี startIndex และ length เป็น 0
thread

object (Thread)

ชุดข้อความที่มีข้อความอยู่ ดูตัวอย่างการใช้งานได้ที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ
space

object (Space)

เอาต์พุตเท่านั้น หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะป้อนข้อมูลเฉพาะ space name
fallbackText

string

ไม่บังคับ คำอธิบายข้อความธรรมดาของการ์ดของข้อความ ซึ่งใช้เมื่อไม่สามารถแสดงการ์ดจริงได้ เช่น การแจ้งเตือนบนมือถือ
actionResponse

object (ActionResponse)

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

string

เอาต์พุตเท่านั้น เนื้อหาข้อความธรรมดาของข้อความที่มีการนำการพูดถึงแอปใน Chat ทั้งหมดออก
slashCommand

object (SlashCommand)

เอาต์พุตเท่านั้น ข้อมูลคำสั่งเครื่องหมายทับ (หากมี)
attachment[]

object (Attachment)

ไม่บังคับ ไฟล์แนบที่ผู้ใช้อัปโหลด
matchedUrl

object (MatchedUrl)

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

boolean

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

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

boolean

เอาต์พุตเท่านั้น ข้อความนี้เป็นข้อความแบบไม่มีการแจ้งเตือนหรือไม่ ข้อความแบบไม่มีเสียงคือข้อความที่ Chat ระงับข้อความ Push สำหรับผู้รับ
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)

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

การสร้างข้อความที่มีวิดเจ็ตเสริมต้องใช้การตรวจสอบสิทธิ์ของแอป
elements

object (Elements)

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

markupSyntax

enum (MarkupSyntax)

ไม่บังคับ ระบุวิธีที่เซิร์ฟเวอร์ตีความเนื้อหาช่อง text ของข้อความ

CardWithId

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

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

หากต้องการดูวิธีสร้างข้อความที่มีการ์ด โปรดดูหัวข้อส่งข้อความ

ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด

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

string

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

object (Card)

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

object (User)

เอาต์พุตเท่านั้น แอปที่เป็นเจ้าของบัตร

หมายเหตุ

คำอธิบายประกอบสามารถเชื่อมโยงกับเนื้อหาข้อความธรรมดาของข้อความหรือชิปที่ลิงก์ไปยังแหล่งข้อมูล Google Workspace เช่น Google เอกสารหรือชีตที่มี startIndex และ length เป็น 0 หากต้องการเพิ่มการจัดรูปแบบพื้นฐานให้กับ SMS โปรดดูหัวข้อจัดรูปแบบ SMS

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

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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
ช่อง
type

enum (AnnotationType)

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

integer

ความยาวของสตริงย่อยในเนื้อหาข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องด้วย หากไม่มี จะแสดงความยาวเป็น 0
startIndex

integer

ดัชนีเริ่มต้น (แบบ 0, รวม) ในเนื้อหาข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องด้วย
ข้อมูลเมตาเพิ่มเติมเกี่ยวกับคำอธิบายประกอบ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
userMention

object (UserMentionMetadata)

ข้อมูลเมตาของการพูดถึงผู้ใช้
slashCommand

object (SlashCommandMetadata)

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

object (CustomEmojiMetadata)

ข้อมูลเมตาสำหรับอีโมจิที่กำหนดเอง
สิ้นสุดฟิลด์ที่แยกกัน

AnnotationType

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

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

UserMentionMetadata

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

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

object (User)

ผู้ใช้ที่พูดถึง
type

enum (Type)

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

ประเภท

Enum
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

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

ประเภท

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

RichLinkMetadata

ลิงก์แบบริชไปยังแหล่งข้อมูล ลิงก์ริชมีเดียสามารถเชื่อมโยงกับเนื้อหาข้อความธรรมดาของข้อความหรือแสดงชิปที่ลิงก์ไปยังแหล่งข้อมูล Google Workspace เช่น Google เอกสารหรือชีตที่มี startIndex และ length เป็น 0

การแสดง JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
ช่อง
uri

string

URI ของลิงก์นี้
ข้อมูลสำหรับแหล่งข้อมูลที่ลิงก์ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
สิ้นสุดฟิลด์ที่แยกกัน

RichLinkType

ประเภทลิงก์แบบริชมีเดีย ทั้งนี้อาจมีการเพิ่มประเภทอื่นๆ ในอนาคต

Enum
DRIVE_FILE ประเภท Rich Link ของ Google ไดรฟ์
CHAT_SPACE ประเภทลิงก์แบบริชมีเดียของพื้นที่ใน Chat เช่น ชิปอัจฉริยะของพื้นที่ทำงาน
GMAIL_MESSAGE ประเภทริชลิงก์ของข้อความ Gmail โดยเฉพาะชิป Gmail จากแชร์ไปยัง Chat API รองรับเฉพาะการอ่านข้อความที่มีลิงก์ Rich Link ของ GMAIL_MESSAGE เท่านั้น
MEET_SPACE ประเภทลิงก์ Rich Link ของข้อความ Meet เช่น ชิป Meet
CALENDAR_EVENT ประเภทริชลิงก์ของข้อความในปฏิทิน เช่น ชิปปฏิทิน

DriveLinkData

ข้อมูลสำหรับลิงก์ Google ไดรฟ์

การแสดง JSON 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
ช่อง
driveDataRef

object (DriveDataRef)

DriveDataRef ซึ่งอ้างอิงไฟล์ Google ไดรฟ์
mimeType

string

ประเภท MIME ของทรัพยากร Google ไดรฟ์ที่ลิงก์

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 เป็นการประชุมสั้นๆ จะระบุสถานะของการประชุมสั้นๆ ไม่เช่นนั้น ระบบจะไม่ตั้งค่านี้

ประเภท

ประเภทของพื้นที่ Meet

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
MEETING พื้นที่ Meet คือการประชุม
HUDDLE พื้นที่ Meet คือการประชุมสั้นๆ

HuddleStatus

สถานะของการประชุมสั้น

Enum
HUDDLE_STATUS_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
STARTED เริ่มการประชุมสั้นแล้ว
ENDED การประชุมสั้นสิ้นสุดแล้ว ในกรณีนี้ URI และตัวระบุของพื้นที่ Meet จะใช้ไม่ได้อีกต่อไป
MISSED ไม่ได้รับสายการประชุมสั้น ในกรณีนี้ URI และตัวระบุของพื้นที่ 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

ไม่บังคับ อินพุตสำหรับการสร้างหรืออัปเดตชุดข้อความ ไม่เช่นนั้นจะเป็นเอาต์พุตเท่านั้น รหัสสำหรับชุดข้อความ รองรับอักขระสูงสุด 4,000 ตัว

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

ActionResponse

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

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

enum (ResponseType)

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

string

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

object (DialogAction)

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

object (UpdatedWidget)

อินพุตเท่านั้น คำตอบของวิดเจ็ตที่อัปเดต

ResponseType

ประเภทการตอบกลับของแอปใน 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 แสดงกล่องโต้ตอบ
UPDATE_WIDGET คำค้นหาตัวเลือกการเติมข้อความอัตโนมัติของวิดเจ็ต

DialogAction

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

การแสดง JSON 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
ช่อง
actionStatus

object (ActionStatus)

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

object (Dialog)

อินพุตเท่านั้น กล่องโต้ตอบสำหรับคำขอ
สิ้นสุดฟิลด์ที่แยกกัน

Dialog

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

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

object (Card)

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

ActionStatus

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

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

enum (Code)

รหัสสถานะ
userFacingMessage

string

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

รหัส

รหัสข้อผิดพลาด Canonical สำหรับ gRPC API

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

Enum
OK

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

การแมป HTTP: 200 OK
CANCELLED

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

การแมป HTTP: 499 Client Closed Request
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 Not Found
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 หากไคลเอ็นต์ควรลองอีกครั้งในระดับที่สูงขึ้น เช่น เมื่อการทดสอบและตั้งค่าที่ไคลเอ็นต์ระบุล้มเหลว ซึ่งบ่งชี้ว่าไคลเอ็นต์ควรเริ่มลำดับการอ่าน-แก้ไข-เขียนใหม่ (ค) ใช้ 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 Not Implemented
INTERNAL

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

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

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

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

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

ข้อมูลรั่วไหลหรือเสียหายแบบกู้คืนไม่ได้

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

UpdatedWidget

สำหรับวิดเจ็ต selectionInput จะแสดงคำแนะนำที่เติมข้อความอัตโนมัติสำหรับเมนูแบบเลือกได้หลายรายการ

การแสดง JSON 
{
  "widget": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestions": {
    object (SelectionItems)
  }
}
ช่อง
widget

string

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

object (SelectionItems)

รายการผลการเติมข้อความอัตโนมัติของวิดเจ็ต
สิ้นสุดฟิลด์ที่แยกกัน

SelectionItems

รายการผลการเติมข้อความอัตโนมัติของวิดเจ็ต

การแสดง JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
ช่อง
items[]

object (SelectionItem)

อาร์เรย์ของออบเจ็กต์ SelectionItem

SlashCommand

ข้อมูลเมตาเกี่ยวกับคำสั่งเครื่องหมายทับใน Google Chat

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

string (int64 format)

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

MatchedUrl

URL ที่ตรงกันในข้อความแชท แอปใน Chat จะดูตัวอย่าง URL ที่ตรงกันได้ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดูตัวอย่างลิงก์

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

string

เอาต์พุตเท่านั้น URL ที่ตรงกัน

EmojiReactionSummary

จำนวนผู้ที่แสดงความรู้สึกต่อข้อความด้วยอีโมจิที่เฉพาะเจาะจง

การแสดง JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
ช่อง
emoji

object (Emoji)

เอาต์พุตเท่านั้น อีโมจิที่เชื่อมโยงกับรีแอ็กชัน
reactionCount

integer

เอาต์พุตเท่านั้น จำนวนรีแอ็กชันทั้งหมดที่ใช้อีโมจิที่เกี่ยวข้อง

DeletionMetadata

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

การแสดง JSON 
{
  "deletionType": enum (DeletionType)
}
ช่อง
deletionType

enum (DeletionType)

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

DeletionType

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

Enum
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)

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

QuoteType

ประเภทการอ้างอิงของข้อความที่ยกมา

Enum
QUOTE_TYPE_UNSPECIFIED Reserved. ค่านี้ไม่ได้ใช้
REPLY

เมื่อ quoteType เป็น REPLY คุณจะทำสิ่งต่อไปนี้ได้

  • หากตอบกลับในชุดข้อความ คุณจะยกข้อความอื่นในชุดข้อความนั้นมาได้

  • หากกำลังสร้างข้อความหลัก คุณจะยกข้อความหลักอีกข้อความหนึ่งในพื้นที่ทำงานนั้นได้
FORWARD

เมื่อ quoteType เป็น FORWARD คุณจะเสนอราคาได้ดังนี้

  • ข้อความจากพื้นที่ทำงานอื่น

  • การตอบกลับข้อความจากชุดข้อความอื่นในพื้นที่ทำงานเดียวกัน

QuotedMessageSnapshot

แสดงภาพรวมของเนื้อหาในข้อความที่ยกมา ณ เวลาที่ยกมาหรือส่งต่อ

การแสดง JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
ช่อง
sender

string

เอาต์พุตเท่านั้น ชื่อผู้เขียนข้อความที่ยกมา ป้อนข้อมูลสำหรับประเภทการอ้างอิงทั้ง REPLY และ FORWARD
text

string

เอาต์พุตเท่านั้น ภาพรวมของเนื้อหาข้อความที่ยกมา
formattedText

string

เอาต์พุตเท่านั้น มีข้อความที่ยกมา text พร้อมมาร์กอัปที่เพิ่มเพื่อรองรับการจัดรูปแบบที่หลากหลาย เช่น ไฮเปอร์ลิงก์ อีโมจิที่กำหนดเอง มาร์กอัป ฯลฯ โดยจะป้อนข้อมูลสำหรับประเภทการยกคำพูดแบบ FORWARD เท่านั้น
annotations[]

object (Annotation)

เอาต์พุตเท่านั้น คำอธิบายประกอบที่แยกวิเคราะห์จากเนื้อหาข้อความของข้อความที่ยกมา ป้อนข้อมูลสําหรับประเภทการเสนอราคาแบบ FORWARD เท่านั้น
attachments[]

object (Attachment)

เอาต์พุตเท่านั้น ไฟล์แนบที่เป็นส่วนหนึ่งของข้อความที่ยกมา ซึ่งเป็นสำเนาข้อมูลเมตาของไฟล์แนบของข้อความที่ยกมา ป้อนข้อมูลสําหรับประเภทการเสนอราคาแบบ FORWARD เท่านั้น

ForwardedMetadata

ข้อมูลเมตาเกี่ยวกับพื้นที่ทำงานต้นทางที่มีการส่งต่อข้อความ

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

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของพื้นที่ทำงานต้นทาง รูปแบบ: spaces/{space}
spaceDisplayName

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของพื้นที่ทำงานหรือ DM ต้นทาง ณ เวลาที่ส่งต่อ สำหรับ SPACE นี่คือชื่อพื้นที่ทำงาน สำหรับ DIRECT_MESSAGE นี่คือชื่อของผู้เข้าร่วมคนอื่น (เช่น "ผู้ใช้ ก") สำหรับ GROUP_CHAT นี่คือชื่อที่สร้างขึ้นโดยอิงตามชื่อจริงของสมาชิก โดยจำกัดไว้ที่ 5 ชื่อรวมถึงครีเอเตอร์ (เช่น "ผู้ใช้ ก, ผู้ใช้ ข")

AttachedGif

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

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

string

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

AccessoryWidget

วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการที่ปรากฏที่ด้านล่างของข้อความ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ

การแสดง JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
ช่อง
ประเภทการดำเนินการ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
buttonList

object (ButtonList)

รายการปุ่ม
สิ้นสุดฟิลด์ที่แยกกัน

องค์ประกอบ

องค์ประกอบคือคอมโพเนนต์เพิ่มเติมที่อาจเชื่อมโยงหรือไม่เชื่อมโยงกับข้อความที่ระบุระหว่างการสร้างข้อความ

การแสดง JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
ช่อง
citedSources[]

object (CitedSource)

รายการแหล่งข้อมูลที่จะแสดงใต้ข้อความเป็นลิงก์ส่วนท้าย โดยจะไม่มีการอ้างอิงในบรรทัด สำหรับการอ้างอิงในบรรทัด ให้ใช้ citations
citations[]

object (Citation)

รายการการอ้างอิงในบรรทัดที่อ้างอิงภายในข้อความ (ผ่านแท็ก <chat-citation>) ซึ่งแสดงผลเป็นการ์ดข้อมูลย่อแบบอินเทอร์แอกทีฟ

CitedSource

การอ้างอิงแหล่งข้อมูล

การแสดง JSON 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
ช่อง
title

string

ต้องระบุ ชื่อข้อความธรรมดาของ CitedSource ช่องนี้ไม่รองรับการจัดรูปแบบ
uri

string

ต้องระบุ URI ที่ชี้ไปยังทรัพยากรที่อ้างอิงโดย CitedSource นี้
snippet

object (Snippet)

ไม่บังคับ ตัวอย่างข้อมูลที่มีข้อมูลส่งตรงจากแหล่งที่มา
footer

object (Footer)

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

ตัวอย่างข้อมูล

ออบเจ็กต์ตัวอย่างข้อมูลที่แสดงข้อความที่ตัดตอนมาจากคลังข้อมูลขนาดใหญ่

การแสดง JSON 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
ฟิลด์
text

string

ไม่บังคับ ข้อความที่ตัดตอนมาสั้นๆ แบบข้อความธรรมดาจากคลังข้อมูลที่อาจแสดงผลใน Chat ไม่รองรับรูปแบบมาร์กดาวน์
imagePreview

object (ElementsImage)

ไม่บังคับ ตัวอย่างรูปภาพของตัวอย่างข้อมูลที่ระบุเป็นอินพุตเมื่อสร้างการอ้างอิง

ElementsImage

ออบเจ็กต์ที่รวมวิธีต่างๆ ในการแสดงรูปภาพ การนำเสนอที่รองรับในปัจจุบัน: - รูปภาพที่ดึงมาจาก URI เราอาจรองรับการนำเสนอเพิ่มเติมในอนาคต

การแสดง JSON 
{

  "imageUri": string
}
ช่อง
ต้องระบุ การแสดงรูปภาพที่รองรับรายการใดรายการหนึ่ง ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
imageUri

string

ต้องระบุ URI ที่เข้าถึงได้แบบสาธารณะสำหรับรูปภาพ
สิ้นสุดฟิลด์ที่แยกกัน

ส่วนท้ายของแหล่งที่มา ซึ่งใช้สำหรับการระบุแหล่งที่มา

การแสดง JSON 
{
  "text": string
}
ฟิลด์
text

string

ไม่บังคับ ข้อความที่จะแสดงในส่วนท้าย

การอ้างอิง

การอ้างอิงคือการอ้างอิงในบรรทัดที่ให้ข้อมูลโดยละเอียดเพิ่มเติมแก่ผู้ใช้เกี่ยวกับการอ้างอิงในบรรทัด การอ้างอิงในบรรทัดที่เกี่ยวข้องควรปรากฏในข้อความในรูปแบบมาร์กอัป <chat-citation data-id="{id}">{text}</chat-citation> ระบบจะรองรับการอ้างอิงเมื่อตั้งค่า markupSyntax ของข้อความเป็น MARKDOWN เท่านั้น

ระบบจะไม่สนใจการอ้างอิงที่ไม่มีการอ้างถึงใน Elements.citations (การอ้างอิงที่ไม่มีแท็ก <chat-citation> ที่ตรงกันในข้อความ) และจะไม่ทำให้ข้อความถูกปฏิเสธ

การแสดง JSON 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
ช่อง
id

string

ต้องระบุ รหัสที่แอปกำหนด ต้องมีเฉพาะตัวอักษรและตัวเลข ASCII และมีความยาวน้อยกว่า 63 อักขระ
citedSources[]

object (CitedSource)

ไม่บังคับ รายการแหล่งข้อมูลที่เกี่ยวข้องกับการอ้างอิง แหล่งที่มาจะแสดงในการ์ดข้อมูลย่อของการอ้างอิง

MarkupSyntax

ระบุไวยากรณ์มาร์กอัปที่ใช้จัดรูปแบบข้อความแชท ใช้กับฟิลด์ text ของทรัพยากร Message

Enum
MARKUP_SYNTAX_UNSPECIFIED แสดงค่าที่ไม่ได้ระบุ
MARKUP_SYNTAX_CHAT ใช้ไวยากรณ์มาร์กอัปของ Google Chat ดูข้อมูลเพิ่มเติมได้ที่ https://developers.google.com/workspace/chat/format-messages#format-texts
MARKUP_SYNTAX_MARKDOWN ใช้ไวยากรณ์มาร์กดาวน์ ไวยากรณ์นี้อิงตามข้อกำหนด CommonMark โดยมีส่วนขยายเพิ่มเติม ดูข้อมูลเพิ่มเติมได้ที่ https://developers.google.com/workspace/chat/format-messages#format-texts

เมธอด

create

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

delete

 ลบข้อความ

get

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

list

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

patch

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

replaceCards

 แทนที่การ์ดที่รวมอยู่ในข้อความ
ค้นหาข้อความใน Google Chat ที่ผู้ใช้ที่โทรมีสิทธิ์เข้าถึง

update

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