Method: users.labels.list

แสดงป้ายกำกับทั้งหมดในกล่องจดหมายของผู้ใช้

คำขอ HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/labels

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

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

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

string

อีเมลของผู้ใช้ ค่าพิเศษ me สามารถใช้เพื่อระบุผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

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

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

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

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

การแสดง JSON
{
  "labels": [
    {
      object (Label)
    }
  ]
}
ช่อง
labels[]

object (Label)

รายการป้ายกำกับ โปรดทราบว่าทรัพยากรป้ายกำกับแต่ละรายการจะมีเฉพาะ id, name, messageListVisibility, labelListVisibility และ type เมธอด labels.get จะดึงข้อมูลรายละเอียดป้ายกำกับเพิ่มเติมได้

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

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.labels
  • https://www.googleapis.com/auth/gmail.metadata

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