Method: projects.databases.collectionGroups.fields.list

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

ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายการที่ถูกลบล้างอย่างชัดเจนเท่านั้น หากต้องการออกการค้นหานี้ โปรดเรียกใช้ FirestoreAdmin.ListFields พร้อมตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false

คำขอ HTTP

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

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

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

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

string

ชื่อหลักของแบบฟอร์ม projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

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

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

string

ตัวกรองที่จะนำไปใช้กับผลการค้นหา ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายการที่ถูกลบล้างอย่างชัดเจนเท่านั้น หากต้องการออกการค้นหานี้ โปรดเรียกใช้ FirestoreAdmin.ListFields พร้อมตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false
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

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