Method: labels.list

แสดงรายการป้ายกำกับ

คำขอ HTTP

GET https://drivelabels.googleapis.com/v2/labels

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

พารามิเตอร์การค้นหา

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

boolean

รวมเฉพาะป้ายกำกับที่เผยแพร่แล้วในผลลัพธ์หรือไม่

  • เมื่อ true ระบบจะแสดงผลเฉพาะการแก้ไขป้ายกำกับที่เผยแพร่ในปัจจุบันเท่านั้น มีป้ายกำกับที่ปิดใช้ด้วย ชื่อทรัพยากรป้ายกำกับที่แสดงผลอ้างอิงการแก้ไขที่เผยแพร่ (labels/{id}/{revisionId})
  • เมื่อ false ระบบจะแสดงผลการแก้ไขป้ายกำกับปัจจุบัน ซึ่งอาจยังไม่ได้เผยแพร่ ชื่อทรัพยากรป้ายกำกับที่แสดงไม่ได้อ้างอิงถึงการแก้ไขที่เฉพาะเจาะจง (labels/{id})
customer

string

ลูกค้าที่กำหนดขอบเขตจะส่งคำขอรายการนี้ เช่น "customers/abcd1234" หากไม่ได้ตั้งค่า จะแสดงป้ายกำกับทั้งหมดภายในลูกค้าปัจจุบัน

languageCode

string

รหัสภาษา BCP-47 ที่จะใช้ในการประเมินป้ายกำกับฟิลด์ที่มีการแปลภาษา เมื่อไม่ได้ระบุ ระบบจะใช้ค่าในภาษาที่กำหนดค่าไว้เริ่มต้น

pageSize

integer

จำนวนป้ายกำกับสูงสุดที่จะแสดงต่อหน้าเว็บ ค่าเริ่มต้น: 50 สูงสุด: 200

pageToken

string

โทเค็นของหน้าที่จะแสดงผล

view

enum (LabelView)

เมื่อระบุ ระบบจะแสดงฟิลด์ที่เป็นของข้อมูลพร็อพเพอร์ตี้ที่ระบุเท่านั้น

พารามิเตอร์การรวม access

access ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

useAdminAccess

boolean

ตั้งค่าเป็น true เพื่อใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบของผู้ใช้ การดำเนินการนี้จะแสดงป้ายกำกับทั้งหมดภายในลูกค้า

minimumRole

enum (LabelRole)

ระบุระดับการเข้าถึงที่ผู้ใช้ต้องมีในป้ายกำกับที่แสดงผล บทบาทขั้นต่ำที่ผู้ใช้ต้องมีในป้ายกำกับ ค่าเริ่มต้นคือ READER

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

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

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

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

การตอบกลับสำหรับป้ายกำกับรายชื่อ

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

object (Label)

ป้ายกำกับ

nextPageToken

string

โทเค็นของหน้าถัดไปในคำตอบ

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

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

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

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