Method: projects.databases.collectionGroups.fields.list

แสดงรายการการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้

ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายชื่อที่มีการลบล้างอย่างชัดแจ้ง หากต้องการดำเนินการค้นหานี้ โปรดโทร FirestoreAdmin.ListFields ซึ่งตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false หรือ ttlConfig:*

คำขอ HTTP

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

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

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

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

string

ต้องระบุ ชื่อระดับบนสุดของแบบฟอร์ม projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

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

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

string

ตัวกรองที่จะใช้กับรายการผลลัพธ์ ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายชื่อที่มีการลบล้างอย่างชัดแจ้ง หากต้องการดำเนินการค้นหานี้ ให้เรียก FirestoreAdmin.ListFields พร้อมตัวกรองที่รวม indexConfig.usesAncestorConfig:false หรือ ttlConfig:*
pageSize

integer

จำนวนผลลัพธ์ที่จะแสดงผล
pageToken

string

โทเค็นหน้าเว็บที่ส่งคืนจากการเรียกไปยัง FirestoreAdmin.ListFields ครั้งก่อน ซึ่งอาจใช้เพื่อรับผลลัพธ์หน้าถัดไป

เนื้อความของคำขอ

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

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

การตอบกลับสำหรับ FirestoreAdmin.ListFields

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

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

object (Field)

ฟิลด์ที่ขอ
nextPageToken

string

โทเค็นหน้าเว็บที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย

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

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

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

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