Method: projects.deployments.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Elenca tutti i deployment in un determinato progetto.
Richiesta HTTP
GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
| Parametri |
parent |
string
Obbligatorio. Nome del progetto in cui creare il deployment. Esempio: projects/my_project.
L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata parent:
gsuiteaddons.deployments.list
|
Parametri di query
| Parametri |
pageSize |
integer
Il numero massimo di implementazioni da restituire. Il servizio potrebbe restituire meno di questo valore. Se non specificato, vengono restituiti al massimo 1000 implementazioni. Il valore massimo possibile è 1000; i valori superiori a 1000 vengono modificati in 1000.
|
pageToken |
string
Un token di pagina ricevuto da una chiamata deployments.list precedente. Fornisci questo valore per recuperare la pagina successiva. Quando viene applicata la paginazione, tutti gli altri parametri forniti a deployments.list devono corrispondere alla chiamata che ha fornito il token pagina.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Messaggio di risposta per elencare i deployment.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
| Rappresentazione JSON |
{
"deployments": [
{
object (Deployment)
}
],
"nextPageToken": string
} |
| Campi |
deployments[] |
object (Deployment)
L'elenco dei deployment per il progetto specificato.
|
nextPageToken |
string
Un token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.
|
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/cloud-platform
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-04-22 UTC.
[null,null,["Ultimo aggiornamento 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)."]]
