Method: projects.deployments.getInstallStatus
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
テスト デプロイメントのインストール ステータスを取得します。
HTTP リクエスト
GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
| パラメータ |
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 Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-04-22 UTC。
[null,null,["最終更新日 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)."]]
