Method: projects.databases.documents.listCollectionIds

Перечисляет все идентификаторы коллекций под документом.

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 . Режим согласованности для этого запроса. Если не установлено, по умолчанию используется строгая согласованность. consistency_selector может быть только одним из следующих:
readTime

string ( Timestamp format)

Читает документы в том виде, в каком они были на данный момент.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Тело ответа

Ответ от Firestore.ListCollectionIds .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
Поля
collectionIds[]

string

Идентификаторы коллекции.

nextPageToken

string

Токен страницы, который можно использовать для продолжения списка.

Области авторизации

Требуется одна из следующих областей OAuth:

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

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