Como criar interfaces do Google Drive

Os complementos do Google Workspace oferecem recursos interfaces quando o usuário está usando o Google Drive. Isso permite que você forneça ao usuário informações relevantes adicionais, automatizar tarefas e conectar para o Google Drive.

Como acessar a interface do complemento

Você pode abrir um complemento do Google Workspace em Google Drive, se o ícone aparecer na coluna do ícone no lado direito da interface do usuário do Google Drive. Um O complemento do Google Workspace definir uma interface de página inicial, uma interface de seleção de item ou ambas:

  • Se um usuário clicar no ícone de complemento no Google Drive, o complemento é executado o drive.homepageTrigger correspondente (se presente). Essa função cria e retorna um card da página inicial ao Google Drive para exibição. Em caso negativo drive.homepageTrigger for definida, um card genérico de página inicial será exibido.
  • Se o usuário selecionar um ou mais itens no Google Drive e clicar no complemento ou selecionar itens enquanto o complemento está aberto, ele executará a drive.onItemsSelectedTrigger função contextual (se houver). Esta função cria o complemento do Google Drive "itens selecionados" contextuais interface e o retorna ao Google Drive para exibição.

Criar a interface de complementos do Drive

Você pode criar interfaces que estendem o Google Drive seguindo estas instruções etapas:

  1. Decida se você quer que o complemento tenha uma versão específica do Drive página inicial. Decida também se você quer fornecer uma interface contextual para quando o usuário seleciona itens do Google Drive.
  2. Adicione o addOns.common e Campos addOns.drive para o projeto de script de complemento manifesto, incluindo todos os escopos do Drive necessários.
  3. Se você fornecer uma página inicial específica do Drive, implementar drive.homepageTrigger para criar essa interface. Você também pode optar por usar common.homepageTrigger para vários hosts do Google Workspace.
  4. Se você oferece uma interface de seleção de itens contextuais do Drive, é necessário implementar um drive.onItemsSelectedTrigger função de gatilho contextual para criar essa interface. Consulte Interface contextual do Drive para itens selecionados para mais detalhes.
  5. Implementar as funções de callback associadas necessárias para responder ao comando Interações da interface, como cliques em botões.

Páginas iniciais do Drive

O Google Drive é compatível com a exibição de complementos do Google Workspace páginas iniciais. Para mostrar a página inicial comum do seu complemento no Google Drive, basta verificar se há é um campo addOns.drive. no manifesto do complemento.

Como alternativa, adicione um drive.homepageTrigger ao manifesto do complemento para fornecer uma página inicial específica do Drive.

Em ambos os casos, é necessário fornecer o nome de uma função de acionamento da página inicial no seu do seu complemento. Essa função é chamada automaticamente para criar a na página inicial do Drive quando necessário. Você deve implementar essa função para criar e retornar um só Card ou uma matriz de Card que compõem a página inicial. A função de gatilho da página inicial recebe um objeto de evento como um parâmetro que contém algumas informações gerais, como o URL de plataforma. Você pode usar os dados do objeto de evento para personalizar a construção do página inicial.

Interface contextual do Drive para itens selecionados

O Google Drive usa um gatilho contextual para determinar qual interface (se houver) para ser exibido quando o usuário selecionar um ou mais itens do Google Drive. Quando o dispara, ele executa a função de acionamento contextual especificada pelo drive.onItemsSelectedTrigger.runFunction no manifesto do complemento.

Para criar uma interface de seleção de itens contextuais para o Drive, faça o seguinte: seguinte:

  1. Verificar se o manifesto do complemento inclui o https://www.googleapis.com/auth/drive.addons.metadata.readonly escopo

  2. Garantir que o manifesto inclua um drive.onItemsSelectedTrigger nesta seção.

  3. Implemente a função nomeada no drive.onItemsSelectedTrigger . Essa função aceita um objeto de evento como argumento. e precisa retornar uma única objeto Card ou uma matriz de Objetos Card.

  4. Como acontece com qualquer cartão, é necessário implementar as funções de callback usadas para fornecer com interatividade de widgets na interface. Por exemplo, se você incluir um botão na interface, ele deverá ter um Ação e uma função de callback implementada, executada quando o botão é clicado.

Objetos de evento

Um objeto de evento é criado e transmitido para drive.homepageTrigger ou drive.onItemsSelectedTrigger função de gatilho quando essas funções são chamadas. A função de gatilho pode usar as informações neste objeto de evento para determinar como criar cartões complementares ou controlar o comportamento do complemento.

A estrutura completa dos objetos de evento é descrita em Objetos de evento Quando o Drive é o app host de ação do complemento, os objetos de eventos contextuais incluem o parâmetro Objeto de evento do Drive que mostra informações do cliente específicas do Drive.

Os objetos de evento do Drive contextual para acionadores de seleção de itens incluem informações sobre os itens que o usuário selecionou quando o acionador é disparado. Quando um usuário seleciona mais de um item no Google Drive, um dos itens é considerado um dos interesse principal esse item é conhecido como item do cursor ativo.

O exemplo a seguir mostra Objeto de evento do Drive que é passado para um drive.onItemsSelectedTrigger função:

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }