Method: spaces.messages.list

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์ gRPC Transcoding

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

พารามิเตอร์
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

สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์