2026-09-01
▼ ▲ datastore.projects.beginTransaction
Description : Begins a new transaction.
Parameter Order : projectId
Scopes :
HTTP Method : POST
Parameters :
projectId
Type : string
Required : Yes
Description : Required. The ID of the project against which to make the request.
Location : path
Flat Path : v1/projects/{projectId}:beginTransaction
Path : v1/projects/{projectId}:beginTransaction
▼ ▲ datastore.projects.allocateIds
Scopes :
Flat Path : v1/projects/{projectId}:allocateIds
HTTP Method : POST
Description : Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.
Parameters :
projectId
Type : string
Required : Yes
Location : path
Description : Required. The ID of the project against which to make the request.
Parameter Order : projectId
Path : v1/projects/{projectId}:allocateIds
▼ ▲ datastore.projects.rollback
Flat Path : v1/projects/{projectId}:rollback
Description : Rolls back a transaction.
Parameter Order : projectId
HTTP Method : POST
Parameters :
projectId
Description : Required. The ID of the project against which to make the request.
Required : Yes
Location : path
Type : string
Scopes :
Path : v1/projects/{projectId}:rollback
▼ ▲ datastore.projects.runAggregationQuery
HTTP Method : POST
Path : v1/projects/{projectId}:runAggregationQuery
Parameters :
projectId
Location : path
Required : Yes
Description : Required. The ID of the project against which to make the request.
Type : string
Description : Runs an aggregation query.
Flat Path : v1/projects/{projectId}:runAggregationQuery
Scopes :
Parameter Order : projectId
▼ ▲ datastore.projects.import
Parameter Order : projectId
Scopes :
Description : Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.
Flat Path : v1/projects/{projectId}:import
HTTP Method : POST
Parameters :
projectId
Type : string
Location : path
Required : Yes
Description : Required. Project ID against which to make the request.
Path : v1/projects/{projectId}:import
▼ ▲ datastore.projects.reserveIds
Flat Path : v1/projects/{projectId}:reserveIds
Description : Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.
Parameter Order : projectId
HTTP Method : POST
Scopes :
Path : v1/projects/{projectId}:reserveIds
Parameters :
projectId
Location : path
Description : Required. The ID of the project against which to make the request.
Required : Yes
Type : string
▼ ▲ datastore.projects.runQuery
HTTP Method : POST
Scopes :
Flat Path : v1/projects/{projectId}:runQuery
Parameters :
projectId
Type : string
Description : Required. The ID of the project against which to make the request.
Location : path
Required : Yes
Parameter Order : projectId
Path : v1/projects/{projectId}:runQuery
Description : Queries for entities.
▼ ▲ datastore.projects.export
Scopes :
Description : Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
Path : v1/projects/{projectId}:export
Parameter Order : projectId
Parameters :
projectId
Location : path
Required : Yes
Description : Required. Project ID against which to make the request.
Type : string
HTTP Method : POST
Flat Path : v1/projects/{projectId}:export
▼ ▲ datastore.projects.commit
Flat Path : v1/projects/{projectId}:commit
Parameter Order : projectId
Parameters :
projectId
Description : Required. The ID of the project against which to make the request.
Location : path
Required : Yes
Type : string
Scopes :
Path : v1/projects/{projectId}:commit
HTTP Method : POST
Description : Commits a transaction, optionally creating, deleting or modifying some entities.
▼ ▲ datastore.projects.lookup
Parameters :
projectId
Type : string
Description : Required. The ID of the project against which to make the request.
Required : Yes
Location : path
Description : Looks up entities by key.
Flat Path : v1/projects/{projectId}:lookup
Parameter Order : projectId
HTTP Method : POST
Scopes :
Path : v1/projects/{projectId}:lookup
▼ ▲ datastore.projects.operations.get
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/operations/{operationsId}
Path : v1/{+name}
Scopes :
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
HTTP Method : GET
▼ ▲ datastore.projects.operations.cancel
Flat Path : v1/projects/{projectsId}/operations/{operationsId}:cancel
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
Parameter Order : name
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Scopes :
Path : v1/{+name}:cancel
HTTP Method : POST
▼ ▲ datastore.projects.operations.list
Scopes :
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/projects/{projectsId}/operations
Parameters :
filter
Type : string
Location : query
Description : The standard list filter.
pageToken
Description : The standard list page token.
Location : query
Type : string
name
Required : Yes
Type : string
Location : path
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+$
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
pageSize
Type : integer
Location : query
Description : The standard list page size.
Format : int32
Path : v1/{+name}/operations
Parameter Order : name
HTTP Method : GET
▼ ▲ datastore.projects.operations.delete
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource to be deleted.
Scopes :
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
HTTP Method : DELETE
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/projects/{projectsId}/operations/{operationsId}
▼ ▲ datastore.projects.indexes.get
Parameter Order :
Description : Gets an index.
Flat Path : v1/projects/{projectId}/indexes/{indexId}
Path : v1/projects/{projectId}/indexes/{indexId}
HTTP Method : GET
Scopes :
Parameters :
indexId
Type : string
Required : Yes
Location : path
Description : The resource ID of the index to get.
projectId
Required : Yes
Location : path
Description : Project ID against which to make the request.
Type : string
▼ ▲ datastore.projects.indexes.delete
Description : Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.
Parameter Order :
Scopes :
HTTP Method : DELETE
Parameters :
projectId
Required : Yes
Type : string
Description : Project ID against which to make the request.
Location : path
indexId
Location : path
Required : Yes
Description : The resource ID of the index to delete.
Type : string
Path : v1/projects/{projectId}/indexes/{indexId}
Flat Path : v1/projects/{projectId}/indexes/{indexId}
▼ ▲ datastore.projects.indexes.create
Parameters :
projectId
Location : path
Type : string
Required : Yes
Description : Project ID against which to make the request.
Path : v1/projects/{projectId}/indexes
HTTP Method : POST
Scopes :
Flat Path : v1/projects/{projectId}/indexes
Parameter Order : projectId
Description : Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created.
▼ ▲ datastore.projects.indexes.list
Flat Path : v1/projects/{projectId}/indexes
Path : v1/projects/{projectId}/indexes
Scopes :
HTTP Method : GET
Parameter Order : projectId
Description : Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.
Parameters :
filter
Type : string
Location : query
projectId
Type : string
Required : Yes
Location : path
Description : Project ID against which to make the request.
pageSize
Description : The maximum number of items to return. If zero, then all results will be returned.
Type : integer
Format : int32
Location : query
pageToken
Type : string
Location : query
Description : The next_page_token value returned from a previous List request, if any.