Ir para o conteúdo

OAuth - Google - Conta de Serviço

Introdução

O plug-in Jitterbit OAuth - Google - Service Account é usado para autenticar com a implementação do OAuth 2 do Google para contas de serviço do Google. Um guia passo a passo para configurar uma conta de serviço do Google está disponível na documentação do Google Using OAuth 2.0 for Server to Server Applications.

Após o plugin ser executado em um Jitterbit Script, o token de autenticação é retornado na variável global google.oauth.token.auth e o número de segundos de expiração é retornado na variável global google.oauth.token.expireSeconds.

Essas variáveis globais podem então ser usadas em outras partes do projeto. Por exemplo, google.oauth.token.auth pode ser usado em um URL ou cabeçalho HTTP para fornecer os detalhes de autenticação ao Google. A variável google.oauth.token.expireSeconds pode ser usado para armazenar em cache o token de autorização até que o número de segundos de expiração seja atingido.

Importante

Os plug-ins fornecidos pela Jitterbit estão obsoletos. Consulte Descontinuação e suporte em Plugins.

Uso

Embora este plugin possa ser executado em qualquer Jitterbit Script, as variáveis globais que ele retorna são suportadas na configuração destes endpoints:

A saída do plug-in não é compatível com Cloud Studio Connector Builder. Em vez disso, no Cloud Studio você pode usar o Google Docs, Google Drive ou Google Sheets, conectores que já fornecem um meio de autenticação com o serviço do Google durante a configuração do endpoint.

Passos

Esta página detalha as etapas para usar o plug-in OAuth - Google - Service Account:

  1. Baixe e adicione o plug-in
  2. Associe o plug-in a um Grupo de Agentes
  3. Definir variáveis globais para o plug-in
  4. Execute o plug-in em um Jitterbit Script
  5. Concluir a configuração da operação

Baixe e Adicione o Plugin

O plug-in Jitterbit OAuth - Google - Service Account deve ser baixado no link fornecido abaixo e adicionado à organização (consulte Adicionar novos plug-ins em Personalizações > Plug-ins).

Associe o Plug-in a um Grupo de Agentes

Se estiver usando um Grupo de Agentes em Nuvem, você pode pular esta etapa, pois o plug-in Jitterbit OAuth - Google - Service Account já está associado aos Grupos de Agentes em Nuvem do Jitterbit por padrão.

Se estiver usando um Grupo de Agentes Privados, você deve associar este plugin fornecido pelo Jitterbit ao seu Grupo de Agentes Privados. Isso disponibilizará o plugin para todos os Agentes Privados do Grupo de Agentes Privados. Para associar o plugin:

  1. Faça login no Portal Harmony e vá para o Management Console. Em seguida, use o menu no canto superior esquerdo para navegar até Personalizações > Plug-ins.
  2. Na tabela, localize a linha "Jitterbit OAuth - Google - Conta de serviço". Na extrema direita, use o menu suspenso Ação para selecionar Grupo de Agentes Associados.
  3. No pop-up, selecione seu Grupo de Agentes Privados e clique em Salvar.

Dica

A documentação detalhada sobre a associação de plug-ins está disponível em Personalizações > Plug-ins.

Definir Variáveis globais para o Plugin

Para que este plugin seja funcional, as variáveis globais exigidas como entrada pelo plugin devem ser definidas.

Essas variáveis globais podem ser definidas no mesmo script que executa o plug-in (abordado a seguir em Executar o plug-in em um Jitterbit Script), ou podem ser definidas em um script separado localizado anteriormente na cadeia de operação (para que as variáveis sejam inicializadas antes da execução do plugin).

Dica

Para obter mais informações, consulte estas páginas:

Um modelo de script é fornecido abaixo, seguido de documentação sobre cada uma das variáveis globais de entrada que podem ser usadas com o plugin:

Setting Input Variables
<trans>
// Input variables
$google.oauth.privateKey = "-----BEGIN PRIVATE KEY-----\nABCDEfg...HIJKLMN\n-----END PRIVATE KEY-----\n";
$google.oauth.clientEmail = "example@example-123456.iam.gserviceaccount.com";
$google.oauth.accountScopes = "https://www.googleapis.com/auth/bigquery";
$google.oauth.serviceAccountUser = '';
</trans>
Nome Tipo Obrigatório Descrição
google.oauth.privateKey Corda Obrigatório A chave privada RSA fornecida via JSON no campo "private_key" do Google.
google.oauth.clientEmail Corda Obrigatório O email do cliente fornecido via JSON no campo “client_email” do Google.
google.oauth.accountScopes Corda Opcional Os escopos OAuth separados por espaço a serem usados com o fluxo da conta de serviço. Defina como uma string vazia para nenhum.
google.oauth.serviceAccountUser Corda Opcional O endereço email do usuário que o aplicativo está tentando representar no fluxo da conta de serviço. Defina como uma string vazia para nenhum.

Dica

Para obter detalhes adicionais, consulte a documentação do Google >Usando OAuth 2.0 para aplicativos de servidor para servidor e Escopos do OAuth 2.0 para APIs do Google.

Execute o Plug-in em um Jitterbit Script

Este plugin pode ser executado a partir de um Jitterbit Script de qualquer tipo de script chamando a função Jitterbit Script RunPlugin().

As variáveis globais necessárias como entrada para o plugin podem ser especificadas dentro do mesmo script em que o plugin é executado. Por exemplo, o conteúdo do script usado para o modelo em Set Global Variables for the Plugin poderia ser incluído em um único script que também executa o plugin.

Após a execução do plugin, o token de autenticação é retornado na variável global google.oauth.token.auth e o número de segundos de expiração é retornado na variável global google.oauth.token.expireSeconds.

Cada uma dessas partes do script é fornecida neste modelo:

Setting Input Variables and Executing the Plugin
<trans>
// Input variables
$google.oauth.privateKey = "-----BEGIN PRIVATE KEY-----\nABCDEfg...HIJKLMN\n-----END PRIVATE KEY-----\n";
$google.oauth.clientEmail = "example@example-123456.iam.gserviceaccount.com";
$google.oauth.accountScopes = "https://www.googleapis.com/auth/bigquery";
$google.oauth.serviceAccountUser = '';

// Output variables
$google.oauth.token.auth = '';
$google.oauth.token.expireSeconds = '';

// Executing the plugin
RunPlugin("<TAG>plugin:http://www.jitterbit.com/plugins/pipeline/user/OAuthGoogleServiceAccount</TAG>");
</trans>
Nome Descrição
google.oauth.token.auth O token de autenticação do Google.
google.oauth.expireSeconds O número de segundos até que o token de autenticação do Google expire.

Dica

Documentação detalhada sobre a execução de plugins a partir de um script está disponível em Plugins (Design Studio) ou Plugins chamados em um Script (Cloud Studio).

Conclua a Configuração da Operação

As variáveis globais retornadas pelo script do plugin podem então ser usadas em outras partes do projeto para autenticação com o Google. Essas variáveis globais são oficialmente suportadas na configuração destes endpoints:

Em uma configuração típica no Design Studio, a variável global google.oauth.token.auth pode ser usado em um URL ou cabeçalho HTTP para fornecer os detalhes de autenticação ao Google.

Isso pode ser concatenado com o hospedar do Google no campo URL de uma fonte HTTP ou destino HTTP.

Como alternativa, ele pode ser inserido na origem ou destino HTTP Propriedades HTTP avançadas na área Cabeçalhos de solicitação:

cabeçalhos de solicitação

Da mesma forma, no Cloud Studio, a variável global google.oauth.token.auth pode ser usado em uma conexão HTTP no campo Cabeçalhos de solicitação. Alternativamente, ele pode ser especificado como Parâmetro de solicitação ou Cabeçalho de solicitação em uma atividade HTTP.