Google Workspace add-ons API
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Serviço: gsuiteaddons.googleapis.com
Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.
Documento de descoberta
Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de detecção:
Endpoint de serviço
Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:
https://gsuiteaddons.googleapis.com
| Métodos |
getAuthorization |
de GET /v1/{name=projects/*/authorization}
Recebe as informações de autorização para implantações em um determinado projeto. |
| Métodos |
create |
de POST /v1/{parent=projects/*}/deployments
Cria uma implantação com o nome e a configuração especificados. |
delete |
de DELETE /v1/{name=projects/*/deployments/*}
Exclui a implantação com o nome fornecido. |
get |
de GET /v1/{name=projects/*/deployments/*}
Recebe a implantação com o nome especificado. |
getInstallStatus |
de GET /v1/{name=projects/*/deployments/*/installStatus}
Recebe o status da instalação de uma implantação de teste. |
install |
de POST /v1/{name=projects/*/deployments/*}:install
Instala uma implantação na sua conta para teste. |
list |
de GET /v1/{parent=projects/*}/deployments
Lista todas as implantações em um projeto específico. |
replaceDeployment |
de PUT /v1/{deployment.name=projects/*/deployments/*}
Cria ou substitui uma implantação com o nome especificado. |
uninstall |
de POST /v1/{name=projects/*/deployments/*}:uninstall
Desinstala uma implantação de teste da conta do usuário. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eThis service, \u003ccode\u003egsuiteaddons.googleapis.com\u003c/code\u003e, provides REST APIs for managing Google Workspace Add-ons deployments.\u003c/p\u003e\n"],["\u003cp\u003eYou can use Google-provided client libraries or your own libraries with the provided discovery document and service endpoint information to interact with the APIs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.projects\u003c/code\u003e resource allows you to retrieve authorization details for add-on deployments in a project.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.projects.deployments\u003c/code\u003e resource offers methods to create, delete, retrieve, install, list, replace, and uninstall add-on deployments.\u003c/p\u003e\n"],["\u003cp\u003eUse the service endpoint \u003ccode\u003ehttps://gsuiteaddons.googleapis.com\u003c/code\u003e as the base URL for all API requests.\u003c/p\u003e\n"]]],["The `gsuiteaddons.googleapis.com` service provides REST resources for managing projects and their deployments. Key actions for `v1.projects.deployments` include creating, deleting, getting, listing, and replacing deployments, and getting the install status. Additionally, deployments can be installed or uninstalled. The `v1.projects` resource supports retrieving authorization information for deployments. The API utilizes a base URL `https://gsuiteaddons.googleapis.com` and offers a Discovery Document for machine-readable specifications.\n"],null,["# Google Workspace add-ons API\n\n- [REST Resource: v1.projects](#v1.projects)\n- [REST Resource: v1.projects.deployments](#v1.projects.deployments)\n\nService: gsuiteaddons.googleapis.com\n------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://gsuiteaddons.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://gsuiteaddons.googleapis.com`\n\nREST Resource: [v1.projects](/workspace/add-ons/reference/rest/v1/projects)\n---------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [getAuthorization](/workspace/add-ons/reference/rest/v1/projects/getAuthorization) | `GET /v1/{name=projects/*/authorization}` Gets the authorization information for deployments in a given project. |\n\nREST Resource: [v1.projects.deployments](/workspace/add-ons/reference/rest/v1/projects.deployments)\n---------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/add-ons/reference/rest/v1/projects.deployments/create) | `POST /v1/{parent=projects/*}/deployments` Creates a deployment with the specified name and configuration. |\n| [delete](/workspace/add-ons/reference/rest/v1/projects.deployments/delete) | `DELETE /v1/{name=projects/*/deployments/*}` Deletes the deployment with the given name. |\n| [get](/workspace/add-ons/reference/rest/v1/projects.deployments/get) | `GET /v1/{name=projects/*/deployments/*}` Gets the deployment with the specified name. |\n| [getInstallStatus](/workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus) | `GET /v1/{name=projects/*/deployments/*/installStatus}` Gets the install status of a test deployment. |\n| [install](/workspace/add-ons/reference/rest/v1/projects.deployments/install) | `POST /v1/{name=projects/*/deployments/*}:install` Installs a deployment to your account for testing. |\n| [list](/workspace/add-ons/reference/rest/v1/projects.deployments/list) | `GET /v1/{parent=projects/*}/deployments` Lists all deployments in a particular project. |\n| [replaceDeployment](/workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment) | `PUT /v1/{deployment.name=projects/*/deployments/*}` Creates or replaces a deployment with the specified name. |\n| [uninstall](/workspace/add-ons/reference/rest/v1/projects.deployments/uninstall) | `POST /v1/{name=projects/*/deployments/*}:uninstall` Uninstalls a test deployment from the user's account. |"]]
