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