Method: projects.databases.documents.listDocuments

Перечисляет документы.

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 для вывода в список.

Например: chatrooms или messages .

Это необязательно, и если оно не указано, Firestore будет отображать документы из всех коллекций, принадлежащих указанному parent .

Параметры запроса

Параметры
pageSize

integer

Необязательный. Максимальное количество документов, возвращаемых в одном ответе.

Firestore может возвращать меньшее значение, чем это значение.

pageToken

string

Необязательный. Токен страницы, полученный из предыдущего ответа documents.list .

Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы все остальные параметры (за исключением pageSize ) должны соответствовать значениям, установленным в запросе, который сгенерировал токен страницы.

orderBy

string

Необязательный. Факультативный заказ документов для возврата.

Например: priority desc, __name__ desc .

Это отражает ORDER BY , используемый в запросах Firestore, но в строковом представлении. Если он отсутствует, документы упорядочиваются на основе __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)

Выполняйте чтение в отведенное время.

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "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

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