Method: projects.databases.documents.beginTransaction
Stay organized with collections
Save and categorize content based on your preferences.
Starts a new transaction.
HTTP request
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:beginTransaction
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
database |
string
Required. The database name. In the format: projects/{projectId}/databases/{databaseId}.
|
Request body
The request body contains data with the following structure:
| Fields |
options |
object (TransactionOptions)
The options for the transaction. Defaults to a read-write transaction.
|
Response body
The response for Firestore.BeginTransaction.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"transaction": string
} |
| Fields |
transaction |
string (bytes format)
The transaction that was started. A base64-encoded string.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-21 UTC.
[null,null,["Last updated 2025-01-21 UTC."],[],[],null,["# Method: projects.databases.documents.beginTransaction\n\nStarts a new transaction.\n\n### HTTP request\n\n`POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:beginTransaction`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-----------------------------------------------------------------------------------------------------|\n| `database` | `string` Required. The database name. In the format: `projects/{projectId}/databases/{databaseId}`. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------|\n| ``` { \"options\": { object (/docs/firestore/reference/rest/v1/TransactionOptions) } } ``` |\n\n| Fields ||\n|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `options` | `object (`[TransactionOptions](/docs/firestore/reference/rest/v1/TransactionOptions)`)` The options for the transaction. Defaults to a read-write transaction. |\n\n### Response body\n\nThe response for [Firestore.BeginTransaction](/docs/firestore/reference/rest/v1/projects.databases.documents/beginTransaction#google.firestore.v1.Firestore.BeginTransaction).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------|\n| ``` { \"transaction\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `transaction` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The transaction that was started. A base64-encoded string. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
