Method: projects.databases.documents.createDocument

یک سند جدید ایجاد می کند.

درخواست HTTP

POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/**}/{collectionId}

URL از دستور GRPC Transcoding استفاده می کند.

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

مولفه های
parent

string

ضروری. منبع والد برای مثال: projects/{projectId}/databases/{databaseId}/documents or projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}

collectionId

string

ضروری. شناسه مجموعه، نسبت به parent ، به فهرست. به عنوان مثال: chatrooms .

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

مولفه های
documentId

string

شناسه سند اختصاص داده شده توسط مشتری برای استفاده برای این سند.

اختیاری. اگر مشخص نشده باشد، یک شناسه توسط سرویس تخصیص داده می شود.

mask

object ( DocumentMask )

زمینه هایی برای بازگشت. اگر تنظیم نشود، همه فیلدها را برمی گرداند.

اگر سند دارای فیلدی باشد که در این ماسک وجود ندارد، آن فیلد در پاسخ بازگردانده نمی شود.

درخواست بدن

بدنه درخواست حاوی نمونه‌ای از Document است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Document است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

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