Game Services API

Deploy and manage infrastructure for global multiplayer gaming experiences.

Service: gameservices.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://gameservices.googleapis.com

REST Resource: v1beta.projects.locations

Methods
get GET /v1beta/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.projects.locations.gameServerDeployments

Methods
create POST /v1beta/{parent=projects/*/locations/*}/gameServerDeployments
Creates a new game server deployment in a given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/gameServerDeployments/*}
Deletes a single game server deployment.
fetchDeploymentState POST /v1beta/{name=projects/*/locations/*/gameServerDeployments/*}:fetchDeploymentState
Retrieves information about the current state of the game server deployment.
get GET /v1beta/{name=projects/*/locations/*/gameServerDeployments/*}
Gets details of a single game server deployment.
getIamPolicy GET /v1beta/{resource=projects/*/locations/*/gameServerDeployments/*}:getIamPolicy
Gets the access control policy for a resource.
getRollout GET /v1beta/{name=projects/*/locations/*/gameServerDeployments/*}/rollout
Gets details a single game server deployment rollout.
list GET /v1beta/{parent=projects/*/locations/*}/gameServerDeployments
Lists game server deployments in a given project and location.
patch PATCH /v1beta/{gameServerDeployment.name=projects/*/locations/*/gameServerDeployments/*}
Patches a game server deployment.
previewRollout PATCH /v1beta/{rollout.name=projects/*/locations/*/gameServerDeployments/*}/rollout:preview
Previews the game server deployment rollout.
setIamPolicy POST /v1beta/{resource=projects/*/locations/*/gameServerDeployments/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1beta/{resource=projects/*/locations/*/gameServerDeployments/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updateRollout PATCH /v1beta/{rollout.name=projects/*/locations/*/gameServerDeployments/*}/rollout
Patches a single game server deployment rollout.

REST Resource: v1beta.projects.locations.gameServerDeployments.configs

Methods
create POST /v1beta/{parent=projects/*/locations/*/gameServerDeployments/*}/configs
Creates a new game server config in a given project, location, and game server deployment.
delete DELETE /v1beta/{name=projects/*/locations/*/gameServerDeployments/*/configs/*}
Deletes a single game server config.
get GET /v1beta/{name=projects/*/locations/*/gameServerDeployments/*/configs/*}
Gets details of a single game server config.
list GET /v1beta/{parent=projects/*/locations/*/gameServerDeployments/*}/configs
Lists game server configs in a given project, location, and game server deployment.

REST Resource: v1beta.projects.locations.operations

Methods
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1beta.projects.locations.realms

Methods
create POST /v1beta/{parent=projects/*/locations/*}/realms
Creates a new realm in a given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/realms/*}
Deletes a single realm.
get GET /v1beta/{name=projects/*/locations/*/realms/*}
Gets details of a single realm.
list GET /v1beta/{parent=projects/*/locations/*}/realms
Lists realms in a given project and location.
patch PATCH /v1beta/{realm.name=projects/*/locations/*/realms/*}
Patches a single realm.
previewUpdate PATCH /v1beta/{realm.name=projects/*/locations/*/realms/*}:previewUpdate
Previews patches to a single realm.

REST Resource: v1beta.projects.locations.realms.gameServerClusters

Methods
create POST /v1beta/{parent=projects/*/locations/*/realms/*}/gameServerClusters
Creates a new game server cluster in a given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/realms/*/gameServerClusters/*}
Deletes a single game server cluster.
get GET /v1beta/{name=projects/*/locations/*/realms/*/gameServerClusters/*}
Gets details of a single game server cluster.
list GET /v1beta/{parent=projects/*/locations/*/realms/*}/gameServerClusters
Lists game server clusters in a given project and location.
patch PATCH /v1beta/{gameServerCluster.name=projects/*/locations/*/realms/*/gameServerClusters/*}
Patches a single game server cluster.
previewCreate POST /v1beta/{parent=projects/*/locations/*/realms/*}/gameServerClusters:previewCreate
Previews creation of a new game server cluster in a given project and location.
previewDelete DELETE /v1beta/{name=projects/*/locations/*/realms/*/gameServerClusters/*}:previewDelete
Previews deletion of a single game server cluster.
previewUpdate PATCH /v1beta/{gameServerCluster.name=projects/*/locations/*/realms/*/gameServerClusters/*}:previewUpdate
Previews updating a GameServerCluster.

Service: gameservices.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://gameservices.googleapis.com

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.gameServerDeployments

Methods
create POST /v1/{parent=projects/*/locations/*}/gameServerDeployments
Creates a new game server deployment in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/gameServerDeployments/*}
Deletes a single game server deployment.
fetchDeploymentState POST /v1/{name=projects/*/locations/*/gameServerDeployments/*}:fetchDeploymentState
Retrieves information about the current state of the game server deployment.
get GET /v1/{name=projects/*/locations/*/gameServerDeployments/*}
Gets details of a single game server deployment.
getIamPolicy GET /v1/{resource=projects/*/locations/*/gameServerDeployments/*}:getIamPolicy
Gets the access control policy for a resource.
getRollout GET /v1/{name=projects/*/locations/*/gameServerDeployments/*}/rollout
Gets details a single game server deployment rollout.
list GET /v1/{parent=projects/*/locations/*}/gameServerDeployments
Lists game server deployments in a given project and location.
patch PATCH /v1/{gameServerDeployment.name=projects/*/locations/*/gameServerDeployments/*}
Patches a game server deployment.
previewRollout PATCH /v1/{rollout.name=projects/*/locations/*/gameServerDeployments/*}/rollout:preview
Previews the game server deployment rollout.
setIamPolicy POST /v1/{resource=projects/*/locations/*/gameServerDeployments/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/gameServerDeployments/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updateRollout PATCH /v1/{rollout.name=projects/*/locations/*/gameServerDeployments/*}/rollout
Patches a single game server deployment rollout.

REST Resource: v1.projects.locations.gameServerDeployments.configs

Methods
create POST /v1/{parent=projects/*/locations/*/gameServerDeployments/*}/configs
Creates a new game server config in a given project, location, and game server deployment.
delete DELETE /v1/{name=projects/*/locations/*/gameServerDeployments/*/configs/*}
Deletes a single game server config.
get GET /v1/{name=projects/*/locations/*/gameServerDeployments/*/configs/*}
Gets details of a single game server config.
list GET /v1/{parent=projects/*/locations/*/gameServerDeployments/*}/configs
Lists game server configs in a given project, location, and game server deployment.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.realms

Methods
create POST /v1/{parent=projects/*/locations/*}/realms
Creates a new realm in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/realms/*}
Deletes a single realm.
get GET /v1/{name=projects/*/locations/*/realms/*}
Gets details of a single realm.
list GET /v1/{parent=projects/*/locations/*}/realms
Lists realms in a given project and location.
patch PATCH /v1/{realm.name=projects/*/locations/*/realms/*}
Patches a single realm.
previewUpdate PATCH /v1/{realm.name=projects/*/locations/*/realms/*}:previewUpdate
Previews patches to a single realm.

REST Resource: v1.projects.locations.realms.gameServerClusters

Methods
create POST /v1/{parent=projects/*/locations/*/realms/*}/gameServerClusters
Creates a new game server cluster in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/realms/*/gameServerClusters/*}
Deletes a single game server cluster.
get GET /v1/{name=projects/*/locations/*/realms/*/gameServerClusters/*}
Gets details of a single game server cluster.
list GET /v1/{parent=projects/*/locations/*/realms/*}/gameServerClusters
Lists game server clusters in a given project and location.
patch PATCH /v1/{gameServerCluster.name=projects/*/locations/*/realms/*/gameServerClusters/*}
Patches a single game server cluster.
previewCreate POST /v1/{parent=projects/*/locations/*/realms/*}/gameServerClusters:previewCreate
Previews creation of a new game server cluster in a given project and location.
previewDelete DELETE /v1/{name=projects/*/locations/*/realms/*/gameServerClusters/*}:previewDelete
Previews deletion of a single game server cluster.
previewUpdate PATCH /v1/{gameServerCluster.name=projects/*/locations/*/realms/*/gameServerClusters/*}:previewUpdate
Previews updating a GameServerCluster.