문서를 나열합니다.
HTTP 요청
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}/{collectionId}
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
parent |
필수 항목입니다. 상위 리소스 이름입니다. 형식은 예를 들어 |
collectionId |
선택사항입니다. 나열할 예를 들면 이는 선택사항이며 제공하지 않으면 Firestore는 모든 컬렉션의 문서를 제공된 |
쿼리 매개변수
매개변수 | |
---|---|
pageSize |
선택사항입니다. 단일 응답으로 반환할 최대 문서 수입니다. Firestore가 이 값보다 적게 반환할 수 있습니다. |
pageToken |
선택사항입니다. 이전 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나눌 때 다른 모든 매개변수 ( |
orderBy |
선택사항입니다. 반환할 문서의 순서(선택사항)입니다. 예를 들면 Firestore 쿼리에서 사용되는 |
mask |
선택사항입니다. 반환할 필드입니다. 설정하지 않으면 모든 필드를 반환합니다. 문서에 이 마스크에 없는 필드가 있으면 해당 필드는 응답에서 반환되지 않습니다. |
showMissing |
목록에 누락된 문서가 표시되는지 여부 존재하지 않는 문서는 누락되지만 아래에 중첩된 하위 문서가 있는 경우입니다. true인 경우 이러한 누락된 문서가 키와 함께 반환되지만 필드,
|
통합 매개변수 consistency_selector 입니다. 이 트랜잭션의 일관성 모드입니다. 설정하지 않으면 strong consistency가 기본값입니다. consistency_selector 은 다음 중 하나여야 합니다. |
|
transaction |
이미 활성 트랜잭션의 일부로 읽기를 수행합니다. base64 인코딩 문자열입니다. |
readTime |
제공된 시간에 읽기를 실행합니다. 지난 1시간 이내의 마이크로초 정밀도 타임스탬프여야 합니다. 또는 PITR(point-in-time recovery)이 사용 설정된 경우 지난 7일 이내의 분 전체 타임스탬프가 될 수도 있습니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공한 경우 응답 본문에 ListDocumentsResponse
의 인스턴스가 포함됩니다.
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
자세한 내용은 인증 개요를 참조하세요.