Method: spaces.messages.list

แสดงรายการข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก รวมถึงข้อความจากสมาชิกและพื้นที่ทำงานที่ถูกบล็อก หากคุณแสดงข้อความจากพื้นที่ทำงานที่ไม่มีข้อความ การตอบกลับจะเป็นออบเจ็กต์ที่ว่างเปล่า เมื่อใช้อินเทอร์เฟซ REST/HTTP การตอบกลับจะมีออบเจ็กต์ JSON ว่าง {} ดูตัวอย่างได้ที่แสดงรายการข้อความ

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

คำขอ HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะแสดงรายการข้อความ

รูปแบบ: spaces/{space}

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

ไม่บังคับ จำนวนข้อความสูงสุดที่แสดง บริการอาจแสดงผลข้อความน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลสูงสุด 25 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ

ค่าลบจะแสดงผลข้อผิดพลาด INVALID_ARGUMENT
pageToken

string

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

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้าเว็บ การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองข้อความค้นหา

คุณสามารถกรองข้อความตามวันที่ (createTime) และชุดข้อความ (thread.name)

หากต้องการกรองข้อความตามวันที่สร้าง ให้ระบุ createTime พร้อมการประทับเวลาในรูปแบบ RFC-3339 และเครื่องหมายคำพูดแบบปิด เช่น "2023-04-21T11:30:00-04:00" คุณสามารถใช้โอเปอเรเตอร์ "มากกว่า" > เพื่อแสดงรายการข้อความที่สร้างหลังการประทับเวลา หรือโอเปอเรเตอร์ "น้อยกว่า" < เพื่อแสดงรายการข้อความที่สร้างก่อนการประทับเวลา หากต้องการกรองข้อความภายในช่วงเวลา ให้ใช้โอเปอเรเตอร์ AND ระหว่างการประทับเวลา 2 รายการ

หากต้องการกรองตามชุดข้อความ ให้ระบุ thread.name ที่มีการจัดรูปแบบเป็น spaces/{space}/threads/{thread} คุณระบุ thread.name ได้แค่ 1 รายการต่อคำค้นหา

หากต้องการกรองตามทั้งชุดข้อความและวันที่ ให้ใช้โอเปอเรเตอร์ AND ในการค้นหา

ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด INVALID_ARGUMENT
orderBy

string

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

  • ASC สำหรับ "จากน้อยไปมาก"

  • DESC สำหรับจากมากไปน้อย

การเรียงลำดับเริ่มต้นคือ createTime ASC
showDeleted

boolean

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

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับข้อความข้อมูล

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
ช่อง
messages[]

object (Message)

รายการข้อความ
nextPageToken

string

คุณสามารถส่งโทเค็นในฐานะ pageToken เพื่อเรียกผลลัพธ์หน้าถัดไป หากเว้นว่างไว้ แสดงว่าไม่มีหน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์