このページは Cloud Translation API によって翻訳されました。
Switch to English

メソッド:projects.databases.documents.list

ドキュメントをリストします。

HTTPリクエスト

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

URLはgRPCトランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

必須。親リソース名。形式: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path} 。例: projects/my-project/databases/my-database/documentsまたはprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom

collectionId

string

必須。リストするコレクションID( parentからの相対)。例: chatroomsまたはmessages

クエリパラメータ

パラメーター
pageSize

integer

返されるドキュメントの最大数。

pageToken

string

以前のListリクエストから返されたnextPageToken値(ある場合)。

orderBy

string

結果を並べ替える順序。例: priority desc, name

mask

object ( DocumentMask )

返すフィールド。設定されていない場合、すべてのフィールドを返します。

ドキュメントにこのマスクに存在しないフィールドがある場合、そのフィールドは応答で返されません。

showMissing

boolean

リストに不足しているドキュメントが表示される場合。不足しているドキュメントは、存在しないがサブドキュメントがあるドキュメントです。これらのドキュメントはキーとともに返されますが、フィールド、 Document.create_time 、またはDocument.update_timeセットはありません。

showMissingリクエストでは、 whereまたはorderBy指定できません。

ユニオンパラメータconsistency_selector 。このトランザクションの整合性モード。設定されていない場合、デフォルトは強い整合性です。 consistency_selectorは、次のいずれかになります。
transaction

string ( bytes format)

トランザクションでドキュメントを読み取ります。

base64でエンコードされた文字列。

readTime

string ( Timestamp format)

ドキュメントを指定された時間に読み取ります。これは270秒より古いものではありません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大9の小数桁。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

リクエストボディ

リクエストの本文は空である必要があります。

レスポンスボディ

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

Firestore.ListDocumentsに対する応答。

JSON表現
 {
  "documents" :  [
    {
      object ( Document )
    }
  ] ,
  "nextPageToken" :  string
} 
田畑
documents[]

object ( Document )

見つかったドキュメント。

nextPageToken

string

次のページのトークン。

認可スコープ

次のOAuthスコープのいずれかが必要です。

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

詳細については、 認証の概要を参照してください。