Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

REST Resource: projects.databases.documents

リソース:ドキュメント

Firestoreドキュメント。

1MiB-4バイトを超えてはなりません。

JSON表現
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
田畑
name

string

ドキュメントのリソース名。たとえば、 projects/{project_id}/databases/{database_id}/documents/{document_path}

fields

map (key: string, value: object ( Value ))

ドキュメントのフィールド。

マップキーはフィールド名を表します。

単純なフィールド名は文字だけが含まれているとa zAへのZ09 、または_ 、およびで始めることはできません09 。たとえば、 foo_bar_17です。

正規表現__.*__一致するフィールド名は予約されています。特定の文書化されたコンテキストを除いて、予約済みフィールド名は禁止されています。 UTF-8として表されるマップキーは、1,500バイトを超えてはならず、空にすることはできません。

フィールドパスは、ここで定義された構造化フィールドを参照するために他のコンテキストで使用される場合があります。 mapValue場合、フィールドパスは、を含むフィールドの単純なフィールド名または引用符で囲まれたフィールド名で表され、で区切られ. 。たとえば、構造化フィールド"foo" : { mapValue: { "x&y" : { stringValue: "hello" }}}は、フィールドパスfoo.x&yで表されます。

フィールドパス内では、引用符で囲まれたフィールド名は`始まり`で終わり、任意の文字を含めることができます。 `を含む一部の文字は、 \を使用してエスケープする必要があります。たとえば、 `x&y`x&yを表し、 `bak\`tik`表しbak`tik

"key": valueリストを含むオブジェクト"key": valueペア。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string ( Timestamp format)

出力のみ。ドキュメントが作成された時刻。

この値は、ドキュメントが削除されてから再作成されると単調に増加します。また、他のドキュメントの値やクエリのreadTimeと比較することもできます。

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

updateTime

string ( Timestamp format)

出力のみ。ドキュメントが最後に変更された時刻。

この値は最初にcreateTime設定され、ドキュメントが変更されるたびに単調に増加します。また、他のドキュメントの値やクエリのreadTimeと比較することもできます。

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

メソッド

batchGet

複数のドキュメントを取得します。

batchWrite

書き込み操作のバッチを適用します。

beginTransaction

新しいトランザクションを開始します。

commit

オプションでドキュメントを更新しながら、トランザクションをコミットします。

createDocument

新しいドキュメントを作成します。

delete

ドキュメントを削除します。

get

単一のドキュメントを取得します。

list

ドキュメントを一覧表示します。

listCollectionIds

ドキュメントの下にあるすべてのコレクションIDを一覧表示します。

partitionQuery

クエリを並行して実行するために使用できるパーティションカーソルを返すことにより、クエリをパーティション化します。

patch

ドキュメントを更新または挿入します。

rollback

トランザクションをロールバックします。

runQuery

クエリを実行します。