Method: projects.databases.collectionGroups.fields.patch

필드 구성을 업데이트합니다. 현재 필드 업데이트는 단일 필드 색인 구성에만 적용됩니다. 그러나 FirestoreAdmin.UpdateField 호출은 호출자가 인식하지 못하는 구성이 변경되지 않도록 필드 마스크를 제공해야 합니다. 필드 마스크는 { paths: "indexConfig" }로 지정해야 합니다.

이 호출은 필드 업데이트의 상태를 추적하는 데 사용할 수 있는 google.longrunning.Operation를 반환합니다. 작업의 메타데이터는 FieldOperationMetadata 유형입니다.

데이터베이스의 기본 필드 설정을 구성하려면 리소스 이름이 projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*인 특수한 Field를 사용합니다.

HTTP 요청

PATCH https://firestore.googleapis.com/v1/{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

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