Method: projects.databases.documents.listCollectionIds

문서 아래에 모든 컬렉션 ID를 나열합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. 상위 문서입니다. 형식은 projects/{projectId}/databases/{databaseId}/documents/{document_path}입니다. 예를 들면 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom입니다.

요청 본문

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

JSON 표현 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
필드
pageSize

integer

반환할 최대 결과 수입니다.
pageToken

string

페이지 토큰입니다. ListCollectionIdsResponse의 값이어야 합니다.
통합 필드 consistency_selector. 이 요청의 일관성 모드입니다. 설정하지 않으면 기본값은 strong consistency입니다. consistency_selector은 다음 중 하나여야 합니다.
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.ListCollectionIds의 응답

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

JSON 표현 
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
필드
collectionIds[]

string

컬렉션 ID입니다.
nextPageToken

string

목록을 계속 이어지는 데 사용할 수 있는 페이지 토큰입니다.

승인 범위

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

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

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