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 รายการ

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

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

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด
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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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