Method: projects.deployments.getInstallStatus
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ruft den Installationsstatus einer Testbereitstellung ab.
HTTP-Anfrage
GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter |
name |
string
Erforderlich. Der vollständige Ressourcenname der Bereitstellung. Beispiel: projects/my_project/deployments/my_deployment/installStatus.
Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:
gsuiteaddons.deployments.installStatus
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Installationsstatus einer Testbereitstellung.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"name": string,
"installed": boolean
} |
| Felder |
name |
string
Der kanonische vollständige Ressourcenname des Bereitstellungsinstallationsstatus. Beispiel: projects/123/deployments/my_deployment/installStatus.
|
installed |
boolean
"True", wenn die Bereitstellung für den Nutzer installiert ist.
|
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/cloud-platform
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-04-22 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]
