Method: projects.databases.collectionGroups.fields.patch

מעדכן הגדרות של שדה. בשלב הזה, העדכונים בשדות חלים רק על הגדרה של אינדקס של שדה אחד. עם זאת, שיחות אל FirestoreAdmin.UpdateField צריכות לספק אנונימיזציה של שדות כדי למנוע שינוי של הגדרות אישיות שהמתקשר לא מודע להן. אנונימיזציה של השדות צריכה להיות מוגדרת כ: { paths: "indexConfig" }.

הקריאה הזו מחזירה google.longrunning.Operation שעשוי לשמש למעקב אחר הסטטוס של עדכון השדה. המטא-נתונים של הפעולה יהיו מסוג FieldOperationMetadata.

כדי לקבוע את הגדרות ברירת המחדל של השדות עבור מסד הנתונים, יש להשתמש במשתנה Field המיוחד עם שם המשאב: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

בקשת HTTP

PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
field.name

string

שם שדה בטופס projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

נתיב של שדה יכול להיות שם של שדה פשוט, למשל address או נתיב לשדות בתוך mapValue , כמו address.city, או נתיב של שדה מיוחד. השדה המיוחד החוקי היחיד הוא *, שמייצג כל שדה.

אפשר לצטט נתיבי שדות באמצעות (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` וכן באמצעות תווי ASCII.

דוגמאות: (הערה: התגובות כאן נכתבות בתחביר של סימני קריאה, כך שיש שכבה נוספת של סימני הטעמה שמייצגים בלוק קוד) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, ולא אף שדה.

Field מיוחד מכיל את הגדרות ברירת המחדל להוספה לאינדקס עבור כל השדות. שם המשאב בשדה הזה הוא: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* האינדקסים שהוגדרו ב-Field הזה יוחלו על כל השדות שאין להם תצורה משלהם של Field של אינדקס.

פרמטרים של שאילתה

פרמטרים
updateMask

string (FieldMask format)

מסכה, ביחס לשדה. אם צוין, רק התצורה שצוינה על ידי field_mask תהיה שמעודכנת בשדה.

זוהי רשימה מופרדת בפסיקים של שמות מלאים של שדות. דוגמה: "user.displayName,photo"

גוף הבקשה

גוף הבקשה מכיל מופע של Field.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Operation.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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