Method: projects.deployments.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mencantumkan semua deployment dalam project tertentu.
Permintaan HTTP
GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
parent |
string
Wajib. Nama project tempat deployment akan dibuat. Contoh: projects/my_project.
Otorisasi memerlukan izin IAM berikut pada resource parent yang ditentukan:
gsuiteaddons.deployments.list
|
Parameter kueri
| Parameter |
pageSize |
integer
Jumlah maksimum deployment yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, maksimal 1.000 deployment akan ditampilkan. Nilai maksimum yang mungkin adalah 1.000; nilai di atas 1.000 akan diubah menjadi 1.000.
|
pageToken |
string
Token halaman, diterima dari panggilan deployments.list sebelumnya. Berikan ini untuk mengambil halaman berikutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk deployments.list harus sesuai dengan panggilan yang menyediakan token halaman.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Pesan respons untuk mencantumkan deployment.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"deployments": [
{
object (Deployment)
}
],
"nextPageToken": string
} |
| Kolom |
deployments[] |
object (Deployment)
Daftar deployment untuk project tertentu.
|
nextPageToken |
string
Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.
|
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud-platform
Untuk informasi selengkapnya, lihat Panduan otorisasi.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-04-22 UTC.
[null,null,["Terakhir diperbarui pada 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)."]]
