Method: projects.databases.collectionGroups.fields.list

이 데이터베이스의 필드 구성과 메타데이터를 나열합니다.

현재 FirestoreAdmin.ListFields는 명시적으로 재정의된 필드 나열만 지원합니다. 이 쿼리를 실행하려면 필터를 indexConfig.usesAncestorConfig:false 또는 ttlConfig:*로 설정하여 FirestoreAdmin.ListFields를 호출합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId} 양식의 상위 이름

쿼리 매개변수

매개변수
filter

string

목록 결과에 적용할 필터입니다. 현재 FirestoreAdmin.ListFields는 명시적으로 재정의된 필드 나열만 지원합니다. 이 쿼리를 실행하려면 indexConfig.usesAncestorConfig:false 또는 ttlConfig:*가 포함된 필터로 FirestoreAdmin.ListFields를 호출합니다.
pageSize

integer

반환할 결과 수입니다.
pageToken

string

이전 FirestoreAdmin.ListFields 호출에서 반환된 페이지 토큰으로, 결과의 다음 페이지를 가져오는 데 사용할 수 있습니다.

요청 본문

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

응답 본문

FirestoreAdmin.ListFields의 응답입니다.

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

JSON 표현 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
필드
fields[]

object (Field)

요청된 필드입니다.
nextPageToken

string

다른 결과 페이지를 요청하는 데 사용할 수 있는 페이지 토큰입니다. 비워 두면 마지막 페이지가 됩니다.

승인 범위

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

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

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