Method: projects.databases.collectionGroups.fields.list

פירוט ההגדרות והמטא-נתונים של השדות למסד הנתונים הזה.

בשלב זה, FirestoreAdmin.ListFields תומך רק בשדות של כרטיסי מוצר שבוטלו באופן מפורש. כדי ליצור את השאילתה הזו, צריך לקרוא לפונקציה FirestoreAdmin.ListFields ולהגדיר את המסנן indexConfig.usesAncestorConfig:false orttlConfig:*`.

בקשת 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 .
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

מידע נוסף זמין בסקירה הכללית על אימות.