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)

เมื่อระบุ ระบบจะแสดงเฉพาะฟิลด์บางรายการที่เป็นของมุมมองที่ระบุ

พารามิเตอร์ Union 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

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