Method: projects.databases.collectionGroups.fields.list

Перечисляет конфигурацию полей и метаданные для этой базы данных.

В настоящее время FirestoreAdmin.ListFields поддерживает только те поля списка, которые были явно переопределены. Чтобы выполнить этот запрос, вызовите FirestoreAdmin.ListFields с фильтром, установленным на indexConfig.usesAncestorConfig:false или ttlConfig:* .

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 поддерживает только те поля списка, которые были явно переопределены. Чтобы выполнить этот запрос, вызовите FirestoreAdmin.ListFields с фильтром, который включает indexConfig.usesAncestorConfig:false или ttlConfig:* .

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

Для получения дополнительной информации см. Обзор аутентификации .