Method: projects.allocateIds

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

HTTP request

POST https://datastore.googleapis.com/v1/projects/{projectId}:allocateIds

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Required. The ID of the project against which to make the request.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "databaseId": string,
  "keys": [
    {
      object (Key)
    }
  ]
}
Fields
databaseId

string

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.
keys[]

object (Key)

Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.

Response body

The response for Datastore.AllocateIds.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "keys": [
    {
      object (Key)
    }
  ]
}
Fields
keys[]

object (Key)

The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.