Existem cinco métodos de autenticação compatíveis:
- OAuth 2.0
- Nome de usuário/senha
- Nome de usuário/token
- Chave
- None
Dependendo do método usado, você precisa disponibilizar funções adicionais no seu conector.
A tabela a seguir indica quais funções você deve definir dependendo do tipo de autenticação do conector.
OAUTH2 | USER_PASS/USER_TOKEN/KEY | NONE | |
---|---|---|---|
getAuthType() |
Obrigatório | obrigatório | Obrigatório |
resetAuth() |
Obrigatório | Obrigatório | |
isAuthValid() |
Obrigatório | Obrigatório | |
authCallback() |
Obrigatório | ||
get3PAuthorizationUrls() |
Obrigatório | ||
setCredentials() |
Obrigatório |
getAuthType()
Esta função retornará o tipo de autenticação do conector.
OAUTH2
USER_PASS
USER_TOKEN
KEY
NONE
resetAuth()
Esta função limpará todas as credenciais do usuário armazenadas para o serviço de terceiros.
OAUTH2
USER_PASS
USER_TOKEN
KEY
isAuthValid()
Esta função é chamada para determinar se a autenticação do serviço de terceiros é válida. Se for, espera-se que as chamadas para getData()
e getSchema()
não apresentem falha devido ao acesso não autorizado. Caso contrário, o usuário poderá receber uma notificação para iniciar o fluxo de autorização.
OAUTH2
USER_PASS
USER_TOKEN
KEY
OAUTH2
Adicionar e configurar o OAuth2 para a biblioteca do Apps Script
Siga as instruções de configuração da biblioteca do OAuth2 para Apps Script para adicioná-la ao seu projeto de conector. Em seguida, siga a primeira etapa no guia de uso para criar um serviço do OAuth2 no seu projeto de conector. O serviço do OAuth2 pode ter qualquer nome de função válido. No entanto, use o mesmo nome ao fazer referência ao serviço do OAuth2 no seu código.
Por exemplo, um serviço do OAuth2 chamado exampleService
:
authCallback()
Esta função é chamada para concluir o fluxo do OAuth 2.0. A resposta de retorno de chamada do serviço de autenticação de terceiros é disponibilizada como um argumento e deve ser tratada por essa função.
Exemplo de tratamento do retorno de chamada do OAuth 2.0 usando a biblioteca do OAuth2 para Apps Script:
get3PAuthorizationUrls()
Esta função é chamada para visualizar o URL que é necessário para iniciar o fluxo de autenticação do serviço de terceiros. Se isAuthValid
retornar false
, o URL retornado será exibido ao usuário como um botão ou link para que ele possa autorizar o acesso ao serviço de terceiros. Veja a referência para get3PAuthorizationUrls().
Exemplo de devolução do URL de autorização usando a biblioteca do OAuth2 para Apps Script:
.USER_PASS
, USER_TOKEN
e KEY
Os códigos a seguir são necessários somente para os fluxos de autenticação USER_PASS
, USER_TOKEN
e KEY
.
setCredentials()
setCredentials
é chamado depois que o usuário insere suas informações de credenciais na página de configuração do conector da comunidade. É recomendável usar o Serviço de propriedades para salvar as credenciais por usuário utilizando UserProperties
.