Method: projects.deployments.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
แสดงรายการการทำให้ใช้งานได้ทั้งหมดในโปรเจ็กต์หนึ่งๆ
คำขอ HTTP
GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ |
parent |
string
ต้องระบุ ชื่อโปรเจ็กต์ที่จะสร้างการทำให้ใช้งานได้ ตัวอย่าง: projects/my_project
การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากร parent ที่ระบุ
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 Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ 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)."]]