Configurar o app no SDK do Google Workspace Marketplace

Nesta página, explicamos como usar o SDK do Google Workspace Marketplace para configurar e gerenciar seu app no Google Workspace Marketplace.

Para disponibilizar o app, configure-o no SDK do Marketplace. O SDK do Marketplace é um kit de ferramentas que permite criar e controlar seu app no Marketplace. Você usa o SDK do Marketplace para gerenciar configurações do Marketplace, como:

• Se o app está disponível para uma organização específica do Google Workspace (um app privado) ou para todos os usuários do Marketplace (um app público)
• Os tipos de usuários do Marketplace que podem instalar seu app
• Com quais aplicativos do Google Workspace seu app se integra
• Os escopos do OAuth que seu app exige
• Informações sobre quem criou e mantém o app.

Independente de você publicar o app de forma particular ou pública, é necessário usar o SDK do Marketplace para gerenciar o app no Marketplace.

Ativar o SDK do Marketplace

Se ainda não tiver feito isso, ative o SDK do Marketplace no seu projeto do Google Cloud.

Abra seu projeto do Cloud no console do Google Cloud.

Se ele ainda não estiver aberto, abra o projeto do Google Cloud que você pretende usar para esta amostra:

1. No console do Google Cloud, acesse a página Selecionar um projeto.

   Selecione um projeto do Cloud

2. Selecione o projeto do Google Cloud que você quer usar. Ou clique em Criar projeto e siga as instruções na tela. Se você criar um projeto do Google Cloud, talvez seja necessário ativar o faturamento dele.

Ativar o SDK do Marketplace

Antes de usar as APIs do Google, é necessário ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.

• No console do Google Cloud, ative o SDK do Google Workspace Marketplace.

  Ativar o SDK

Aviso: ative o SDK do Google Workspace Marketplace, não a API. A API do Google Workspace Marketplace é uma ferramenta diferente usada para integração com os serviços de licenciamento e faturamento do Google.

Determinar as configurações de configuração do app

A referência a seguir descreve as configurações disponíveis na página Configuração do app do SDK do Marketplace.

Escolher quem pode ver e instalar seu app

Ao configurar o app, você especifica os usuários que podem acessar o app usando as seguintes configurações:

• Visibilidade do app: se você estiver publicando um app em uma organização do Google Workspace, a página do app pode ser não listada, visível para todos os usuários da organização ou para qualquer pessoa que use o Google Workspace.
• Configurações de instalação: se o app só pode ser instalado por administradores do Google Workspace.

Independente das configurações especificadas na página do app, os usuários que pertencem a uma organização do Google Workspace talvez não consigam descobrir, instalar ou usar seu app com base nas configurações definidas pelos administradores. Os administradores podem afetar a disponibilidade do app das seguintes maneiras:

• Controlar se os usuários podem ver apps no Marketplace e instalar apps em nome dos usuários.
• Usar uma lista de permissões para gerenciar e selecionar apps para a organização. Se você estiver desenvolvendo um app para uma organização que usa listas de permissões, verifique com um administrador como adicionar o app a ela.
• Desativar determinados aplicativos do Google Workspace, como remover o acesso ao Google Chat, aos apps do Google Chat ou a ambos. Nesses casos, os usuários não poderão instalar o app no Marketplace.

Para saber como os administradores gerenciam o acesso ao Marketplace, consulte a documentação de ajuda para administradores do Marketplace.

Configurações de visibilidade do app

Aviso: depois de escolher uma opção de visibilidade e salvar a página Configuração do app, não será possível mudar sua seleção.

A opção Visibilidade do app aparece se você estiver usando uma conta do Google Workspace (criada pela sua organização de trabalho ou escola). Se você estiver usando uma conta pessoal (que termina em "@gmail.com"), só poderá publicar conteúdo publicamente.

• Público: o app pode ser encontrado e instalado por pessoas fora do seu domínio. Se você escolher a visibilidade pública, o Google vai analisar e aprovar os detalhes do app antes da publicação.
• Particular: somente as pessoas no seu domínio podem encontrar e instalar o app.

Se você escolher publicar como Não listado, a página do app não vai aparecer na navegação nem nos resultados da pesquisa. Os usuários só podem acessar a página da loja do app com o URL direto.

Se você quiser limitar os países e as regiões em que o app está disponível, faça isso na seção Distribuição ao criar a página do app na loja.

Configurações de instalação do app

A opção Configurações de instalação determina se os usuários ou administradores do Google Workspace podem instalar seu app na página de detalhes da loja no Marketplace.

Observação: para apps do Google Chat, só é possível selecionar Instalação individual + administrativa, porque as pessoas podem descobrir e instalar apps do Chat diretamente no Google Chat. Para detalhes sobre como a instalação funciona, consulte Como os usuários descobrem e usam apps do Chat.

• Instalação individual ou administrativa (padrão): o app pode ser instalado por usuários individuais ou por administradores para o domínio, a unidade organizacional ou um grupo de usuários. As políticas de domínio de um usuário podem impedir a instalação de um app, mesmo que as instalações individuais estejam ativadas.
• Instalação somente para administradores: o app só pode ser instalado por administradores para o domínio, a unidade organizacional ou um grupo de usuários. O app só aparece nos resultados da pesquisa do Google Workspace Marketplace para administradores e pessoas que não fizeram login na Conta do Google. Escolha essa opção se o app exigir a instalação de domínio.

Configurações comuns de instalação e visibilidade

A tabela a seguir resume algumas das opções de configurações comuns de apps para instalação e visibilidade:

Usuários pretendidos do app	Configuração de visibilidade do app	Configuração Instalação de apps	Quem pode instalar meu app?	Quem pode usar meu app?
Para apps criados para uma organização do Google Workspace
Usuários específicos da sua organização	Privado e Não listado	Instalação pelo usuário/administrador	Se permitido, qualquer pessoa na sua organização que tenha o URL da página do app.	Se permitido, qualquer pessoa na sua organização que tenha o URL da página do app.
Sua organização	Privado	Instalação pelo usuário/administrador	Se permitido, qualquer pessoa na sua organização.	Se permitido, qualquer pessoa na sua organização.
Sua organização	Privado	Somente administradores	Administradores	Usuários que tiveram o app instalado pelo administrador.
Para apps disponíveis para usuários fora de uma organização específica do Google Workspace
Usuários em organizações do Google Workspace	Público	Somente administradores	Administradores	Usuários que tiveram o app instalado pelo administrador.
Todos os usuários do Google Workspace	Público	Instalação pelo usuário/administrador	Qualquer pessoa que usa aplicativos do Google Workspace para uso pessoal. Se permitido, usuários em organizações do Google Workspace.	Qualquer pessoa que usa aplicativos do Google Workspace para uso pessoal. Se permitido, usuários em organizações do Google Workspace.

Identificar como seu app se integra aos aplicativos do Google Workspace

Escolha os serviços do Google Workspace com que o app ou complemento foi desenvolvido para funcionar, como um complemento do Google Workspace ou um app do Google Chat. Escolha pelo menos uma opção. Em alguns casos, é possível incluir várias integrações de apps na página de detalhes do app. Consulte Listar integrações de apps em conjunto.

Dependendo das integrações de apps escolhidas, talvez seja necessário fornecer mais informações e ativar as APIs relevantes no seu projeto do Google Cloud. A tabela a seguir descreve a configuração adicional necessária para cada um:

Complemento do Google Workspace

Para publicar um complemento do Google Workspace, você precisa fornecer o ID de implantação dele.

Para encontrar o ID da implantação no Apps Script, siga estas etapas:

1. Abra o complemento do Google Workspace no editor do Apps Script.
2. Clique em Implantar > Gerenciar implantações.
3. Abaixo do ID da implantação, clique em Copiar.

Para encontrar o ID de implantação de um complemento HTTP, siga estas etapas:

1. Na página "Configuração do app", em "Complemento do Google Workspace", clique em HTTP ou outras implantações > Selecionar implantação.
2. Selecione a implantação que você quer publicar.
3. Clique em Selecionar.

Observação:se o complemento estender o Google Chat, você também precisará configurar a API Google Chat. Para conferir as etapas, acesse Configurar um app do Chat.

Complemento do Editor (Documentos, Planilhas, Apresentações, Formulários)

Para publicar um complemento do Editor, você precisa fornecer o ID do script do projeto e a versão que quer publicar.

Para encontrar o ID do script do projeto, siga estas etapas:

1. Abra o complemento no editor do Apps Script.
2. À esquerda, clique em Configurações do projeto .
3. Em "IDs", copie o ID do script.

Para encontrar a versão, siga estas etapas:

1. Abra o complemento no editor do Apps Script.
2. No canto superior direito, clique em Implantar > Gerenciar implantações.
3. O número da versão está em "Configuração".

App Google Chat

Para publicar um app interativo do Google Chat, consulte a seguinte documentação:

• Se você criou seu app do Chat como um complemento, configure as configurações do complemento na API Chat. Para conferir as etapas, consulte Configurar um app do Chat na documentação do complemento do Google Workspace.
• Se você criou seu app do Chat usando eventos de interação, configure as configurações de eventos de interação na API Chat. Para saber as etapas, consulte Receber e responder a eventos de interação na documentação da API Chat.
• Se você criou seu app de chat com a configuração automática do AppSheet, publique o app de chat seguindo as etapas descritas na documentação do AppSheet, Compartilhe seu app de chat usando a configuração automática.

Aplicativo do Google Drive

Para publicar um app do Drive, é necessário ativar e configurar a API Google Drive.

App da Web

Para publicar um web app, você precisa fornecer o URL de navegação universal, que aponta para o web app no menu de apps do Google . Seu web app precisa estar em produção e totalmente funcional.

Ao preencher a página "Detalhes do app", você precisa fornecer ícones adicionais com dimensões de 96x96 e 48x48 pixels.

Se você criou o app da Web no Apps Script, siga estas etapas para acessar o URL de navegação universal:

1. Abra o complemento do Google Workspace no editor do Apps Script.
2. Clique em Implantar > Nova implantação.
3. Em "Selecionar tipo", clique em App da Web.
4. Preencha as opções e clique em Implantar.
5. Clique em Copiar.

Especifique o nível de acesso que seu app exige

Em Escopos do OAuth, forneça uma lista completa dos escopos do OAuth 2.0 que seu app exige. Os escopos do OAuth inseridos aqui precisam corresponder ao que você mostra na tela de permissão do OAuth e, se aplicável, no manifesto do Apps Script.

Se você incluir mais de uma integração de app, adicione os escopos de cada uma à página "Configuração do app" do SDK do Marketplace e à tela de consentimento do OAuth.

Sempre use os escopos mais restritos possíveis. Por exemplo, não inclua um escopo completo do Drive se você só precisar de um escopo somente leitura.

Para projetos do Apps Script, consulte Escopos de autorização para mais detalhes.

Fornecer informações sobre o desenvolvedor do app

Em Informações do desenvolvedor, preencha os dados de contato e outros detalhes. Esses campos aparecem na página Detalhes do app.

Campos
Status do negociante	Devido às leis de proteção ao consumidor, os consumidores residentes no Espaço Econômico Europeu (EEE) precisam ser informados se um comerciante no Marketplace é um negociante ou um não negociante: Negociante: um negociante é uma pessoa que atua para fins relacionados a um comércio, negócio, ofício ou profissão; ou em nome ou em representação de um negociante. Não negociante: um não negociante (consumidor) é uma pessoa que atua para fins não profissionais. Se não for especificado, "Status do trader não especificado" vai aparecer na página Detalhes do app.
Nome do desenvolvedor	O nome a ser exibido como o autor do app. Se você for um comerciante, informe seu nome comercial ou razão social.
Endereço de correspondência do desenvolvedor	Obrigatório para traders. Não coletado para não comerciantes. O local da sua empresa. Insira um endereço de correspondência válido para contato.
URL do site do desenvolvedor	O site que descreve você (ou sua organização) como o desenvolvedor.
E-mail do desenvolvedor	O endereço de e-mail a ser usado como ponto de contato. Ele não está incluído na página Detalhes do app. Mantenha esse endereço de e-mail atualizado, porque ele é usado: Se o Google precisar entrar em contato com o desenvolvedor, por exemplo, durante o processo de análise do app. Para enviar feedback dos complementos do Editor se um URL de "Informar um problema" não for fornecido na página "Detalhes do app".
URL do site do aplicativo	Opcional. O site que descreve melhor seu app.

Salvar as configurações de configuração do app no SDK do Marketplace

Usando as informações da seção anterior, salve a configuração do app no SDK do Marketplace:

1. No console do Google Cloud, acesse a página Configuração do app do SDK do Marketplace:

   Acessar a página de configuração do SDK do Marketplace

2. Preencha cada seção com base no que você determinou na seção anterior.

3. Clique em Salvar rascunho.

4. (Opcional) Você pode receber análises sobre o uso de apps no Google Analytics. Para fazer isso, adicione um ID do Google Analytics ao SDK do Marketplace.

   1. Acesse a guia Analytics.
   2. Insira seu ID do Google Analytics.
   3. Clique em Salvar.

Resolver problemas

Esta seção descreve problemas comuns que você pode encontrar.

Permissões necessárias ausentes ao publicar apps no Marketplace

Não é possível publicar apps no Marketplace porque as tentativas de configurar o aplicativo na página "Configuração do app" do SDK do Marketplace falham com a seguinte mensagem de erro:

You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update

Esse erro ocorre quando a API SDK do Marketplace está ativada e quando você usa uma função do IAM diferente de Editor ou Owner.

Para resolver o erro, implemente uma das seguintes soluções:

• Peça ao proprietário do projeto para atribuir o papel roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin à conta com as permissões ausentes para que ela possa configurar e gerenciar o app no SDK do Marketplace.

• Peça ao proprietário do projeto para adicionar as permissões ausentes a um papel personalizado na página IAM e administrador > Papéis no console do Google Cloud. Em seguida, atribua o papel personalizado à conta com as permissões ausentes.

• A primitiva roles/editor ou roles/owner pode ser usada para publicar apps. No entanto, a documentação Usar o IAM com segurança considera essa prática inadequada, já que não é fácil restringir o acesso de edição a outros recursos no projeto.