Para exibir seu aplicativo no Google Drive quando um usuário criar ou abrir um arquivo: primeiro configure uma integração da interface do usuário (IU) do Drive. Também é necessário configurar para listar seu aplicativo no Google Workspace Marketplace.
Ativar a API Drive
Antes de usar as APIs do Google, você precisa ativá-las em um ambiente projeto. É possível ativar uma ou mais APIs em uma única conta do projeto.
Para começar a integração com a interface do Google Drive, você deve ativar o a API Drive. Isso dá acesso à API e à integração da interface atributos de machine learning.
No console do Google Cloud, ative a API Google Drive.
Configurar a integração da interface do Drive
- No Console de APIs do Google, acesse o menu > APIs e Serviços > APIs ativadas e serviços.
- Na parte inferior da página No painel de serviços, clique em API Google Drive. A A página de configuração da API Google Drive é exibida.
- Selecione a guia Integração com a interface do Drive.
- (Opcional) Digite um nome no campo Nome do aplicativo. O aplicativo é exibido para os usuários na guia "Gerenciar aplicativos" do Google Drive configurações.
- (Opcional) Insira uma breve descrição de uma linha em Descrição curta. . A descrição breve é exibida para os usuários na guia "Gerenciar aplicativos" Configurações do Google Drive.
- (Opcional) Digite uma descrição completa no campo Descrição longa.
Faça o upload de um ou mais ícones do aplicativo para serem exibidos na lista de aplicativos do usuário aplicativos do Google Drive conectados e na seção "Abrir com" menu de contexto. Os ícones precisam estar no formato PNG com um plano de fundo transparente. Ícones podem levar até 24 horas para aparecer no Google Drive.
Para usar a opção "Abrir com" da interface do Drive cardápio item, insira o URL do app na Abrir URL. Esse URL é usado pelo link "Abrir com" menu de contexto.
- Esse URL deve conter um nome de domínio totalmente qualificado.
localhostnão funcionam. - Esse URL deve ser acessível aos usuários pretendidos do seu aplicativo. Se você tiver várias versões do aplicativo, como uma para públicos e um para acesso restrito a usuários selecionados, cada versão deve usar um URL exclusivo. Em seguida, é possível criar apps diferentes configurações personalizadas para cada versão.
- Você deve verificar a propriedade deste URL antes de listar o app no Google Workspace Marketplace.
- Por padrão, um parâmetro de consulta
stateé anexado a esse URL para transmitir dados da interface do usuário do Google Drive para seu aplicativo. Para informações sobre o conteúdo do parâmetrostate, consulte Ostateparâmetro.
- Esse URL deve conter um nome de domínio totalmente qualificado.
(Opcional) Digite os tipos MIME e as extensões de arquivo padrão no Campos Tipos MIME padrão e Extensões de arquivo padrão. MIME padrão e extensões de arquivo representam arquivos para os quais seu aplicativo foi criado exclusivamente aberta. Por exemplo, seu app pode abrir um formato integrado para criação de camadas edição de imagens. Inclua apenas mídias padrão tipos e verifique se não há erros de digitação ou ortográficos. Se o app só abrir ou arquivos de atalhos de terceiros, deixe o tipo MIME em branco.
(Opcional) Digite os tipos MIME secundários e as extensões de arquivo na coluna Tipos MIME e Extensões de arquivo secundárias. Tipos MIME secundários e as extensões de arquivo representam arquivos que o aplicativo pode abrir, mas não são específicos ao seu app. Por exemplo, seu app pode ser um app de edição de imagens que abre PNG e JPG. Inclua apenas mídias padrão tipos e verifique se não há erros de digitação ou ortográficos. Se o app só abrir ou arquivos de atalhos de terceiros, deixe o tipo MIME em branco.
Para usar o "Novo" da interface do Drive e peça aos usuários para criarem um arquivo com seu app, marque a caixa Como criar arquivos. As propriedades de Novo URL e opcionais Os campos Nome do documento são exibidos.
- Esse URL deve conter um nome de domínio totalmente qualificado.
localhostnão funcionam. - Você deve confirmar a propriedade deste URL antes de listar o app no Google Workspace Marketplace.
- Por padrão, um parâmetro de consulta
stateé anexado a esse URL para transmitir dados da interface do usuário do Google Drive para seu aplicativo. Para informações sobre o conteúdo do parâmetrostate, consulte Ostateparâmetro.
- Esse URL deve conter um nome de domínio totalmente qualificado.
Insira um URL no campo Novo URL. Esse URL é usado pelo elemento botão para redirecionar o usuário ao aplicativo.
(Opcional) Se você quiser que seu app abra arquivos compatíveis com o Google Workspace, Marque a caixa Importando.
(Opcional) Se o aplicativo precisar gerenciar arquivos em drives compartilhados, marque a opção Suporte a drives compartilhados. Para mais informações sobre como oferecer suporte drives compartilhados no seu app, consulte Implementar drives compartilhados suporte.
Clique em Enviar.
Solicitar o escopo drive.install
Para permitir que apps apareçam como uma opção na seção "Abrir com" ou em "Novo", menu,
solicitar o escopo https://www.googleapis.com/auth/drive.install para integrar
com a interface do Google Drive. Ao solicitar esse escopo, os usuários recebem uma
semelhante a esta:
Para mais informações sobre escopos que podem ser solicitados para apps do Drive, e como solicitá-las, consulte Autorização e autenticação específicas da API mais recentes.
Parâmetro state
Por padrão, um parâmetro state é anexado ao URL aberto e ao novo URL.
para transmitir dados da interface do Google Drive para seu aplicativo. Esse parâmetro
contém uma string codificada em JSON com variáveis de modelo e dados sobre o
ao seu app. As variáveis incluídas dependem do tipo de URL usado (Aberto
URL ou novo URL):
| Variável de modelo | Descrição | Aplicativo de URL |
|---|---|---|
{ids} |
Uma lista separada por vírgulas de IDs de arquivos sendo abertos. | Abrir URL |
{exportIds} |
Uma lista separada por vírgulas dos IDs de arquivo que estão sendo exportados (usado somente ao abrir documentos integrados do Google). | Abrir URL |
{resourceKeys} |
Um dicionário JSON de IDs de arquivos mapeados para seus respectivos recursos chaves. | Abrir URL |
{folderId} |
O ID da pasta principal. | Novo URL |
{folderResourceKey} |
A chave de recurso da pasta pai. | Novo URL |
{userId} |
O ID de 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 para uso em URL, portanto, seu app precisa processar o escape.
e analisar como JSON. Os apps podem detectar o valor create no
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 de 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 de state para um URL aberto são:
{
"ids": ["ID"],
"resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
"action":"open",
"userId":"USER_ID"
}
Os IDs e as chaves de recursos são usados para buscar metadados e fazer o download de arquivos
conteúdo. Depois que o app tiver o ID do arquivo e um token de acesso, ele poderá verificar
do arquivo, buscar os metadados do arquivo e fazer o download do conteúdo, conforme descrito
no método files.get.
Temas relacionados
Um app instalado precisa ser capaz de criar, gerenciar e abrir ações iniciadas interface do Google Drive. Para saber mais, consulte Integrar com "Novo" na interface do Drive ou Integrar com a opção "Abrir com" da interface do Drive contexto no menu suspenso.