Method: projects.databases.documents.list

문서를 나열합니다.

HTTP 요청

GET https://firestore.googleapis.com/v1beta1/{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 . 이 트랜잭션의 일관성 모드입니다. 설정하지 않으면 기본적으로 강력한 일관성이 사용됩니다. consistency_selector 다음 중 하나만 될 수 있습니다.
transaction

string ( bytes format)

이미 활성화된 트랜잭션의 일부로 읽기를 수행합니다.

base64로 인코딩된 문자열입니다.

readTime

string ( Timestamp format)

제공된 시간에 읽기를 수행합니다.

이는 지난 1시간 이내의 마이크로초 단위 타임스탬프여야 하며, 특정 시점 복구가 활성화된 경우 추가로 지난 7일 이내의 1분 타임스탬프일 수도 있습니다.

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

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