Method: projects.databases.documents.list

문서를 나열합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. 상위 리소스 이름입니다. 형식은 projects/{projectId}/databases/{databaseId}/documents 또는 projects/{projectId}/databases/{databaseId}/documents/{document_path}입니다.

예를 들어 projects/my-project/databases/my-database/documents 또는 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom입니다.
collectionId

string

선택사항입니다. 나열할 parent 기준 컬렉션 ID입니다.

예를 들면 chatrooms 또는 messages입니다.

이는 선택사항이며 제공하지 않으면 Firestore는 모든 컬렉션의 문서를 제공된 parent에 나열합니다.

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 단일 응답으로 반환할 최대 문서 수입니다.

Firestore가 이 값보다 적게 반환할 수 있습니다.
pageToken

string

선택사항입니다. 이전 documents.list 응답에서 수신된 페이지 토큰입니다.

후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나눌 때 다른 모든 매개변수 (pageSize 제외)는 페이지 토큰을 생성한 요청에 설정된 값과 일치해야 합니다.
orderBy

string

선택사항입니다. 반환할 문서의 순서(선택사항)입니다.

예를 들면 priority desc, __name__ desc입니다.

Firestore 쿼리에서 사용되는 ORDER BY를 반영하지만 문자열 표현으로 반영합니다. 없는 경우 문서는 __name__ ASC을 기준으로 정렬됩니다.
mask

object (DocumentMask)

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

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

boolean

목록에 누락된 문서가 표시되는지 여부

존재하지 않는 문서는 누락되지만 아래에 중첩된 하위 문서가 있는 경우입니다. true인 경우 이러한 누락된 문서가 키와 함께 반환되지만 필드, createTime 또는 updateTime는 설정되지 않습니다.

showMissing가 포함된 요청은 where 또는 orderBy를 지정할 수 없습니다.
통합 매개변수 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"입니다.

요청 본문

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

응답 본문

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

승인 범위

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

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

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