GCP Cloud Datastore (version v1.*.*)

allocate_ids#

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

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.AllocateIds.

Type: object

{
  "keys" : [ {
    "path" : [ {
      "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
      "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
      "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
    } ],
    "partitionId" : {
      "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
      "projectId" : "The ID of the project to which the entities belong."
    }
  } ]
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

begin_transaction#

Begins a new transaction.

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.BeginTransaction.

Type: object

{
  "transactionOptions" : {
    "readWrite" : {
      "previousTransaction" : "The transaction identifier of the transaction being retried."
    },
    "readOnly" : { }
  }
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

cancel_operation#

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.

Parameters

name (required)#

The name of the operation resource to be cancelled.

Type: string

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

commit_transaction#

Commits a transaction, optionally creating, deleting or modifying some
entities.

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.Commit.

Type: object

{
  "mode" : "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
  "mutations" : [ {
    "baseVersion" : "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
    "upsert" : {
      "key" : {
        "path" : [ {
          "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
          "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
          "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
        } ],
        "partitionId" : {
          "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
          "projectId" : "The ID of the project to which the entities belong."
        }
      },
      "properties" : "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`."
    },
    "insert" : {
      "key" : {
        "path" : [ {
          "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
          "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
          "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
        } ],
        "partitionId" : {
          "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
          "projectId" : "The ID of the project to which the entities belong."
        }
      },
      "properties" : "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`."
    },
    "update" : {
      "key" : {
        "path" : [ {
          "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
          "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
          "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
        } ],
        "partitionId" : {
          "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
          "projectId" : "The ID of the project to which the entities belong."
        }
      },
      "properties" : "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`."
    },
    "delete" : {
      "path" : [ {
        "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
        "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
        "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
      } ],
      "partitionId" : {
        "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
        "projectId" : "The ID of the project to which the entities belong."
      }
    }
  } ],
  "transaction" : "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction."
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

delete_operation#

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.

Parameters

name (required)#

The name of the operation resource to be deleted.

Type: string

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

export#

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.

Parameters

projectId (required)#

Project ID against which to make the request.

Type: string

$body#

The request for
google.datastore.admin.v1.DatastoreAdmin.ExportEntities.

Type: object

{
  "entityFilter" : {
    "namespaceIds" : [ "string" ],
    "kinds" : [ "string" ]
  },
  "outputUrlPrefix" : "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url field. That\nvalue should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
  "labels" : "Client-assigned labels."
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_index#

Gets an index.

Parameters

indexId (required)#

The resource ID of the index to get.

Type: string

projectId (required)#

Project ID against which to make the request.

Type: string

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_operation_state#

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.

Parameters

name (required)#

The name of the operation resource.

Type: string

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

import#

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.

Parameters

projectId (required)#

Project ID against which to make the request.

Type: string

$body#

The request for
google.datastore.admin.v1.DatastoreAdmin.ImportEntities.

Type: object

{
  "entityFilter" : {
    "namespaceIds" : [ "string" ],
    "kinds" : [ "string" ]
  },
  "inputUrl" : "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url.",
  "labels" : "Client-assigned labels."
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_indexes#

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

projectId (required)#

Project ID against which to make the request.

Type: string

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_operations#

Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.

Parameters

name (required)#

The name of the operation's parent resource.

Type: string

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

filter#

The standard list filter.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

lookup#

Looks up entities by key.

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.Lookup.

Type: object

{
  "keys" : [ {
    "path" : [ {
      "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
      "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
      "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
    } ],
    "partitionId" : {
      "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
      "projectId" : "The ID of the project to which the entities belong."
    }
  } ],
  "readOptions" : {
    "readConsistency" : "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
    "transaction" : "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction."
  }
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

reserve_ids#

Prevents the supplied keys' IDs from being auto-allocated by Cloud
Datastore.

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.ReserveIds.

Type: object

{
  "keys" : [ {
    "path" : [ {
      "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
      "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
      "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
    } ],
    "partitionId" : {
      "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
      "projectId" : "The ID of the project to which the entities belong."
    }
  } ],
  "databaseId" : "If not empty, the ID of the database against which to make the request."
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

rollback_transaction#

Rolls back a transaction.

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.Rollback.

Type: object

{
  "transaction" : "The transaction identifier, returned by a call to\nDatastore.BeginTransaction."
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string

run_query#

Queries for entities.

Parameters

projectId (required)#

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

Type: string

$body#

The request for Datastore.RunQuery.

Type: object

{
  "partitionId" : {
    "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
    "projectId" : "The ID of the project to which the entities belong."
  },
  "gqlQuery" : {
    "namedBindings" : "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.",
    "allowLiterals" : "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
    "positionalBindings" : [ {
      "cursor" : "A query cursor. Query cursors are returned in query\nresult batches.",
      "value" : {
        "keyValue" : {
          "path" : [ {
            "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
            "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
            "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
          } ],
          "partitionId" : {
            "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
            "projectId" : "The ID of the project to which the entities belong."
          }
        },
        "timestampValue" : "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
        "geoPointValue" : {
          "latitude" : "The latitude in degrees. It must be in the range [-90.0, +90.0].",
          "longitude" : "The longitude in degrees. It must be in the range [-180.0, +180.0]."
        },
        "arrayValue" : {
          "values" : [ "Value" ]
        },
        "doubleValue" : "A double value.",
        "nullValue" : "A null value.",
        "stringValue" : "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
        "entityValue" : {
          "key" : {
            "path" : [ {
              "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
              "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
              "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
            } ],
            "partitionId" : {
              "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
              "projectId" : "The ID of the project to which the entities belong."
            }
          },
          "properties" : "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`."
        },
        "meaning" : "The `meaning` field should only be populated for backwards compatibility.",
        "booleanValue" : "A boolean value.",
        "integerValue" : "An integer value.",
        "excludeFromIndexes" : "If the value should be excluded from all indexes including those defined\nexplicitly.",
        "blobValue" : "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded."
      }
    } ],
    "queryString" : "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference)."
  },
  "query" : {
    "filter" : {
      "compositeFilter" : {
        "op" : "The operator for combining multiple filters.",
        "filters" : [ "Filter" ]
      },
      "propertyFilter" : {
        "op" : "The operator to filter by.",
        "property" : {
          "name" : "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path."
        },
        "value" : {
          "keyValue" : {
            "path" : [ {
              "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
              "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
              "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
            } ],
            "partitionId" : {
              "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
              "projectId" : "The ID of the project to which the entities belong."
            }
          },
          "timestampValue" : "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
          "geoPointValue" : {
            "latitude" : "The latitude in degrees. It must be in the range [-90.0, +90.0].",
            "longitude" : "The longitude in degrees. It must be in the range [-180.0, +180.0]."
          },
          "arrayValue" : {
            "values" : [ "Value" ]
          },
          "doubleValue" : "A double value.",
          "nullValue" : "A null value.",
          "stringValue" : "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
          "entityValue" : {
            "key" : {
              "path" : [ {
                "kind" : "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
                "name" : "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
                "id" : "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future."
              } ],
              "partitionId" : {
                "namespaceId" : "If not empty, the ID of the namespace to which the entities belong.",
                "projectId" : "The ID of the project to which the entities belong."
              }
            },
            "properties" : "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`."
          },
          "meaning" : "The `meaning` field should only be populated for backwards compatibility.",
          "booleanValue" : "A boolean value.",
          "integerValue" : "An integer value.",
          "excludeFromIndexes" : "If the value should be excluded from all indexes including those defined\nexplicitly.",
          "blobValue" : "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded."
        }
      }
    },
    "offset" : "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be &gt;= 0 if specified.",
    "kind" : [ {
      "name" : "The name of the kind."
    } ],
    "limit" : "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be &gt;= 0 if specified.",
    "endCursor" : "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same\nquery](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
    "projection" : [ {
      "property" : {
        "name" : "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path."
      }
    } ],
    "startCursor" : "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same\nquery](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
    "distinctOn" : [ {
      "name" : "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path."
    } ],
    "order" : [ {
      "property" : {
        "name" : "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path."
      },
      "direction" : "The direction to order by. Defaults to `ASCENDING`."
    } ]
  },
  "readOptions" : {
    "readConsistency" : "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
    "transaction" : "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction."
  }
}

access_token#

OAuth access token.

Type: string

alt#

Data format for response.

Type: string

Potential values: json, media, proto

callback#

JSONP

Type: string

fields#

Selector specifying which fields to include in a partial response.

Type: string

key#

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token#

OAuth 2.0 token for the current user.

Type: string

prettyPrint#

Returns response with indentations and line breaks.

Type: boolean

quotaUser#

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType#

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol#

Upload protocol for media (e.g. "raw", "multipart").

Type: string