Method: projects.deployments.list
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
HTTP 요청
GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments
URL은 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
자세한 내용은 승인 가이드를 참고하세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2025-04-22(UTC)
[null,null,["최종 업데이트: 2025-04-22(UTC)"],[[["\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)."]]
