Method: projects.databases.documents.get

단일 문서를 가져옵니다.

HTTP 요청

GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}

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

경로 매개변수

매개변수
name

string

필수 항목입니다. 가져올 문서의 리소스 이름입니다. 형식은 projects/{projectId}/databases/{databaseId}/documents/{document_path}입니다.

쿼리 매개변수

매개변수
mask

object (DocumentMask)

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

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

통합 매개변수 consistency_selector입니다. 이 트랜잭션의 일관성 모드입니다. 설정하지 않으면 strong consistency가 기본값입니다. consistency_selector은 다음 중 하나여야 합니다.
transaction

string (bytes format)

트랜잭션에서 문서를 읽습니다.

base64 인코딩 문자열입니다.

readTime

string (Timestamp format)

지정된 시간의 문서 버전을 읽습니다.

지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 분 전체 타임스탬프가 될 수도 있습니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

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

승인 범위

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

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

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