Method: projects.deployments.getInstallStatus
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP 请求
GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}
网址采用 gRPC 转码语法。
路径参数
参数 |
name |
string
必需。部署的完整资源名称。 示例:projects/my_project/deployments/my_deployment/installStatus 。
必须对指定的资源 name 具有以下 IAM 权限才能进行授权:
gsuiteaddons.deployments.installStatus
|
响应正文
测试部署的安装状态。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
{
"name": string,
"installed": boolean
} |
字段 |
name |
string
部署安装状态的规范化完整资源名称。 示例:projects/123/deployments/my_deployment/installStatus 。
|
installed |
boolean
如果已为用户安装该部署,则为 true。
|
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/cloud-platform
有关详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-04-22。
[null,null,["最后更新时间 (UTC):2025-04-22。"],[[["\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)."]]