Method: projects.databases.documents.patch

문서를 업데이트하거나 삽입합니다.

HTTP 요청

PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
document.name

string

문서의 리소스 이름입니다(예: projects/{projectId}/databases/{databaseId}/documents/{document_path}).

쿼리 매개변수

매개변수
updateMask

object (DocumentMask)

업데이트할 필드입니다. 마스크의 필드 경로에는 예약된 이름이 포함될 수 없습니다.

문서가 서버에 있고 마스크에서 참조되지 않는 필드가 있는 경우 해당 필드는 변경되지 않습니다. 마스크에서 참조되지만 입력 문서에는 없는 필드는 서버의 문서에서 삭제됩니다.
mask

object (DocumentMask)

반환할 필드입니다. 설정하지 않으면 모든 필드를 반환합니다.

문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답에서 반환되지 않습니다.
currentDocument

object (Precondition)

문서의 전제조건(선택사항)입니다. 이 속성이 설정되어 있지만 대상 문서에서 충족되지 않으면 요청이 실패합니다.

요청 본문

요청 본문에는 Document의 인스턴스가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 Document의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 인증 개요를 참조하세요.