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 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ

ค่าลบแสดงผลข้อผิดพลาด 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

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