Method: projects.lookup

Looks up entities by key.

HTTP request

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

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,
  "readOptions": {
    object (ReadOptions)
  },
  "keys": [
    {
      object (Key)
    }
  ],
  "propertyMask": {
    object (PropertyMask)
  }
}
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.
readOptions

object (ReadOptions)

The options for this lookup request.
keys[]

object (Key)

Required. Keys of entities to look up.
propertyMask

object (PropertyMask)

The properties to return. Defaults to returning all properties.

If this field is set and an entity has a property not referenced in the mask, it will be absent from [LookupResponse.found.entity.properties][].

The entity's key is always returned.

Response body

The response for Datastore.Lookup.

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

JSON representation 
{
  "found": [
    {
      object (EntityResult)
    }
  ],
  "missing": [
    {
      object (EntityResult)
    }
  ],
  "deferred": [
    {
      object (Key)
    }
  ],
  "transaction": string,
  "readTime": string
}
Fields
found[]

object (EntityResult)

Entities found as ResultType.FULL entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.
missing[]

object (EntityResult)

Entities not found as ResultType.KEY_ONLY entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.
deferred[]

object (Key)

A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.
transaction

string (bytes format)

The identifier of the transaction that was started as part of this projects.lookup request.

Set only when ReadOptions.new_transaction was set in LookupRequest.read_options.

A base64-encoded string.
readTime

string (Timestamp format)

The time at which these entities were read or found missing.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

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.