Method: projects.deployments.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP 请求
GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments
网址采用 gRPC 转码语法。
路径参数
| 参数 |
parent |
string
必需。要创建部署的项目的名称。 示例：projects/my_project。
必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：
gsuiteaddons.deployments.list
|
查询参数
| 参数 |
pageSize |
integer
要返回的部署数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 1,000 个部署。可能的最大值为 1,000；大于 1,000 的值会更改为 1,000。
|
pageToken |
string
从之前的 deployments.list 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 deployments.list 的所有其他参数必须与提供页面令牌的调用匹配。
|
响应正文
用于列出部署的响应消息。
如果成功，响应正文将包含结构如下的数据：
| JSON 表示法 |
{
"deployments": [
{
object (Deployment)
}
],
"nextPageToken": string
} |
| 字段 |
deployments[] |
object (Deployment)
给定项目的部署列表。
|
nextPageToken |
string
可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
|
授权范围
需要以下 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\u003eLists all deployments within a specified Google Workspace Add-ons project.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of deployments.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003egsuiteaddons.deployments.list\u003c/code\u003e IAM permission and \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of deployments along with a token for accessing subsequent pages, if available.\u003c/p\u003e\n"]]],["This describes how to list deployments within a project using an HTTP GET request. The request URL structure is `https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments`, where `parent` specifies the project. Optional query parameters `pageSize` (max 1,000) and `pageToken` allow pagination. The request body must be empty. The successful response contains a list of `deployments` and a `nextPageToken` for subsequent pages, structured in JSON. Authorization requires the `gsuiteaddons.deployments.list` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope.\n"],null,["# Method: projects.deployments.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDeploymentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all deployments in a particular project.\n\n### HTTP request\n\n`GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Name of the project in which to create the deployment. Example: `projects/my_project`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `gsuiteaddons.deployments.list` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of deployments to return. The service might return fewer than this value. If unspecified, at most 1,000 deployments are returned. The maximum possible value is 1,000; values above 1,000 are changed to 1,000. |\n| `pageToken` | `string` A page token, received from a previous `deployments.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `deployments.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message to list deployments.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deployments\": [ { object (/workspace/add-ons/reference/rest/v1/projects.deployments#Deployment) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deployments[]` | `object (`[Deployment](/workspace/add-ons/reference/rest/v1/projects.deployments#Deployment)`)` The list of deployments for the given project. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\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)."]]
