이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Method: projects.databases.documents.batchGet

여러 문서를 가져옵니다.

이 메서드에서 반환된 문서는 요청한 순서대로 반환되지 않을 수 있습니다.

HTTP 요청

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

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

경로 매개변수

매개변수

매개변수
`database`	`string` 필수 항목입니다. 데이터베이스 이름입니다. 형식은 `projects/{projectId}/databases/{databaseId}`입니다.

database

string

필수 항목입니다. 데이터베이스 이름입니다. 형식은 projects/{projectId}/databases/{databaseId}입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현

JSON 표현
{ "documents": [ string ], "mask": { object (`DocumentMask`) }, // Union field `consistency_selector` can be only one of the following: "transaction": string, "newTransaction": { object (`TransactionOptions`) }, "readTime": string // End of list of possible types for union field `consistency_selector`. }

{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}

필드
`documents[]`	`string` 검색할 문서의 이름입니다. 형식은 `projects/{projectId}/databases/{databaseId}/documents/{document_path}`입니다. 문서가 지정된 `database`의 하위 리소스가 아닌 경우 요청이 실패합니다. 중복된 이름은 생략됩니다.
`mask`	`object (DocumentMask)` 반환할 필드입니다. 설정하지 않으면 모든 필드가 반환됩니다. 문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답으로 반환되지 않습니다.
통합 필드 `consistency_selector`. 이 트랜잭션의 일관성 모드입니다. 설정하지 않으면 기본값은 strong consistency입니다. `consistency_selector`은 다음 중 하나여야 합니다.
`transaction`	`string (bytes format)` 트랜잭션의 문서를 읽습니다. base64 인코딩 문자열입니다.
`newTransaction`	`object (TransactionOptions)` 새 트랜잭션을 시작하고 문서를 읽습니다. 기본값은 읽기 전용 트랜잭션입니다. 새 트랜잭션 ID가 스트림의 첫 번째 응답으로 반환됩니다.
`readTime`	`string (Timestamp format)` 지정된 시점의 문서를 읽습니다. 지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 1분짜리 타임스탬프일 수도 있습니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 `"2014-10-02T15:01:23Z"` 및 `"2014-10-02T15:01:23.045123456Z"`입니다.

응답 본문

Firestore.BatchGetDocuments의 스트리밍된 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현

JSON 표현
{ "transaction": string, "readTime": string, // Union field `result` can be only one of the following: "found": { object (`Document`) }, "missing": string // End of list of possible types for union field `result`. }

{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}

필드
`transaction`	`string (bytes format)` 이 요청의 일부로 시작된 트랜잭션입니다. 요청에서 `BatchGetDocumentsRequest.new_transaction`가 설정된 경우에만 첫 번째 응답에서만 설정됩니다. base64 인코딩 문자열입니다.
`readTime`	`string (Timestamp format)` 문서를 읽은 시간입니다. 이는 단조 증가할 수 있습니다. 이 경우 결과 스트림의 이전 문서가 readTime과 이 문서 간에 변경되지 않은 것이 보장됩니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 `"2014-10-02T15:01:23Z"` 및 `"2014-10-02T15:01:23.045123456Z"`입니다.
통합 필드 `result`. 단일 결과입니다. 서버가 단순히 트랜잭션을 반환하는 경우에는 이 필드가 비어 있을 수 있습니다. `result`은 다음 중 하나여야 합니다.
`found`	`object (Document)` 요청된 문서입니다.
`missing`	`string` 요청했지만 존재하지 않는 문서 이름입니다. 형식은 `projects/{projectId}/databases/{databaseId}/documents/{document_path}`입니다.

승인 범위

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

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

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