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 Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های

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 named address.city است , not the map key in the field . "*" 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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.