Package google.firestore.v1beta1

索引

• Firestore（インターフェース）
• AggregationResult（メッセージ）
• ArrayValue（メッセージ）
• BatchGetDocumentsRequest（メッセージ）
• BatchGetDocumentsResponse（メッセージ）
• BatchWriteRequest（メッセージ）
• BatchWriteResponse（メッセージ）
• BeginTransactionRequest（メッセージ）
• BeginTransactionResponse（メッセージ）
• BitSequence（メッセージ）
• BloomFilter（メッセージ）
• CommitRequest（メッセージ）
• CommitResponse（メッセージ）
• CreateDocumentRequest（メッセージ）
• Cursor（メッセージ）
• DeleteDocumentRequest（メッセージ）
• Document（メッセージ）
• DocumentChange（メッセージ）
• DocumentDelete（メッセージ）
• DocumentMask（メッセージ）
• DocumentRemove（メッセージ）
• DocumentTransform（メッセージ）
• DocumentTransform.FieldTransform（メッセージ）
• DocumentTransform.FieldTransform.ServerValue（列挙型）
• ExecutionStats（メッセージ）
• ExistenceFilter（メッセージ）
• ExplainMetrics（メッセージ）
• ExplainOptions（メッセージ）
• GetDocumentRequest（メッセージ）
• ListCollectionIdsRequest（メッセージ）
• ListCollectionIdsResponse（メッセージ）
• ListDocumentsRequest（メッセージ）
• ListDocumentsResponse（メッセージ）
• ListenRequest（メッセージ）
• ListenResponse（メッセージ）
• MapValue（メッセージ）
• PartitionQueryRequest（メッセージ）
• PartitionQueryResponse（メッセージ）
• PlanSummary（メッセージ）
• Precondition（メッセージ）
• RollbackRequest（メッセージ）
• RunAggregationQueryRequest（メッセージ）
• RunAggregationQueryResponse（メッセージ）
• RunQueryRequest（メッセージ）
• RunQueryResponse（メッセージ）
• StructuredAggregationQuery（メッセージ）
• StructuredAggregationQuery.Aggregation（メッセージ）
• StructuredAggregationQuery.Aggregation.Avg（メッセージ）
• StructuredAggregationQuery.Aggregation.Count（メッセージ）
• StructuredAggregationQuery.Aggregation.Sum（メッセージ）
• StructuredQuery（メッセージ）
• StructuredQuery.CollectionSelector（メッセージ）
• StructuredQuery.CompositeFilter（メッセージ）
• StructuredQuery.CompositeFilter.Operator（列挙型）
• StructuredQuery.Direction（列挙型）
• StructuredQuery.FieldFilter（メッセージ）
• StructuredQuery.FieldFilter.Operator（列挙型）
• StructuredQuery.FieldReference（メッセージ）
• StructuredQuery.Filter（メッセージ）
• StructuredQuery.FindNearest（メッセージ）
• StructuredQuery.FindNearest.DistanceMeasure（列挙型）
• StructuredQuery.Order（メッセージ）
• StructuredQuery.Projection（メッセージ）
• StructuredQuery.UnaryFilter（メッセージ）
• StructuredQuery.UnaryFilter.Operator（列挙型）
• Target（メッセージ）
• Target.DocumentsTarget（メッセージ）
• Target.QueryTarget（メッセージ）
• TargetChange（メッセージ）
• TargetChange.TargetChangeType（列挙型）
• TransactionOptions（メッセージ）
• TransactionOptions.ReadOnly（メッセージ）
• TransactionOptions.ReadWrite（メッセージ）
• UpdateDocumentRequest（メッセージ）
• Value（メッセージ）
• Write（メッセージ）
• WriteRequest（メッセージ）
• WriteResponse（メッセージ）
• WriteResult（メッセージ）

Firestore

Cloud Firestore サービス。

Cloud Firestore は、高速でサーバーレスなフルマネージドのクラウド ネイティブ NoSQL ドキュメント データベースです。グローバル規模で展開されるこのサービスを利用することにより、モバイルアプリやウェブアプリ、IoT アプリのデータの保存、同期、照会を簡単に行えるようになります。クライアント ライブラリによってライブ同期とオフライン サポートが提供され、そのセキュリティ機能、Firebase および Google Cloud Platform とのインテグレーションにより、真にサーバーレスなアプリの開発が促進されます。

BatchGetDocuments
rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse) 複数のドキュメントを取得します。 このメソッドから返されるドキュメントは、リクエストされた順序で返されるとは限りません。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

BatchWrite

rpc BatchWrite(BatchWriteRequest) returns (BatchWriteResponse) 書き込みオペレーションのバッチを適用します。 BatchWrite メソッドは書き込みオペレーションをアトミックに適用せず、順番どおりに適用されない場合があります。このメソッドでは、1 つのドキュメントに複数の書き込みを行うことはできません。各書き込みは独立して成功または失敗します。各書き込みの成功ステータスについては、BatchWriteResponse をご覧ください。 アトミックに適用される一連の書き込みが必要な場合は、代わりに Commit を使用してください。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

BeginTransaction
rpc BeginTransaction(BeginTransactionRequest) returns (BeginTransactionResponse) 新しいトランザクションを開始します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

commit
rpc Commit(CommitRequest) returns (CommitResponse) トランザクションを commit し、必要に応じてドキュメントを更新します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

CreateDocument
rpc CreateDocument(CreateDocumentRequest) returns (Document) 新しいドキュメントを作成します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteDocument
rpc DeleteDocument(DeleteDocumentRequest) returns (Empty) ドキュメントを削除します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetDocument
rpc GetDocument(GetDocumentRequest) returns (Document) 単一のドキュメントを取得します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListCollectionIds
rpc ListCollectionIds(ListCollectionIdsRequest) returns (ListCollectionIdsResponse) ドキュメントのすべてのコレクション ID を一覧表示します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListDocuments
rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) ドキュメントを一覧表示します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

リッスン
rpc Listen(ListenRequest) returns (ListenResponse) 変更をリッスンします。このメソッドは、gRPC または WebChannel でのみ使用できます（REST では使用できません）。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

パーティション クエリ
rpc PartitionQuery(PartitionQueryRequest) returns (PartitionQueryResponse) クエリの並列実行に使用できるパーティション カーソルを返すことで、クエリをパーティショニングします。返されるパーティション カーソルは、クエリ結果の開始点/終了点として RunQuery で使用できる分割ポイントです。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ロールバック
rpc Rollback(RollbackRequest) returns (Empty) トランザクションをロールバックします。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

RunAggregationQuery

rpc RunAggregationQuery(RunAggregationQueryRequest) returns (RunAggregationQueryResponse) 集計クエリを実行します。 この API では、Firestore.RunQuery のような Document の結果を生成する代わりに、集計を実行して一連の AggregationResult をサーバー側で生成できます。 大まかな例: -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

RunQuery
rpc RunQuery(RunQueryRequest) returns (RunQueryResponse) クエリを実行します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

UpdateDocument
rpc UpdateDocument(UpdateDocumentRequest) returns (Document) ドキュメントを更新または挿入します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

Write
rpc Write(WriteRequest) returns (WriteResponse) ドキュメントの更新と削除のバッチを順番にストリーミングします。このメソッドは、gRPC または WebChannel でのみ使用できます（REST では使用できません）。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

AggregationResult

Firestore 集計クエリからの単一バケットの結果。

aggregate_fields のキーは、結果ごとに異なるフィールドが存在するドキュメント クエリとは異なり、集計クエリのすべての結果で同じです。

フィールド
aggregate_fields	map<string, Value> 集計関数の結果（例: COUNT(*) AS total_docs）。 キーは入力時に集計関数に割り当てられた alias で、このマップのサイズはクエリ内の集計関数の数と同じです。

ArrayValue

配列値。

フィールド
values[]	Value 配列内の値。

BatchGetDocumentsRequest

Firestore.BatchGetDocuments のリクエスト。

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。
documents[]	string 取得するドキュメントの名前。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。ドキュメントのいずれかが指定された database の子リソースでない場合、リクエストは失敗します。重複する名前は表示されません。
mask	DocumentMask 返されるフィールド。設定しない場合、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントに含まれている場合、そのフィールドはレスポンスで返されません。
共用体フィールド consistency_selector。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
transaction	bytes トランザクション内のドキュメントを読み取ります。
new_transaction	TransactionOptions 新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトは読み取り専用トランザクションです。新しいトランザクション ID は、ストリームの最初のレスポンスとして返されます。
read_time	Timestamp ドキュメントを指定された時点の状態として読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

BatchGetDocumentsResponse

Firestore.BatchGetDocuments のストリーミング レスポンス。

フィールド
transaction	bytes このリクエストの一部として開始されたトランザクション。最初のレスポンスでのみ、リクエストで BatchGetDocumentsRequest.new_transaction が設定されている場合にのみ設定されます。
read_time	Timestamp ドキュメントが読み取られた時刻。この値は単調に増加している可能性があります。この場合、結果ストリーム内の以前のドキュメントは read_time と今回との間に変化していないことが保証されます。
共用体フィールド result。単一の結果。サーバーがトランザクションを返すだけの場合は、空にできます。result は次のいずれかになります。
found	Document リクエストされた書類。
missing	string リクエストされたドキュメント名が存在しない。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。

BatchWriteRequest

Firestore.BatchWrite のリクエスト。

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。
writes[]	Write 適用する書き込み。 このメソッドは、書き込みをアトミックに適用せず、順序を保証するものではありません。各書き込みは独立して成功または失敗します。1 回のリクエストで複数回、同じドキュメントに書き込むことはできません。
labels	map<string, string> このバッチ書き込みに関連付けられているラベル。

BatchWriteResponse

Firestore.BatchWrite からのレスポンス。

フィールド
write_results[]	WriteResult 書き込みを適用した結果。 この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。
status[]	Status 書き込みの適用のステータス。 この i 番目の書き込みステータスは、リクエストの i 番目の書き込みに対応しています。

BeginTransactionRequest

Firestore.BeginTransaction のリクエスト。

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。
options	TransactionOptions トランザクションのオプション。デフォルトは、読み取り / 書き込みトランザクションです。

BeginTransactionResponse

Firestore.BeginTransaction に対するレスポンス。

フィールド
transaction	bytes 開始されたトランザクション。

ビットシーケンス

バイト配列にエンコードされたビット シーケンス。

bitmap バイト配列の各バイトには、シーケンスの 8 ビットが格納されます。唯一の例外は最後のバイトで、8 以下のビットを格納できます。padding は、「パディング」として無視される最後のバイトのビット数を定義します。これらの「パディング」の値は、ビットは指定されず、無視する必要があります。

最初のビット（ビット 0）を取得するには、(bitmap[0] & 0x01) != 0 を計算します。2 番目のビット（ビット 1）を取得するには、(bitmap[0] & 0x02) != 0 を計算します。3 番目のビット（ビット 2）を取得するには、(bitmap[0] & 0x04) != 0 を計算します。4 番目のビット（ビット 3）を取得するには、(bitmap[0] & 0x08) != 0 を計算します。ビット n を取得するには、(bitmap[n / 8] & (0x01 << (n % 8))) != 0 を計算します。

「サイズ」BitSequence（含まれるビット数）の式は、(bitmap.length * 8) - padding の式で計算されます。

フィールド
bitmap	bytes ビット シーケンスをエンコードするバイト。長さが 0 であっても構いません。
padding	int32 「パディング」として無視する bitmap の最後のバイトのビット数。bitmap の長さがゼロの場合、この値は 0 である必要があります。それ以外の場合は、この値は 0 ～ 7 の範囲内（両端を含む）にする必要があります。

ブルームフィルター

ブルーム フィルタ（https://en.wikipedia.org/wiki/Bloom_filter）。

ブルームフィルターは MD5 でエントリをハッシュし、結果として得られる 128 ビットのハッシュを 2 つの異なる 64 ビットのハッシュ値として扱います。これは 2 の補数エンコーディングを使用して符号なし整数として解釈されます。

h1 と h2 という名前の 2 つのハッシュ値を使用して、i=0 から始まる式を使用して hash_count ハッシュ値を計算します。

h(i) = h1 + (i * h2)

これらの結果の値はブルーム フィルタのビット数を剰余として取得され、指定されたエントリに対してテストするブルーム フィルタのビットを取得します。

フィールド
bits	BitSequence ブルーム フィルタのデータ。
hash_count	int32 アルゴリズムで使用されるハッシュの数。

CommitRequest

Firestore.Commit のリクエスト。

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。
writes[]	Write 適用する書き込み。 常にアトミックかつ順番に実行されます。
transaction	bytes 設定すると、このトランザクション内のすべての書き込みを適用して commit します。

CommitResponse

Firestore.Commit に対するレスポンス。

フィールド
write_results[]	WriteResult 書き込みを適用した結果。 この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。
commit_time	Timestamp commit が発生した時刻。read_time 以上で読み取ると、commit の効果が保証されます。

CreateDocumentRequest

Firestore.CreateDocument のリクエスト。

フィールド
parent	string 必須。親リソース。例: projects/{project_id}/databases/{database_id}/documents、または projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}。
collection_id	string 必須。リストに対する parent に関連するコレクション ID。例: chatrooms。
document_id	string このドキュメントに使用するクライアントによって割り当てられたドキュメント ID。 省略可。指定しない場合、サービスによって ID が割り当てられます。
document	Document 必須。作成するドキュメント。name は設定しないでください。
mask	DocumentMask 返されるフィールド。設定しない場合、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントに含まれている場合、そのフィールドはレスポンスで返されません。

Cursor

クエリ結果セット内の位置。

フィールド
values[]	Value 位置を表す値。クエリの order by 句での出現順序。 order by 句で指定された値よりも少ない値を含めることができます。
before	bool 位置が指定された値の直前または直後にある場合は、クエリで定義された並べ替え順に対する相対位置になります。

DeleteDocumentRequest

Firestore.DeleteDocument のリクエスト。

フィールド
name	string 必須。削除するドキュメントのリソース名。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。
current_document	Precondition ドキュメントに対するオプションの前提条件。この値が設定されていて、ターゲット ドキュメントで満たされていない場合、リクエストは失敗します。

ドキュメント

Firestore ドキュメント。

1 MiB ～ 4 バイト以下にしてください。

フィールド
name	string ドキュメントのリソース名（例: projects/{project_id}/databases/{database_id}/documents/{document_path}）。
fields	map<string, Value>
create_time	Timestamp 出力専用。ドキュメントが作成された時刻。 この値は、ドキュメントが削除されて再作成されると単調に増加します。また、他のドキュメントの値やクエリの read_time と比較することもできます。
update_time	Timestamp 出力専用。ドキュメントが最後に変更された時刻。 この値は最初は create_time に設定され、ドキュメントが変更されるたびに単調に増加します。また、他のドキュメントの値やクエリの read_time と比較することもできます。

DocumentChange

Document が変更されました。

削除を含む複数の writes の結果、最終的に Document の新しい値になった可能性があります。

複数のターゲットが影響を受ける場合、同じ論理変更に対して複数の DocumentChange メッセージが返されることがあります。

フィールド
document	Document Document の新しい状態。 mask が設定されている場合、更新または追加されたフィールドのみが含まれます。
target_ids[]	int32 このドキュメントに一致するターゲットのターゲット ID のセット。
removed_target_ids[]	int32 このドキュメントに一致しなくなったターゲットのターゲット ID のセット。

DocumentDelete

Document が削除されました。

複数の writes の結果である可能性があります。更新では最後に Document が削除されています。

複数のターゲットが影響を受ける場合、同じ論理削除に対して複数の DocumentDelete メッセージが返されることがあります。

フィールド
document	string 削除された Document のリソース名。
removed_target_ids[]	int32 以前にこのエンティティに一致したターゲットのターゲット ID のセット。
read_time	Timestamp 削除が観測された読み取りタイムスタンプ。 削除部分の commit_time 以上。

DocumentMask

ドキュメント上の一連のフィールド パス。ドキュメントに対する取得または更新オペレーションを、そのフィールドのサブセットに制限するために使用されます。標準のフィールド マスクとは異なり、スコープは常に Document に設定され、Value の動的な性質が考慮されます。

フィールド
field_paths[]	string マスク内のフィールドパスのリスト。フィールドパスの構文リファレンスについては、Document.fields をご覧ください。

ドキュメントの削除

ターゲットのビューから Document が削除されました。

ドキュメントがターゲットと無関係になり、表示領域から外れた場合に送信されます。サーバーがドキュメントの新しい値を送信できない場合は、DocumentDelete または DocumentChange の代わりに送信できます。

複数のターゲットが影響を受ける場合、同じ論理書き込みまたは削除に対して複数の DocumentRemove メッセージが返されることがあります。

フィールド
document	string ビューから出た Document のリソース名。
removed_target_ids[]	int32 以前にこのドキュメントと一致したターゲットのターゲット ID のセット。
read_time	Timestamp 削除が観測された読み取りタイムスタンプ。 変更/削除/削除の commit_time 以上。

DocumentTransform

ドキュメントの変換。

フィールド
document	string 変換するドキュメントの名前。
field_transforms[]	FieldTransform ドキュメントのフィールドに適用する変換を順番に並べたリスト。空にすることはできません。

FieldTransform

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

フィールド
field_path	string フィールドのパス。フィールドパスの構文リファレンスについては、Document.fields をご覧ください。
共用体フィールド transform_type。フィールドに適用する変換。transform_type は次のいずれかになります。
set_to_server_value	ServerValue 指定されたサーバー値にフィールドを設定します。
increment	Value 指定された値をフィールドの現在の値に加算します。 整数または倍精度値を指定する必要があります。フィールドが整数または double でない場合、またはフィールドがまだ存在しない場合は、変換により、指定された値がフィールドに設定されます。指定された値または現在のフィールド値のいずれかが倍精度浮動小数点の場合、両方の値が倍精度浮動小数点として解釈されます。二重算術と倍精度値の表現は、IEEE 754 セマンティクスに従います。正または負の整数オーバーフローがある場合、フィールドは最大の正または負の整数に解決されます。
maximum	Value フィールドを現在の値と指定された値の最大値に設定します。 整数または倍精度値を指定する必要があります。フィールドが整数または double でない場合、またはフィールドがまだ存在しない場合は、変換により、指定された値がフィールドに設定されます。フィールドと入力値が混合型（1 つは整数型、もう 1 つは double 型）で最大の演算が適用される場合、そのフィールドは大きい方のオペランドの型を取ります。オペランドが同等である場合（例: 3 と 3.0）、フィールドは変更されません。0、0.0、-0.0 はすべてゼロです。0 の格納値と 0 の入力値の最大値は常に格納値です。数値 x と NaN の最大値は NaN です。
minimum	Value フィールドを現在の値と指定された値の最小値に設定します。 整数または倍精度値を指定する必要があります。フィールドが整数または double でない場合、またはフィールドがまだ存在しない場合、変換によりフィールドは入力値に設定されます。フィールドと入力値の型が混在する（つまり、1 は整数型、もう 1 型は double 型）最小演算が適用される場合、そのフィールドは小さい方のオペランドの型を取ります。オペランドが同等である場合（例: 3 と 3.0）、フィールドは変更されません。0、0.0、-0.0 はすべてゼロです。ゼロの格納値と 0 の入力値の最小値は、常に格納された値です。数値 x と NaN の最小値は NaN です。
append_missing_elements	ArrayValue 指定された要素が現在のフィールド値にまだ存在しない場合は、順番に要素を追加します。フィールドが配列でない場合、またはフィールドがまだ存在しない場合は、まず空の配列に設定されます。 値が欠落しているかどうかを確認する際、異なる型の等しい数（3L と 3.0 など）は等しいと見なされます。NaN は NaN と等しく、Null は Null と等しくなります。入力に同等の値が複数含まれている場合は、最初の値のみが考慮されます。 対応する transform_result は null 値になります。
remove_all_from_array	ArrayValue フィールドの配列から指定されたすべての要素を削除します。フィールドが配列でない場合、またはフィールドがまだ存在しない場合は、空の配列に設定されます。 ある要素を削除するかどうかの判断では、同じ数の種類（例: 3L と 3.0）は等しいと見なされます。NaN は NaN と等しく、Null は Null と等しくなります。これにより、重複がある場合は同等の値がすべて削除されます。 対応する transform_result は null 値になります。

ServerValue

サーバーによって計算される値。

列挙型
SERVER_VALUE_UNSPECIFIED	指定なし。この値は使用しないでください。
REQUEST_TIME	サーバーがリクエストを処理した時刻（ミリ秒単位）。トランザクション内の複数のフィールド（同じまたは異なるドキュメント）で使用された場合、すべてのフィールドで同じサーバー タイムスタンプが取得されます。

ExecutionStats

クエリの実行統計情報。

フィールド
results_returned	int64 返された結果の総数（ドキュメント、射影、集計結果、キーを含む）。
execution_duration	Duration バックエンドでクエリを実行するためにかかった合計時間。
read_operations	int64 課金対象の読み取りオペレーションの合計数。
debug_stats	Struct クエリの実行から統計情報をデバッグする。デバッグの統計情報は、Firestore の進化に応じて変化する可能性があります。たとえば、{ "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details": { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0"} }

存在フィルタ

指定されたターゲットに一致するすべてのドキュメントのダイジェスト。

フィールド
target_id	int32 このフィルタを適用するターゲット ID。
count	int32 target_id に一致するドキュメントの合計数。 クライアント内の一致するドキュメント数と異なる場合、クライアントはターゲットに一致しなくなったドキュメントを手動で特定する必要があります。 クライアントは unchanged_names ブルーム フィルタを使用して、すべてのドキュメント名をフィルタに対してテストすることで、この判断に役立てることができます。ドキュメント名がフィルタにない場合、ドキュメントはターゲットに一致しなくなります。
unchanged_names	BloomFilter ブルーム フィルタ。名前に反して、target_id に一致するすべてのドキュメントのリソース名の UTF-8 バイト エンコードが projects/{project_id}/databases/{database_id}/documents/{document_path} の形式で含まれています。 このブルーム フィルタは、クライアントが使用しないと判断された場合や、計算や送信に計算コストがかかりすぎる場合など、サーバーの裁量で省略できます。クライアントは、このフィールドが存在する前に使用されたロジックにフォールバックすることで、このフィールドが存在しない場合に適切に処理する必要があります。つまり、クライアントのキャッシュ内のどのドキュメントが同期していないのかを判断するために、再開トークンなしでターゲットを再度追加します。

ExplainMetrics

クエリの指標について説明します。

フィールド
plan_summary	PlanSummary クエリの計画フェーズの情報。
execution_stats	ExecutionStats クエリの実行によって集計された統計情報。ExplainOptions.analyze が true に設定されている場合にのみ表示されます。

ExplainOptions

クエリのオプションを説明します。

フィールド
analyze	bool 省略可。このクエリを実行するかどうか。 false（デフォルト）の場合、クエリが計画され、計画段階の指標のみが返されます。 true の場合、クエリが計画されて実行され、完全なクエリ結果とともに、計画段階と実行段階の両方の指標が返されます。

GetDocumentRequest

Firestore.GetDocument のリクエスト。

フィールド
name	string 必須。取得するドキュメントのリソース名。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。
mask	DocumentMask 返されるフィールド。設定しない場合、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントに含まれている場合、そのフィールドはレスポンスで返されません。
共用体フィールド consistency_selector。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
transaction	bytes トランザクションでドキュメントを読み取ります。
read_time	Timestamp 指定された時点のドキュメントのバージョンを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

ListCollectionIdsRequest

Firestore.ListCollectionIds のリクエスト。

フィールド
parent	string 必須。親ドキュメント。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。例: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
page_size	int32 返される結果の最大件数です。
page_token	string ページトークン。ListCollectionIdsResponse の値にする必要があります。
共用体フィールド consistency_selector。このリクエストの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
read_time	Timestamp ドキュメントを指定された時点の状態として読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

ListCollectionIdsResponse

Firestore.ListCollectionIds からのレスポンス。

フィールド
collection_ids[]	string コレクション ID。
next_page_token	string リストの継続に使用できるページトークン。

ListDocumentsRequest のリスト

Firestore.ListDocuments のリクエスト。

フィールド
parent	string 必須。親リソース名。形式は projects/{project_id}/databases/{database_id}/documents または 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。
collection_id	string 省略可。一覧表示するコレクション ID（parent を基準とする相対パス）。 たとえば、chatrooms や messages です。 これは省略可能です。指定しない場合、Firestore は指定された parent に含まれるすべてのコレクションのドキュメントを一覧表示します。
page_size	int32 省略可。1 回のレスポンスで返されるドキュメントの最大数。 Firestore はこの値より少ない値を返すことがあります。
page_token	string 省略可。前の ListDocuments レスポンスから受け取ったページトークン。 これを指定して、後続のページを取得します。ページ分割を行う場合、他のすべてのパラメータ（page_size を除く）は、ページトークンを生成したリクエストで設定した値と一致している必要があります。
order_by	string 省略可。返されるドキュメントの順序（省略可）。 例: priority desc, __name__ desc。 これは、Firestore クエリで使用される ORDER BY を文字列表現でミラーリングします。存在しない場合、ドキュメントは __name__ ASC に基づいて並べ替えられます。
mask	DocumentMask 省略可。返されるフィールド。設定しない場合、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントに含まれている場合、そのフィールドはレスポンスで返されません。
show_missing	bool リストにないドキュメントを表示するかどうか。 ドキュメントが存在しないものの、その下にサブドキュメントがネストされている場合、そのドキュメントは存在しません。true の場合、このような欠落しているドキュメントはキーとともに返されますが、フィールド、create_time、update_time は設定されません。 show_missing を含むリクエストで where または order_by を指定することはできません。
共用体フィールド consistency_selector。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
transaction	bytes すでにアクティブなトランザクションの一部として読み取りを実行します。
read_time	Timestamp 指定された時刻に読み取りを実行します。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

ListDocumentsResponse

Firestore.ListDocuments に対するレスポンス。

フィールド
documents[]	Document 見つかったドキュメント。
next_page_token	string ドキュメントの次のページを取得するためのトークン。 このフィールドを省略すると、後続のページはなくなります。

リッスン リクエスト

Firestore.Listen のリクエスト

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。
labels	map<string, string> このターゲットの変更に関連付けられているラベル。
共用体フィールド target_change。サポートされているターゲットが変更されます。target_change は次のいずれかになります。
add_target	Target このストリームに追加するターゲット。
remove_target	int32 このストリームから削除するターゲットの ID。

リスニング レスポンス

Firestore.Listen に対するレスポンス。

フィールド
共用体フィールド response_type。サポートされているレスポンス。response_type は次のいずれかになります。
target_change	TargetChange ターゲットが変更されました。
document_change	DocumentChange Document が変更されました。
document_delete	DocumentDelete Document が削除されました。
document_remove	DocumentRemove Document がターゲットから削除されました（ターゲットとの関連性がなくなったため）。
filter	ExistenceFilter 指定されたターゲットに対して以前に返されたドキュメントのセットに適用するフィルタ。 指定されたターゲットからドキュメントが削除された可能性があるものの、正確なドキュメントが不明な場合に返されます。

MapValue

マップ値。

フィールド
fields	map<string, Value> マップのフィールド。 マップキーはフィールド名を表します。正規表現 __.*__ に一致するフィールド名は予約されています。予約済みのフィールド名は、特定のドキュメント化されたコンテキストを除き禁止されます。UTF-8 で表されるマップキーは、1,500 バイト以下にする必要があります。空にすることはできません。

PartitionQueryRequest

Firestore.PartitionQuery のリクエスト。

フィールド
parent	string 必須。親リソース名。形式は projects/{project_id}/databases/{database_id}/documents です。ドキュメントのリソース名はサポートされていません。データベース リソース名のみを指定できます。
partition_count	int64 必要なパーティション ポイントの最大数。パーティションは、複数の結果ページにまたがって返される場合もあります。数値は正数で指定してください。実際に返されるパーティションの数はこれより少ない場合があります。 たとえば、実行する並列クエリの数より 1 つ少ない値に設定したり、データ パイプライン ジョブの実行時に利用可能なワーカー数やコンピューティング インスタンスの数より 1 つ少ない数に設定したりできます。
page_token	string 前回の PartitionQuery の呼び出しで返された next_page_token 値で、追加の結果セットを取得するために使用できます。結果セット間の順序は保証されません。したがって、複数の結果セットを使用するには、異なる結果セットをマージする必要があります。 たとえば、page_token を使用する後続の 2 つの呼び出しで、次のような結果が返されます。 カーソル B、カーソル M、カーソル Q カーソル A、カーソル U、カーソル W PartitionQuery に指定されたクエリの結果に基づいて順序付けされた完全な結果セットを取得するには、結果セットをマージする必要があります: カーソル A、カーソル B、カーソル M、カーソル Q、カーソル U、カーソル W
page_size	int32 この呼び出しで返されるパーティションの最大数（partition_count に従う）。 たとえば、partition_count = 10 かつ page_size = 8 の場合、PartitionQuery の最初の呼び出しでは最大 8 つのパーティションが返されます。さらに結果が存在する場合は next_page_token が返されます。PartitionQuery の 2 回目の呼び出しでは、最大 2 つのパーティションが返され、partition_count で指定された合計 10 個のパーティションが完成します。
共用体フィールド query_type。パーティショニングするクエリ。query_type は次のいずれかになります。
structured_query	StructuredQuery 構造化クエリ。クエリでは、すべての子孫を持つコレクションを指定し、名前の昇順で並べ替える必要があります。その他のフィルタ、並べ替え、制限、オフセット、開始/終了カーソルはサポートされていません。
共用体フィールド consistency_selector。このリクエストの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
read_time	Timestamp ドキュメントを指定された時点の状態として読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

PartitionQueryResponse

Firestore.PartitionQuery に対するレスポンス。

フィールド
partitions[]	Cursor 結果をパーティション分割する。各パーティションは、クエリ結果の開始点または終了点として RunQuery で使用できる分割ポイントです。RunQuery リクエストは、この PartitionQuery リクエストに対して指定されたクエリを使用して行う必要があります。パーティション カーソルは、PartitionQuery に指定されたクエリの結果と同じ順序で並べ替えられます。 たとえば、PartitionQuery リクエストがパーティション カーソル A と B を返す場合、次の 3 つのクエリを実行すると、元のクエリの結果セット全体が返されます。 クエリ, end_at A クエリ, start_at A, end_at B クエリ, start_at B 空の結果は、クエリの結果が少なすぎてパーティショニングできないか、クエリがまだパーティショニングでサポートされていないことを示している可能性があります。
next_page_token	string PartitionQuery リクエストの partition_count で指定された数まで、追加の結果セットをリクエストするために使用できるページトークン。空白の場合、結果はそれ以上存在しません。

プランの概要

クエリの計画フェーズの情報。

フィールド
indexes_used[]	Struct クエリに対して選択されたインデックス。例: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

Precondition

条件付きオペレーションに使用される、ドキュメントに対する前提条件。

フィールド
共用体フィールド condition_type。前提条件のタイプ。condition_type は次のいずれかになります。
exists	bool true に設定した場合、対象ドキュメントが存在している必要があります。false に設定した場合、ターゲット ドキュメントは存在しません。
update_time	Timestamp 設定した場合、対象ドキュメントが存在し、そのドキュメントが最終更新日時に更新されている必要があります。タイムスタンプはマイクロ秒単位で揃える必要があります。

RollbackRequest

Firestore.Rollback のリクエスト。

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。
transaction	bytes 必須。ロールバックするトランザクション。

RunAggregationQueryRequest

Firestore.RunAggregationQuery のリクエスト。

フィールド
parent	string 必須。親リソース名。形式は projects/{project_id}/databases/{database_id}/documents または 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
explain_options	ExplainOptions 省略可。クエリのオプションを説明します。設定すると、追加のクエリ統計情報が返されます。そうでない場合は、クエリ結果のみが返されます。
共用体フィールド query_type。実行するクエリ。query_type は次のいずれかになります。
structured_aggregation_query	StructuredAggregationQuery 集計クエリ。
共用体フィールド consistency_selector。クエリの整合性モードはデフォルトで強整合性に設定されます。consistency_selector は次のいずれかになります。
transaction	bytes すでにアクティブなトランザクション内で集計を実行します。 この値は、クエリを実行する不透明なトランザクション ID です。
new_transaction	TransactionOptions クエリの一部として新しいトランザクションを開始します。デフォルトは読み取り専用です。 新しいトランザクション ID は、ストリームの最初のレスポンスとして返されます。
read_time	Timestamp 指定されたタイムスタンプでクエリを実行します。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

RunAggregationQueryResponse

Firestore.RunAggregationQuery に対するレスポンス。

フィールド
result	AggregationResult 単一の集計結果。 部分的な進捗状況を報告している場合は表示されません。
transaction	bytes このリクエストの一部として開始されたトランザクション。 リクエストが新しいトランザクションの開始をリクエストしたとき、最初のレスポンスにのみ存在します。
read_time	Timestamp 集計結果が計算された時刻。これは常に単調に増加します。この場合、結果ストリームの前の AggregationResult が、read_time とこの AggregationResult の間で変更されていないことが保証されます。 クエリから結果が返されない場合は、read_time が含まれ、result がないレスポンスが送信されます。これはクエリが実行された時刻を表します。
explain_metrics	ExplainMetrics クエリ説明指標をクエリします。これは RunAggregationQueryRequest.explain_options が指定されている場合のみ存在し、ストリームの最後のレスポンスで 1 回だけ送信されます。

RunQueryRequest

Firestore.RunQuery のリクエスト。

フィールド
parent	string 必須。親リソース名。形式は projects/{project_id}/databases/{database_id}/documents または 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
explain_options	ExplainOptions 省略可。クエリのオプションを説明します。設定すると、追加のクエリ統計情報が返されます。そうでない場合は、クエリ結果のみが返されます。
共用体フィールド query_type。実行するクエリ。query_type は次のいずれかになります。
structured_query	StructuredQuery 構造化クエリ。
共用体フィールド consistency_selector。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
transaction	bytes すでにアクティブなトランザクション内でクエリを実行します。 この値は、クエリを実行する不透明なトランザクション ID です。
new_transaction	TransactionOptions 新しいトランザクションを開始し、ドキュメントを読み取ります。デフォルトは読み取り専用トランザクションです。新しいトランザクション ID は、ストリームの最初のレスポンスとして返されます。
read_time	Timestamp ドキュメントを指定された時点の状態として読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

RunQueryResponse

Firestore.RunQuery に対するレスポンス。

フィールド
transaction	bytes このリクエストの一部として開始されたトランザクション。最初のレスポンスでのみ、リクエストで RunQueryRequest.new_transaction が設定されている場合にのみ設定できます。設定すると、このレスポンスに他のフィールドは設定されません。
document	Document 部分的な進行状況を報告する場合は設定されないクエリ結果。
read_time	Timestamp ドキュメントが読み取られた時刻。これは単調に増加している可能性があります。この場合、結果ストリーム内の前のドキュメントは、read_time とこのドキュメントの間で変更されていないことが保証されます。 クエリから結果が返されない場合は、read_time が含まれ、document がないレスポンスが送信されます。これはクエリが実行された時刻を表します。
skipped_results	int32 最後のレスポンスと現在のレスポンスの間のオフセットによりスキップされた結果の数。
explain_metrics	ExplainMetrics クエリ説明指標をクエリします。これは RunQueryRequest.explain_options が指定されている場合のみ存在し、ストリームの最後のレスポンスで 1 回だけ送信されます。
共用体フィールド continuation_selector。クエリの継続モード。存在する場合は、現在のクエリ レスポンス ストリームが終了したことを示します。document の有無にかかわらず設定できますが、設定するとこれ以上結果は返されません。continuation_selector は次のいずれかになります。
done	bool 存在する場合、Firestore はリクエストを完全に終了しており、これ以上ドキュメントは返されません。

StructuredAggregationQuery

StructuredQuery に対して集計を実行するための Firestore クエリ。

フィールド
aggregations[]	Aggregation 省略可。structured_query の結果に適用する一連の集計。 必須の要素 クエリごとに最小 1 つ、最大 5 つの集計。
共用体フィールド query_type。集計に使用する基本クエリ。query_type は次のいずれかになります。
structured_query	StructuredQuery ネストされた構造化クエリ。

集計

単一の結果を生成する集計を定義します。

フィールド
alias	string 省略可。集計の結果を保存するフィールドの名前（省略可）。 指定しない場合、Firestore は field_<incremental_id++> の形式のデフォルト名を選択します。例: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... ); 次のようになります。 AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... ); 必須の要素 すべての集計エイリアスで一意である必要があります。 document field name の制限に従います。
共用体フィールド operator。実行する集計のタイプ。必須です。operator は次のいずれかになります。
count	Count カウント アグリゲータ。
sum	Sum 合計集計関数。
avg	Avg 平均アグリゲータ。

平均

リクエストされたフィールドの値の平均。

• 集計されるのは数値のみです。数値以外の値（NULL など）はすべてスキップされます。

• 集計値に NaN が含まれている場合は、NaN を返します。無限大の数学は IEEE-754 規格に準拠しています。

• 集計値セットが空の場合は、NULL を返します。

• 結果は常に double として返します。

フィールド
field	FieldReference 集計するフィールド。

カウント

クエリに一致するドキュメントの数。

COUNT(*) 集計関数はドキュメント全体で動作するため、フィールド参照は必要ありません。

フィールド
up_to	Int64Value 省略可。カウントするドキュメントの最大数に関する任意の制約。 これにより、スキャンするドキュメント数に上限を設定し、レイテンシとコストを抑えることができます。 指定しない場合は、境界なしと解釈されます。 大まかな例: AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); 必須の要素 指定する場合は 0 より大きい値にする必要があります。

合計

リクエストされたフィールドの値の合計。

• 集計されるのは数値のみです。数値以外の値（NULL など）はすべてスキップされます。

• 集計値に NaN が含まれている場合は、NaN を返します。無限大の数学は IEEE-754 規格に準拠しています。

• 集計値セットが空の場合は 0 を返します。

• 集計された数値がすべて整数で、合計結果がオーバーフローしない場合は、64 ビット整数を返します。それ以外の場合、結果は double として返されます。すべての集計値が整数であっても、64 ビット符号付き整数に収まらない場合は、結果が double として返されます。この場合、戻り値の精度が失われます。

• アンダーフローが発生すると、浮動小数点集計は非決定的になります。つまり、基になる値を変更せずに同じクエリを繰り返し実行すると、毎回少し異なる結果が生成される可能性があります。このような場合、値は浮動小数点数ではなく整数として格納する必要があります。

フィールド
field	FieldReference 集計するフィールド。

StructuredQuery

Firestore クエリ。

クエリのステージは、次の順序で実行されます。 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit

フィールド
select	Projection 返されるフィールドのオプションのサブセット。 これは、クエリから返されたドキュメントの DocumentMask として機能します。設定されていない場合、呼び出し元はすべてのフィールドを返すことを要求していると想定されます。
from[]	CollectionSelector クエリを実行するコレクション。
where	Filter 適用するフィルタ。
order_by[]	Order クエリ結果に適用する順序。 Firestore では、呼び出し元は完全な順序指定、部分順序指定、または順序指定なしを指定できます。いずれの場合も、Firestore は次のルールを通じて安定した順序を保証します。 order_by は、不等式フィルタで使用するすべてのフィールドを参照するために必要です。 order_by に含める必要があるものの、まだ存在しないすべてのフィールドは、フィールド名の辞書順に追加されます。 __name__ の注文が指定されていない場合、デフォルトでその注文が追加されます。 フィールドは、最後に指定された順序と同じ並べ替え方向、または「ASCENDING」で追加されます。順序が指定されていない場合。例: 「ORDER BY a」は「ORDER BY a ASC, __name__ ASC」になります 「ORDER BY a DESC」は「ORDER BY a DESC, __name__ DESC」になります 「WHERE a > 1」は「WHERE a > 1 ORDER BY a ASC, __name__ ASC」になります 「WHERE __name__ > ... AND a > 1」は「WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC」になります
start_at	Cursor 結果セット内でクエリを開始する位置の潜在的な接頭辞。 結果セットの順序は、元のクエリの ORDER BY 句に基づきます。 SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC; このクエリの結果は (b ASC, __name__ ASC) で並べ替えられます。 カーソルは、位置の完全な順序または接頭辞のいずれかを参照できますが、指定された ORDER BY にあるフィールドよりも多くのフィールドを参照することはできません。 上記の例の場合、次の開始カーソルをアタッチすると、さまざまな影響があります。 START BEFORE (2, /k/123): a = 1 AND b > 2 AND __name__ > /k/123 の直前にクエリを開始します。 START AFTER (10): a = 1 AND b > 10 の直後にクエリを開始します。 最初の N 個の結果をスキャンしてスキップする OFFSET とは異なり、開始カーソルを使用すると、クエリを論理的な位置から開始できます。この位置は実際の結果と一致させる必要はありません。この位置から前方にスキャンして次のドキュメントを探します。 必須の要素 値の数は、ORDER BY 句で指定されたフィールドの数以下にする必要があります。
end_at	Cursor クエリの終了位置として、結果セット内の位置の潜在的な接頭辞。 START_AT と似ていますが、開始位置ではなく終了位置を制御します。 必須の要素 値の数は、ORDER BY 句で指定されたフィールドの数以下にする必要があります。
offset	int32 最初の結果を返す前にスキップするドキュメントの数。 これは、WHERE、START AT、およびEND AT で、LIMIT 句の前。 必須の要素 指定する場合は、0 以上の値を指定する必要があります。
limit	Int32Value 返される結果の最大件数です。 他のすべての制約の後に適用されます。 必須の要素 指定する場合は、0 以上の値を指定する必要があります。
find_nearest	FindNearest 省略可。潜在的な最近傍探索。 他のすべてのフィルタと順序の後に適用されます。 指定されたクエリベクトルに最も近いベクトル エンベディングを検索します。

コレクション セレクタ

コレクションの選択（messages as m1 など）。

フィールド
collection_id	string コレクション ID。設定すると、この ID のコレクションのみが選択されます。
all_descendants	bool false の場合、含まれる RunQueryRequest で指定された parent の直接の子であるコレクションのみを選択します。true の場合、すべての子孫コレクションが選択されます。

CompositeFilter

指定した演算子を使用して他の複数のフィルタを結合するフィルタ。

フィールド
op	Operator 複数のフィルタを組み合わせるための演算子。
filters[]	Filter 結合するフィルタのリスト。 必須の要素 少なくとも 1 つのフィルタがあります。

演算子

複合フィルタ演算子。

列挙値
OPERATOR_UNSPECIFIED	指定なし。この値は使用しないでください。
AND	ドキュメントは、結合されたすべてのフィルタを満たす必要があります。
OR	ドキュメントは組み合わせたフィルタの少なくとも 1 つを満たす必要があります。

方向

並べ替えの方向。

列挙型
DIRECTION_UNSPECIFIED	未設定。
ASCENDING	昇順。
DESCENDING	降順。

フィールド フィルタ

特定のフィールドに対するフィルタ。

フィールド
field	FieldReference フィルタに使用するフィールド。
op	Operator フィルタに使用する演算子。
value	Value 比較対象の値。

演算子

フィールド フィルタ演算子。

列挙型
OPERATOR_UNSPECIFIED	指定なし。この値は使用しないでください。
LESS_THAN	指定された field が指定された value を下回っています。 必須の要素 order_by ではその field が 1 位です。
LESS_THAN_OR_EQUAL	指定された field が指定された value 以下である。 必須の要素 order_by ではその field が 1 位です。
GREATER_THAN	指定された field が、指定された value を上回っています。 必須の要素 order_by ではその field が 1 位です。
GREATER_THAN_OR_EQUAL	指定された field が指定された value 以上である。 必須の要素 order_by ではその field が 1 位です。
EQUAL	指定された field が指定された value と等しい。
NOT_EQUAL	指定された field が、指定された value と等しくありません。 必須の要素 他に NOT_EQUAL、NOT_IN、IS_NOT_NULL、IS_NOT_NAN はありません。 そのfieldがorder_byの第 1 位です。
ARRAY_CONTAINS	指定された field は、指定された value を含む配列です。
IN	指定された field が、指定された配列内の 1 つ以上の値と等しい。 必須の要素 この value は空でない ArrayValue であり、分離制限が適用されます。 同じクエリに NOT_IN フィルタがありません。
ARRAY_CONTAINS_ANY	指定された field は、指定された配列内のいずれかの値を含む配列です。 必須の要素 この value は空でない ArrayValue であり、分離制限が適用されます。 同じ分離内に他の ARRAY_CONTAINS_ANY フィルタがない。 同じクエリに NOT_IN フィルタがありません。
NOT_IN	field の値が指定された配列にありません。 必須の要素 この value は、最大 10 個の値を持つ空でない ArrayValue です。 他に OR、IN、ARRAY_CONTAINS_ANY、NOT_IN、NOT_EQUAL、IS_NOT_NULL、IS_NOT_NAN はありません。 そのfieldがorder_byの第 1 位です。

FieldReference

ドキュメント内のフィールドへの参照（例: stats.operations）。

フィールド
field_path	string ドキュメント内のフィールドへの参照。 必須の要素 各セグメントが document field name 制限を遵守している、セグメントのドット区切り（.）文字列でなければなりません。

フィルタ

フィルタ。

フィールド
共用体フィールド filter_type。フィルタのタイプ。filter_type は次のいずれかになります。
composite_filter	CompositeFilter 複合フィルタ。
field_filter	FieldFilter ドキュメント フィールドのフィルタ。
unary_filter	UnaryFilter 引数を 1 つだけ受け取るフィルタ。

FindNearest

最近傍探索の構成。

フィールド
vector_field	FieldReference 必須。検索するインデックス付きベクトル フィールド。次元が query_vector と一致するベクトルを含むドキュメントのみが返されます。
query_vector	Value 必須。検索対象のクエリベクトル。2,048 次元以下のベクトルにする必要があります。
distance_measure	DistanceMeasure 必須。使用する距離尺度（必須）。
limit	Int32Value 必須。返される最近傍の数。1,000 以下の正の整数を指定する必要があります。

DistanceMeasure

ベクトルを比較するときに使用する距離の尺度。

列挙型
DISTANCE_MEASURE_UNSPECIFIED	設定しないでください。
EUCLIDEAN	ベクトル間の EUCLIDEAN 距離を測定します。詳しくは、ユークリッドをご覧ください。
COSINE	ベクトル間の角度に基づいてベクトルを比較します。これにより、ベクトルの大きさに基づかない類似性を測定できます。COSINE 距離ではなく、単位正規化ベクトルで DOT_PRODUCT を使用することをおすすめします。COSINE 距離は数学的に同等でパフォーマンスが向上します。詳しくは、コサイン類似度をご覧ください。
DOT_PRODUCT	コサインに似ていますが、ベクトルの大きさの影響を受けます。詳細については、ドット積をご覧ください。

注文

フィールド上の順序。

フィールド
field	FieldReference 並べ替えるフィールド。
direction	Direction 並べ替えの方向。デフォルトは ASCENDING です。

予測

返されるドキュメントのフィールドの射影。

フィールド
fields[]	FieldReference 返されるフィールド。 空の場合、すべてのフィールドが返されます。ドキュメントの名前のみを返すには、['__name__'] を使用します。

UnaryFilter

単一のオペランドを持つフィルタ。

フィールド
op	Operator 適用する単項演算子。
共用体フィールド operand_type。フィルタの引数。operand_type は次のいずれかになります。
field	FieldReference 演算子を適用するフィールド。

演算子

単項演算子。

列挙型
OPERATOR_UNSPECIFIED	指定なし。この値は使用しないでください。
IS_NAN	指定された field は NaN と等しい。
IS_NULL	指定された field は NULL と等しい。
IS_NOT_NAN	指定された field が NaN と等しくない。 必須の要素 他に NOT_EQUAL、NOT_IN、IS_NOT_NULL、IS_NOT_NAN はありません。 そのfieldがorder_byの第 1 位です。
IS_NOT_NULL	指定された field が NULL と等しくない。 必須の要素 1 つの NOT_EQUAL、NOT_IN、IS_NOT_NULL、または IS_NOT_NAN。 そのfieldがorder_byの第 1 位です。

ターゲティング

リッスンする一連のドキュメントの仕様。

フィールド
target_id	int32 ストリーム上のターゲットを識別するターゲット ID。ゼロ以外の正の数を指定する必要があります。 target_id が 0（または指定されていない）の場合、サーバーはこのターゲットに ID を割り当て、TargetChange::ADD イベントでそれを返します。target_id=0 が指定されたターゲットを追加した後は、後続のすべてのターゲットにも target_id=0 が必要になります。target_id=0 のターゲットが追加された後に target_id != 0 を含む AddTarget リクエストがサーバーに送信されると、サーバーはすぐに TargetChange::Remove イベントを含むレスポンスを送信します。 クライアントが ID なしで複数の AddTarget リクエストを送信した場合、TargetChage.target_ids で返される ID の順序は定義されません。したがって、クライアントは、ターゲット ID の割り当てをサーバーに依存するのではなく、ターゲット ID を指定する必要があります。 target_id がゼロ以外の場合、このストリームに同じ ID の既存のアクティブなターゲットがあってはなりません。
once	bool ターゲットが最新で整合性が取れたら削除する必要があるかどうか。
expected_count	Int32Value 再開トークンまたは読み取り時にクエリに最後に一致したドキュメントの数。 この値は、resume_type が指定されている場合にのみ適用されます。この値が存在し、0 より大きいのは、クライアントが ExistenceFilter.unchanged_names をレスポンスに含めることをクライアントが求めていることを示しています。
共用体フィールド target_type。リッスンするターゲットのタイプ。target_type は次のいずれかになります。
query	QueryTarget クエリで指定されたターゲット。
documents	DocumentsTarget 一連のドキュメント名で指定されたターゲット。
共用体フィールド resume_type。聞き取りを開始するタイミング。 指定すると、resume_token または read_time より後に更新された、一致するドキュメントのみが返されます。それ以外の場合は、後続の変更が行われる前に、一致するすべてのドキュメントが返されます。resume_type は次のいずれかになります。
resume_token	bytes 同一のターゲットに対する前回の TargetChange からの再開トークン。 別のターゲットでの再開トークンの使用はサポートされていないため、失敗する可能性があります。
read_time	Timestamp 特定の read_time の後にリッスンを開始します。 クライアントはこの時点で、一致するドキュメントの状態を把握している必要があります。

DocumentsTarget

一連のドキュメント名で指定されたターゲット。

フィールド
documents[]	string 取得するドキュメントの名前。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。ドキュメントのいずれかが指定された database の子リソースでない場合、リクエストは失敗します。重複する名前は表示されません。

QueryTarget

クエリで指定されたターゲット。

フィールド
parent	string 親リソース名。形式は projects/{project_id}/databases/{database_id}/documents または 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
共用体フィールド query_type。実行するクエリ。query_type は次のいずれかになります。
structured_query	StructuredQuery 構造化クエリ。

ターゲットの変更

モニタリング中のターゲットが変更されました。

フィールド
target_change_type	TargetChangeType 発生した変更のタイプ。
target_ids[]	int32 変更されたターゲットのターゲット ID。 空の場合、変更はすべてのターゲットに適用されます。 ターゲット ID の順序は定義されていません。
cause	Status この変更の原因となったエラー（該当する場合）。
resume_token	bytes 指定された target_ids（target_ids が空の場合はすべてのターゲット）のストリームを再開するために使用できるトークン。 ターゲットの変更ごとに設定されるわけではなく、
read_time	Timestamp 指定された target_ids の一貫した read_time（target_ids が一貫したスナップショットにない場合は省略されます）。 ストリーム全体が新しい整合性のあるスナップショットに達するたびに、target_ids が空の read_time がストリームから送信されます。ADD、CURRENT、RESET メッセージは、（最終的に）新しい整合性のあるスナップショットを生成することが保証されます（NO_CHANGE メッセージと REMOVE メッセージはそうではありません）。 特定のストリームに対して、read_time は単調に増加することが保証されます。

ターゲット変更タイプ

変更のタイプ。

列挙型
NO_CHANGE	変更はありません。更新された resume_token を送信する場合にのみ使用されます。
ADD	ターゲットを追加しました。
REMOVE	ターゲットを削除しました。
CURRENT	ターゲットには、ターゲットがストリームに追加される前に commit されたすべての変更が反映されます。 この値は、ターゲットが追加された時点以上の read_time またはそれ以降に送信されます。 read-after-write セマンティクスが必要な場合は、リスナーはこの変更を待つことができます。
RESET	ターゲットがリセットされました。以降の変更ではターゲットの新しい初期状態が返されます。 初期状態が完了すると、以前にターゲットを CURRENT と指定していた場合でも、CURRENT が返されます。

TransactionOptions

新しいトランザクションを作成するためのオプション。

フィールド
共用体フィールド mode。トランザクションのモード。mode は次のいずれかになります。
read_only	ReadOnly トランザクションは読み取りオペレーションにのみ使用できます。
read_write	ReadWrite トランザクションは読み取りオペレーションと書き込みオペレーションの両方に使用できます。

閲覧専用

ドキュメントの読み取りのみに使用できるトランザクションのオプション。

フィールド
共用体フィールド consistency_selector。このトランザクションの整合性モード。設定しない場合、デフォルトで強整合性が使用されます。consistency_selector は次のいずれかになります。
read_time	Timestamp 指定された時刻にドキュメントを読み取ります。 これは、過去 1 時間以内のマイクロ秒精度のタイムスタンプである必要があります。ポイントインタイム リカバリが有効になっている場合は、過去 7 日間の 1 分単位のタイムスタンプでも構いません。

読み取りと書き込み

ドキュメントの読み取りと書き込みに使用できるトランザクションのオプション。

Firestore では、サードパーティの認証リクエストで読み取り / 書き込みを作成できません。あります。

フィールド
retry_transaction	bytes 再試行するトランザクション（省略可）。

UpdateDocumentRequest

Firestore.UpdateDocument のリクエスト。

フィールド
document	Document 必須。更新されたドキュメント。ドキュメントが存在しない場合は作成します。
update_mask	DocumentMask 更新するフィールド。マスク内のどのフィールドパスにも、予約済みの名前を含めることはできません。 ドキュメントがサーバー上にあり、マスクで参照されていないフィールドがある場合、それらは変更されません。マスクで参照されていても入力ドキュメントに存在しないフィールドは、サーバー上のドキュメントから削除されます。
mask	DocumentMask 返されるフィールド。設定しない場合、すべてのフィールドを返します。 このマスクに存在しないフィールドがドキュメントに含まれている場合、そのフィールドはレスポンスで返されません。
current_document	Precondition ドキュメントに対するオプションの前提条件。この値が設定されていて、ターゲット ドキュメントで満たされていない場合、リクエストは失敗します。

値

サポートされている任意の値の型を保持できるメッセージ。

フィールド
共用体フィールド value_type。値を設定する必要があります。value_type は次のいずれかになります。
null_value	NullValue null 値。
boolean_value	bool ブール値。
integer_value	int64 整数値。
double_value	double double 値。
timestamp_value	Timestamp タイムスタンプ値。 マイクロ秒単位の精度保存時に、それを超える精度は切り捨てられます。
string_value	string 文字列値。 UTF-8 で表される文字列は、1 MiB - 89 バイトを超えないようにする必要があります。UTF-8 表現の最初の 1,500 バイトのみがクエリで考慮されます。
bytes_value	bytes バイト値。 1 MiB - 89 バイト以下の値を指定してください。最初の 1,500 バイトのみがクエリで考慮されます。
reference_value	string ドキュメントへの参照。例: projects/{project_id}/databases/{database_id}/documents/{document_path}。
geo_point_value	LatLng 地表面上の 1 点を表す地理的位置の値。
array_value	ArrayValue 配列値。 別の配列値を直接格納することはできませんが、別の配列を含むマップは含めることができます。
map_value	MapValue マップ値。

Write

ドキュメントへの書き込み。

フィールド
update_mask	DocumentMask この書き込みで更新するフィールド。 このフィールドは、オペレーションが update の場合にのみ設定できます。update にマスクが設定されておらず、ドキュメントが存在する場合、既存のデータが上書きされます。マスクが設定されていて、サーバーのドキュメントにマスクでカバーされていないフィールドがある場合、それらは変更されません。マスクで参照されていても入力ドキュメントに存在しないフィールドは、サーバー上のドキュメントから削除されます。このマスクのフィールドパスに、予約済みのフィールド名を含めることはできません。
update_transforms[]	FieldTransform 更新後に実行する変換。 このフィールドは、オペレーションが update の場合にのみ設定できます。この書き込みが存在する場合は、同じドキュメントに対して update と transform をアトミックに順番に実行するのと同じ結果になります。
current_document	Precondition ドキュメントに対するオプションの前提条件。 この値が設定されていて、ターゲット ドキュメントが満たしていない場合、書き込みは失敗します。
共用体フィールド operation。実行するオペレーション。operation は次のいずれかになります。
update	Document 作成するドキュメント。
delete	string 削除するドキュメントの名前。形式は projects/{project_id}/databases/{database_id}/documents/{document_path} です。
transform	DocumentTransform ドキュメントに変換を適用します。

WriteRequest

Firestore.Write のリクエスト。

最初のリクエストは、ストリームを作成するか、トークンから既存のストリームを再開します。

新しいストリームを作成すると、サーバーは次のリクエストで使用するために、ID とトークンのみを含むレスポンスを返します。

ストリームを再開する際、サーバーはまず指定されたトークンより後のレスポンスをストリーミングし、次に次のリクエストで使用する最新のトークンのみを含むレスポンスをストリーミングします。

フィールド
database	string 必須。データベース名。形式は projects/{project_id}/databases/{database_id} です。これは最初のメッセージでのみ必須です。
stream_id	string 再開する書き込みストリームの ID。これは最初のメッセージでのみ設定できます。空のままにすると、新しい書き込みストリームが作成されます。
writes[]	Write 適用する書き込み。 常にアトミックかつ順番に実行されます。最初のリクエストでは空にする必要があります。最後のリクエストでは空になることがあります。他のすべてのリクエストで空にすることはできません。
stream_token	bytes 以前にサーバーによって送信されたストリーム トークン。 クライアントはこのフィールドに、受信した最新の WriteResponse のトークンを設定する必要があります。これにより、クライアントがこのトークンまでのレスポンスを受信したことがわかります。このトークンを送信すると、以前のトークンは使用できなくなります。 未確認のレスポンスが多すぎると、サーバーがストリームを終了することがあります。 新しい配信を作成する場合は、この項目を未設定のままにしてください。特定の時点でストリームを再開するには、このフィールドと stream_id フィールドを設定します。 新しい配信を作成する場合は、この項目を未設定のままにしてください。
labels	map<string, string> この書き込みリクエストに関連付けられているラベル。

WriteResponse

Firestore.Write に対するレスポンス。

フィールド
stream_id	string ストリームの ID。新しいストリームが作成された最初のメッセージに対してのみ設定されます。
stream_token	bytes ストリーム内のこのレスポンスの位置を表すトークン。クライアントはこれを使用して、この時点でストリームを再開できます。 このフィールドは常に設定されます。
write_results[]	WriteResult 書き込みを適用した結果。 この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。
commit_time	Timestamp commit が発生した時刻。read_time 以上で読み取ると、書き込みの結果が保証されます。

WriteResult

書き込みを適用した結果。

フィールド
update_time	Timestamp 書き込みを適用した後のドキュメントの最終更新時間。delete の後は設定されません。 書き込みによって実際にドキュメントが変更されていない場合は、前回の update_time になります。
transform_results[]	Value 各 DocumentTransform.FieldTransform を同じ順序で適用した結果。