Configurar o app no SDK do Google Workspace Marketplace

Esta página explica como usar o SDK do Google Workspace Marketplace para configurar e gerenciar seu app no Google Workspace Marketplace.

Para disponibilizar o app, você precisa configurá-lo no SDK do Marketplace. O SDK do Marketplace é um kit de ferramentas que permite criar e controlar seu app no Google Workspace Marketplace. Use o SDK do Marketplace para gerenciar as 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
  • Quais apps do Google Workspace seu app integra
  • Os escopos do OAuth necessários para o app
  • Informações sobre quem criou e mantém o app

Independente de você estar publicando seu 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

Ative o SDK do Google Workspace Marketplace no seu projeto do Google Cloud, caso ainda não tenha feito isso.

Abra seu projeto do Cloud no console do Google Cloud

Se ainda não estiver aberto, abra o projeto do Cloud que você pretende usar para este exemplo:

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

    Selecionar 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 Google Workspace Marketplace

Antes de usar as APIs do Google, você precisa 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

Determinar as configurações 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 acessar e instalar seu app

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

  • Visibilidade do app: se você estiver publicando um app em uma organização do Google Workspace, verifique se a listagem do app está desativada, 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.

Independentemente das configurações especificadas na página de detalhes do app, os usuários que pertencem a uma organização do Google Workspace talvez não consigam encontrar, instalar ou usar o 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 acessar apps no Marketplace e instalar apps em nome deles.
  • Use 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 à lista.
  • Desative determinados aplicativos do Google Workspace, como remover o acesso ao Google Chat, aos apps do Google Chat ou 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

A opção Visibilidade do app aparece se você estiver usando uma conta do Google Workspace, criada pela sua organização escolar ou de trabalho. Se você estiver usando uma conta de consumidor (uma conta que termina em "@gmail.com"), só será possível publicar 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 a página "Detalhes do app" antes da publicação.
  • Particular: somente as pessoas no seu domínio podem encontrar e instalar o app.

Se você optar por publicar como Não listado, a listagem do app não será mostrada 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, configure essa opção na seção Distribuição ao criar a página da 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 o app na página de informações da loja no Google Workspace Marketplace.

  • Instalação individual ou administrativa (padrão): o app pode ser instalado por usuários individuais ou administradores do domínio, da unidade organizacional ou de 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 do domínio, da unidade organizacional ou de um grupo de usuários. Seu app só aparece nos resultados da pesquisa do Google Workspace Marketplace para administradores e pessoas que não estão logadas 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 comuns de configuração de apps para instalação e visibilidade:

Usuários pretendidos do app Configuração 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 de detalhes do app. Se permitido, qualquer pessoa na sua organização que tenha o URL da página de detalhes 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 para administradores Administradores Usuários que instalaram o app 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 instalaram o app pelo administrador.
Todos os usuários do Google Workspace Público Instalação pelo usuário/administrador
  • Qualquer pessoa que use os aplicativos do Google Workspace para uso pessoal.
  • Se permitido, usuários em organizações do Google Workspace.
  • Qualquer pessoa que use os 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 para os quais o app ou o complemento foi desenvolvido, como um complemento do Google Workspace ou um app do Google Chat. É necessário escolher pelo menos uma opção. Em alguns casos, é possível incluir várias integrações de apps na página de detalhes. 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 APIs relevantes no seu projeto do Google Cloud. A tabela a seguir descreve a configuração adicional necessária para cada um deles:

Complemento do Google Workspace (Apps Script)

Para publicar um complemento do Google Workspace, você precisa fornecer o ID de implantação do complemento. Para encontrar o ID da implantação, siga estas etapas:

  1. Abra o complemento do Google Workspace no editor do Apps Script.
  2. Clique em Deploy > Manage deployments.
  3. Em "ID da implantação", clique em Copiar.

Complemento do Google Workspace (implantações HTTP)

Se você criou o complemento do Google Workspace usando endpoints HTTP, siga estas etapas para receber o ID de implantação do recurso de implantação do Google Cloud.

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

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

Para publicar um complemento do Editor, é necessário informar o ID do script do projeto e a versão que você 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 do Google Chat, você precisa configurar a API Google Chat. Consulte Publicar apps do Google Chat.

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 app da Web, você precisa fornecer o URL de navegação universal, que aponta para o app da Web no menu de apps do Google . O app da Web precisa estar em produção e totalmente funcional.

Ao preencher a página "Detalhes do app", você precisa fornecer ícones adicionais com tamanhos de 96 x 96 e 48 x 48 pixels.

Se você criou seu app da Web no Apps Script, siga estas etapas para receber 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.

Especificar o nível de acesso necessário para o app

Em Escopos do OAuth, forneça uma lista completa dos escopos do OAuth 2.0 necessários para o app. Os escopos do OAuth inseridos aqui precisam corresponder ao que você mostra na tela de consentimento 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 delas à página de configuração do app do SDK do Marketplace e à tela de consentimento do OAuth.

Sempre use os escopos mais estreitos 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 de detalhes do app.

Campos
Status do trader

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 do Google Workspace é um negociante ou um não-negociante:

  • Negociante: é uma pessoa que atua para fins relacionados a um comércio, negócio, ofício ou profissão, ou em nome ou em nome de um negociante.
  • Não negociante: uma pessoa que não é negociante (consumidor) é alguém que atua para fins não profissionais.

Se não for especificado, a mensagem "Status do comerciante não especificado" vai aparecer na página Detalhes do app do app.

Nome do desenvolvedor O nome que vai aparecer como 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 comerciantes. Não é coletado para não comerciantes.

O local da sua empresa. Insira um endereço de correspondência válido para entrarmos em contato com você.

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:

  • Se o Google precisar entrar em contato com o desenvolvedor, por exemplo, durante o processo de análise do app.
  • Para enviar feedback de complementos do Editor se um URL de problema não for fornecido na página "Detalhes do app".
URL do site do aplicativo Opcional. O site que descreve melhor o app.

Salvar as configurações 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 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.

  4. (Opcional) É possível receber análises sobre o uso do app no Google Analytics. Para fazer isso, adicione um ID do Google Analytics no SDK do Marketplace.

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