Method: projects.deployments.getInstallStatus
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère l'état d'installation d'un déploiement test.
Requête HTTP
GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
name |
string
Obligatoire. Nom complet de la ressource du déploiement. Exemple : projects/my_project/deployments/my_deployment/installStatus
L'autorisation IAM suivante est requise pour la ressource name indiquée :
gsuiteaddons.deployments.installStatus
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
État d'installation d'un déploiement test.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"name": string,
"installed": boolean
} |
| Champs |
name |
string
Nom complet de la ressource canonique correspondant à l'état d'installation du déploiement. Exemple : projects/123/deployments/my_deployment/installStatus
|
installed |
boolean
"True" si le déploiement est installé pour l'utilisateur.
|
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/cloud-platform
Pour en savoir plus, consultez le Guide relatif aux autorisations.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/04/22 (UTC).
[null,null,["Dernière mise à jour le 2025/04/22 (UTC)."],[[["\u003cp\u003eRetrieves the installation status of a specific Google Workspace Add-on deployment.\u003c/p\u003e\n"],["\u003cp\u003eRequires the deployment's full resource name as a path parameter and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response indicating whether the deployment is installed for the user along with the deployment's full resource name.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e scope for access.\u003c/p\u003e\n"]]],["This document details retrieving the installation status of a test deployment. A `GET` request to a specific URL using gRPC Transcoding syntax is made, including a `name` path parameter identifying the deployment. The request body is empty. The response contains a JSON object with the deployment's resource `name` and a boolean `installed` status. Authorization requires an IAM permission (`gsuiteaddons.deployments.installStatus`) and the OAuth scope (`https://www.googleapis.com/auth/cloud-platform`).\n"],null,["# Method: projects.deployments.getInstallStatus\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.InstallStatus.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the install status of a test deployment.\n\n### HTTP request\n\n`GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The full resource name of the deployment. Example: `projects/my_project/deployments/my_deployment/installStatus`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `gsuiteaddons.deployments.installStatus` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nInstall status of a test deployment.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------|\n| ``` { \"name\": string, \"installed\": boolean } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The canonical full resource name of the deployment install status. Example: `projects/123/deployments/my_deployment/installStatus`. |\n| `installed` | `boolean` True if the deployment is installed for the user. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
