Method: spaces.messages.list

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

คำขอ 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

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