Esta página foi traduzida pela API Cloud Translation.

Configurar uma integração com a IU do Drive

Para exibir o app no Google Drive quando um usuário criar ou abrir um arquivo, primeiro configure uma integração com a interface do usuário (IU) do Drive. A configuração também é necessária para listar seu aplicativo no Google Workspace Marketplace.

Ativar a API Drive

Antes de usar as APIs do Google, elas precisam ser ativadas em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.

Para começar a integrar com a IU do Google Drive, ative a API Drive. Com isso, você terá acesso à API e aos recursos de integração da IU.

No console do Google Cloud, ative a API Google Drive.

Ativar a API

Configurar a integração com a IU do Drive

No Console de APIs do Google, acesse Menu > APIs e serviços > APIs e serviços ativados.
Acessar APIs e serviços ativados
Na parte inferior do painel de APIs e serviços, clique em API Google Drive. A página de configuração da API Google Drive será exibida.
Selecione a guia Integração com a IU do Drive.
(Opcional) Digite um nome no campo Application name. O nome do aplicativo é exibido para os usuários na guia "Gerenciar apps" nas configurações do Drive.
(Opcional) Insira uma descrição curta de uma linha no campo Short description. A descrição curta é exibida para os usuários na guia "Gerenciar apps" nas configurações do Drive.
(Opcional) Insira uma descrição completa no campo Descrição longa.
Faça upload de um ou mais ícones de aplicativo para mostrar na lista de apps do Drive conectados e no menu de contexto "Abrir com". Os ícones precisam estar no formato PNG com fundo transparente. Os ícones podem levar até 24 horas para aparecer no Drive.

Observação: os ícones de documento foram descontinuados. O ícone do aplicativo aparece ao lado de arquivos de atalho e de terceiros. Um conjunto de ícones padrão é usado para outros tipos de arquivo.
Para usar o item de menu "Abrir com" da IU do Drive, insira o URL do seu app no campo Abrir URL. Esse URL é usado pelo menu de contexto "Abrir com".
- Esse URL precisa conter um nome de domínio totalmente qualificado. localhost não funciona.
- É necessário verificar a propriedade desse URL para poder listar seu aplicativo no Google Workspace Marketplace.
- Por padrão, um parâmetro de consulta state é anexado a esse URL para transmitir dados da IU do Drive para seu app. Para informações sobre o conteúdo do parâmetro state, consulte O parâmetro state.
Aviso :a opção de mostrar automaticamente a tela de consentimento do OAuth 2.0 foi descontinuada. Não marque esta caixa. O aplicativo precisa iniciar todas as solicitações de autorização.
(Opcional) Digite os tipos MIME e as extensões de arquivo padrão nos campos Tipos MIME padrão e Extensões de arquivo padrão. Os tipos MIME e as extensões de arquivo padrão representam arquivos criados exclusivamente para abrir o app. Por exemplo, seu app pode abrir um formato integrado para criar camadas e editar imagens. Inclua somente tipos de mídia padrão e verifique se não há erros de digitação ou ortografia. Se o app abrir apenas arquivos de atalho ou de atalho de terceiros, deixe o tipo MIME em branco.
(Opcional) Digite os tipos MIME secundários e as extensões de arquivo nos campos Tipos MIME secundários e Extensões de arquivo secundários. Os tipos MIME secundários e as extensões de arquivo representam arquivos que o app pode abrir, mas não são específicos para ele. Por exemplo, o app pode ser um app de edição de imagens que abre imagens PNG e JPG. Inclua somente tipos de mídia padrão e verifique se não há erros de digitação ou ortografia. Se o app abrir apenas arquivos de atalho ou de atalho de terceiros, deixe o tipo MIME em branco.

Observação :se um usuário instalar vários apps do Drive que podem abrir um arquivo, o app instalado mais recentemente será usado até que o usuário escolha outro app.
Para usar o botão "Novo" da IU do Drive e pedir que os usuários criem um arquivo com seu app, marque a caixa Criar arquivos. Os campos Novo URL e Nome do documento opcionais aparecem.
- Esse URL precisa conter um nome de domínio totalmente qualificado. localhost não funciona.
- É necessário verificar a propriedade desse URL para poder listar seu aplicativo no Google Workspace Marketplace.
- Por padrão, um parâmetro de consulta state é anexado a esse URL para transmitir dados da IU do Drive para seu app. Para informações sobre o conteúdo do parâmetro state, consulte O parâmetro state.
Insira um URL no campo Novo URL. Esse URL é usado pelo botão "Novo" para redirecionar o usuário ao seu aplicativo.

Observação :deixe o campo "Nome do documento" em branco. Esse campo não é mais usado.
(Opcional) Se você quiser que o app abra arquivos com suporte do Google Workspace, marque a caixa Import.
(Opcional) Se o app precisar gerenciar arquivos em drives compartilhados, marque a caixa Suporte a drives compartilhados. Para mais informações sobre como oferecer suporte a drives compartilhados no seu app, consulte Implementar o suporte a drives compartilhados.
Clique em Enviar.

Solicitar o escopo `drive.install`

Para permitir que os apps apareçam como uma opção no menu "Abrir com" ou "Novo", solicite o escopo https://www.googleapis.com/auth/drive.install para integrar com a IU do Drive. Ao solicitar esse escopo, os usuários recebem uma caixa de diálogo parecida com esta:

Caixa de diálogo de instalação da IU do Google Drive. — **Figura 1**. A caixa de diálogo de instalação ao usar escopos para a IU do Drive.

Para saber mais sobre os escopos que podem ser solicitados para apps do Drive e como fazer isso, consulte Informações de autorização e autenticação específicas da API.

Parâmetro `state`

Por padrão, um parâmetro state é anexado ao URL aberto e ao novo para transmitir dados da IU do Drive para seu app. Esse parâmetro contém uma string codificada em JSON com variáveis de modelo e dados sobre a solicitação para seu app. As variáveis incluídas dependem do tipo de URL usado (URL aberto ou novo URL):

Variável de modelo	Descrição	Aplicativo de URL
`{ids}`	Uma lista separada por vírgulas de IDs dos arquivos que estão sendo abertas.	Abrir URL
`{exportIds}`	Uma lista separada por vírgulas de IDs de arquivos que estão sendo exportados (usada apenas ao abrir documentos do Google integrados).	Abrir URL
`{resourceKeys}`	Um dicionário JSON de IDs de arquivo mapeados para as respectivas chaves de recurso.	Abrir URL
`{folderId}`	O ID da pasta mãe.	Novo URL
`{folderResourceKey}`	A chave de recurso da pasta mãe.	Novo URL
`{userId}`	O ID do perfil que identifica o usuário.	Abrir URL e novo URL
`{action}`	A ação que está sendo realizada. O valor é `open` ao usar um URL aberto ou `create` ao usar um novo URL.	Abrir URL e novo URL

O parâmetro state é codificado por URL. Por isso, o app precisa processar os caracteres de escape e analisá-los como JSON. Os apps podem detectar o valor create no parâmetro state para verificar uma solicitação de criação de um arquivo.

Exemplo de informações de estado em JSON para um novo URL

As informações do state para um novo URL são:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Exemplo de informações de estado em JSON para um URL aberto

As informações do state para um URL aberto são as seguintes:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Os IDs e as chaves de recurso são usados para buscar metadados de arquivos e fazer o download de conteúdo. Depois que o app tiver o ID do arquivo e um token de acesso, ele poderá verificar as permissões, buscar os metadados do arquivo e fazer o download do conteúdo dele, conforme descrito no método files.get.

Temas relacionados

Um app instalado precisa ser capaz de criar, gerenciar e abrir ações iniciadas na IU do Drive. Para saber mais, consulte Integrar com o botão "Novo" da IU do Drive ou Integrar com o menu de contexto "Abrir com a IU do Drive".