Kintone

O conector permite executar operações de inserção, exclusão, atualização e leitura no banco de dados do Kintone.

Antes de começar

Antes de usar o conector do Kintone, faça o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Kintone na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    8. Permitir caracteres especiais: determina se os caracteres especiais serão permitidos ou não. Se verdadeiros caracteres especiais não serão substituídos.
    9. Verificar em Subtabelas em: uma lista separada por vírgulas de apps do Kintone para recuperar subtabelas.
    10. ID do espaço convidado: restrinja os resultados da consulta a um espaço convidado.
    11. Mapa numérico para duplo: determina se o tipo de dados dos campos numéricos será alterado de decimal para duplo.
    12. Caracteres de separador subtabela: o caractere usado para dividir tabelas de subtabelas no formato tablename + char + subtable.
    13. Usar código no nome do campo: determina se é necessário usar o rótulo ou o código para o nome do campo.
    14. Usar cursor: valor booleano que determina se os cursores precisam ser usados para recuperar registros.
    15. Visualizações definidas pelo usuário: um caminho que aponta para o arquivo de configuração JSON que contém suas visualizações personalizadas.
    16. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Básico: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
      • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
      • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
        • Sempre: a conexão será sempre com SSL ativado.
        • Nunca: a conexão não está com SSL ativado.
        • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
      • Na seção Servidor proxy, insira os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do host: especifique o nome do host ou o endereço IP do destino.

            Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

    17. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    18. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

    2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão do Kintone é compatível com os seguintes tipos de autenticação:

      • Nome de usuário e senha
      • Token de API

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em PRÓXIMA.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Nome de usuário e senha
    • Nome de usuário: nome de usuário para o conector
    • Senha: a senha do Secret Manager que contém a senha associada ao conector.
    • Senha de autenticação básico: a senha adicional necessária para domínios que usam autenticação básica.
    • Usuário de autenticação básico: o nome de usuário adicional necessário para os domínios que usam a autenticação básica.
  • Token de API
    • Token da API: Secret do Secret Manager que contém o token de API para autenticação.
    • ID do app: o AppId usado com a APIToken para autenticação.

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar uma conexão do Kintone.

Tipo de conexão de autenticação básica

Para o tipo de conexão de autenticação básica, use o nome de usuário e a senha que você recebe ao criar a nova instância do Kintone.

Nome do campo Detalhes
Local europe-west1
Conector Kintone
Versão do conector 1
Nome da conexão kintone-conn-free-trial
Ativar Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verificar tabelas secundárias em *
Usar código no nome do campo Sim
Usar o cursor Sim
Número mínimo de nós 2
Número máximo de nós 2
Tipo de destino(servidor) Endereço do host
Endereço do host https://tx3tdonei8na.kintone.com
Nome de usuário NOME DE USUÁRIO
Senha SENHA
Versão do secret 2

Tipo de conexão do token da API

Para saber como conseguir o token de acesso à API, consulte Token de acesso à API.

Nome do campo Detalhes
Local europe-west1
Conector Kintone
Versão do conector 1
Nome da conexão kintone-api-token-conn
Ativar Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verificar tabelas secundárias em *
Caractere de separação de subtabela _
Usar código no nome do campo Sim
Usar o cursor Sim
Número mínimo de nós 2
número máximo de nós 50
Tipo de destino(servidor) Endereço do host
Endereço do host https://tx3tdonei8na.kintone.com
Token de API API_Token_PostmanApplication
AppId 4
Versão do secret 1

Tipo de conexão OAuth

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar uma conexão do Kintone usando o OAuth e fornece informações sobre como criar e configurar uma conta do Kintone.

Criação e configuração da conta do Kintone
Nome do campo Detalhes
Local europe-west1
Conector Kintone
Versão do conector 1
Nome da conexão kintone-oauth-conn
Ativar Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verificar tabelas secundárias em *
Caractere de separação de subtabela _
Usar código no nome do campo Sim
Usar o cursor Sim
Número mínimo de nós 2
número máximo de nós 50
Tipo de destino(servidor) Endereço do host
Endereço do host https://tx3tdonei8na.kintone.com
ID do cliente CLIENT_ID
Escopos k:app_settings:write k:app_settings:read k:app_record:read k:app_record:write k:file:read k:file:write
Chave secreta do cliente CLIENT_SECRET
Versão do secret 2

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector do Kintone pode processar 5 transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

Esta seção lista as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação AppsDeployStatus

Esta ação recebe os status de implantação do app

Parâmetros de entrada da ação AppsDeployStatus

Nome do parâmetro Tipo de dados Obrigatório Descrição
AppIds String Sim O ID do app. Pode ser uma lista de IDs separados por vírgulas.
GuestSpaceId String Não Esse parâmetro é usado para apps que estão no espaço de visitante. Não adicione esse parâmetro se a propriedade de conexão GuestSpaceId estiver especificada na string de conexão.

Para saber como configurar a ação AppsDeployStatus, consulte Exemplos de ação.

Ação CreateApp

Essa ação cria apps.

Parâmetros de entrada da ação CreateApp

Nome do parâmetro Tipo de dados Obrigatório Descrição
Nome String Sim Especifique o nome do aplicativo com menos de 64 caracteres.
Espaço String Não O ID do espaço. Não especifique isso se a propriedade de conexão GuestSpaceId estiver definida na string de conexão.
ThreadId String Não O ID do espaço. Não especifique isso se a propriedade de conexão GuestSpaceId estiver definida na string de conexão.
IsGuestSpace Booleano Não É um valor booleano que indica se o parâmetro "Space" é um espaço normal ou de visitante. Defina esse valor como verdadeiro para espaços de convidados. O valor padrão é falso.

Para saber como configurar a ação CreateApp, consulte Exemplos de ação.

Ação "DeleteGuests"

Essa ação permite que os usuários excluam convidados.

Parâmetros de entrada da ação DeleteGuests

Nome do parâmetro Tipo de dados Obrigatório Descrição
Convidados String Sim Uma lista de endereços de e-mail de usuários convidados. É possível excluir até 100 convidados.

Para saber como configurar a ação DeleteGuests, consulte Exemplos de ação.

Ação DeployApps

Essa ação permite implantar apps.

Parâmetros de entrada da ação DeployApps

Nome do parâmetro Tipo de dados Obrigatório Descrição
AppId String Sim O ID do app. Pode ser uma lista de IDs separados por vírgulas.
Revisão String Não Especifique a revisão da configuração que reflete o ambiente operacional. Se a revisão especificada não estiver atualizada, a solicitação vai falhar.
Reverter Booleano Não Se você quiser cancelar a mudança nas configurações do aplicativo, defina como "true". O valor padrão é falso.
GuestSpaceId String Não Esse parâmetro é usado para apps que estão no espaço de visitante. Não adicione esse parâmetro se a propriedade de conexão GuestSpaceid for especificada na string de conexão.

Para saber como configurar a ação DeployApps, consulte Exemplos de ação.

Ação DownloadFile

Essa ação permite que os usuários façam o download de arquivos de um campo de anexo em um app.

Parâmetros de entrada da ação DownloadFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileKey String Sim O ID do arquivo.
HasBytes Booleano Não Define se o download do conteúdo será feito em bytes. Os valores válidos são true ou false. Se definido como true, o arquivo será transferido por download como uma string codificada em Base64.

Por padrão, o campo HasBytes está definido como false.

Para saber como configurar a ação DownloadFile, consulte Exemplos de ação.

Ação "UpdateAssignees"

Essa ação permite que os usuários atualizem os atribuídos.

Parâmetros de entrada da ação "UpdateAssignees"

Nome do parâmetro Tipo de dados Obrigatório Descrição
AppId String Sim O ID do app.
RecordId String Sim RecordId
Destinatários String Sim Os códigos de usuário dos designados. Se estiver vazio, nenhum usuário será atribuído. O número máximo de atribuídos é 100.
Revisão String Não O número da revisão do registro antes da atualização dos atribuídos. Se a revisão especificada não for a mais recente, a solicitação vai resultar em um erro.
GuestSpaceId String Não Esse parâmetro é usado para apps que estão no espaço de visitante. Não adicione esse parâmetro se a propriedade de conexão GuestSpaceId estiver especificada na string de conexão.

Para saber como configurar a ação UpdateAssignees, consulte Exemplos de ação.

Ação "AddGuests"

Essa ação permite que os usuários adicionem convidados.

Parâmetros de entrada da ação AddGuests

Nome do parâmetro Tipo de dados Obrigatório Descrição
Nome String falso O nome de exibição do usuário. Precisa ter entre 1 e 128 caracteres.
Código String Não O endereço de e-mail (nome de login) do usuário convidado.
Senha String Não A senha de login do usuário visitante. Ele precisa ser alfanumérico.
Fuso horário String Não O fuso horário do usuário convidado.
Localidade String Não As configurações de idioma do usuário convidado. Os valores disponíveis são auto, en, zh, ja. Se não for fornecido, o padrão será definido como "auto".
Imagem String Não A imagem do perfil do usuário convidado. Especifique uma chave de arquivo de um arquivo enviado.
SurNameReading String Não As configurações do sobrenome fonético do usuário convidado. O limite máximo é de 64 caracteres.
GivenNameReading String Não As configurações do nome próprio fonético do usuário visitante. O limite máximo é de 64 caracteres.
Empresa String Não O nome da empresa que vai aparecer no perfil do usuário convidado.
Divisão String Não O nome do departamento a ser exibido no perfil do usuário convidado.
Telefone String Não O número de telefone que vai aparecer no perfil do usuário convidado.
CallTo String Não O nome do Skype do usuário convidado.
GuestsAggregate String Não O agregado de convidados.

Para saber como configurar a ação AddGuests, consulte Exemplos de ação.

Ação UploadFile

Essa ação permite fazer upload de um arquivo.

Parâmetros de entrada da ação UploadFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileName String Sim O nome que você quer dar ao documento. Se nenhum for especificado, o nome de arquivo especificado na entrada "FullPath" será usado.
Conteúdo String Não O conteúdo como InputStream a ser enviado quando FullPath não estiver especificado.
ContentBytes String Não Conteúdo de bytes (como uma string Base64) para fazer upload como um arquivo. Use para fazer upload de dados binários.
AppId String Não O ID do app Kintone. Isso é necessário quando AttachToApp está definido como verdadeiro.
HasBytes Booleano Não Define se o upload de conteúdo será feito como bytes. Os valores válidos são true ou false. Se definido como true, o conteúdo do arquivo precisa ser uma string codificada em Base64.

Por padrão, o campo HasBytes está definido como false.

Ação "AddThreadComment"

Essa ação permite que os usuários adicionem comentários na conversa

Parâmetros de entrada da ação AddThreadComment

Nome do parâmetro Tipo de dados Obrigatório Descrição
SpaceId Número inteiro Sim O ID do espaço.
ThreadId Número inteiro Sim O ID da linha de execução.
Texto String Não O conteúdo do comentário. Uma quebra de linha pode ser especificada por LF. O máximo de caracteres do comentário é 65.535. Obrigatório, se files não estiver definido.
Menções String Não Uma matriz que inclui menções que notificam outros usuários do Kintone.
Arquivos String Não Uma matriz que inclui dados de arquivos de anexo. O número máximo de arquivos é 5. Obrigatório, se o texto não estiver definido.

Para saber como configurar a ação AddThreadComment, consulte Exemplos de ação.

Ação "UpdateThread"

Essa ação permite atualizar uma linha

Parâmetros de entrada da ação UpdateThread

Nome do parâmetro Tipo de dados Obrigatório Descrição
ThreadId Número inteiro Sim O ID da linha de execução. O ID da conversa pode ser encontrado no URL dela.
Nome String Não O novo nome da linha de execução. Precisa ter entre 1 e 128 caracteres. O nome não será atualizado se esse parâmetro for ignorado. O nome da linha de execução dos espaços de linha de execução única não pode ser atualizado.
Corpo String Não O conteúdo do corpo da conversa.

Para saber como configurar a ação UpdateThread, consulte Exemplos de ação.

Exemplos de ação

Esta seção descreve como realizar algumas das ações neste conector.

Exemplo: conferir o status da implantação do app

Este exemplo recebe o status de implantação do app.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AppsDeployStatus e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"AppIds": "4"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AppsDeployStatus terá um valor semelhante a este:

    {
"AppId": "4",   "Status": "SUCCESS",   "success": "true"
}

Exemplo: criar um app

Este exemplo cria um novo app.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateApp e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"Name": "NewApp"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateApp terá um valor semelhante a este:

    [{
"AppId": "20",   "Revision": "2",   "Success": "true"
}]

Exemplo: implantar um app

Este exemplo implanta um app

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeployApps e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"AppId": "19",   "Revision": "2"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeployApps terá um valor semelhante a este:

    [{
"Success": "true"
}]

Exemplo: fazer o download de um arquivo

Este exemplo faz o download de um arquivo presente em um app.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadFile e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadFile terá um valor semelhante a este:

    [{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

Exemplo: atualizar um usuário responsável

Este exemplo atualiza um atribuído.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdateAssignees e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"FileKey": "2024022706351283F683AABB3A4FA09AF1D28049"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdateAssignees terá um valor semelhante a este:

    [{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

Exemplo: adicionar um convidado

Este exemplo adiciona um convidado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddGuests e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"GuestsAggregate": "[{\"name\":\"Testuser\",\"code\":\"testuser1@test.com\",
\"password\":\"test@123\",\"timezone\":\"America/Los_Angeles\",
\"company\":\"Company Name\",\"division\": \"Sales\",
\"callto\":\"SkypeCallTo\",\"locale\":\"en\"}]"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddGuests terá um valor semelhante a este:

    [{
"Success": "true"
}]

Exemplo: excluir um convidado

Este exemplo exclui um visitante.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteGuests e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"Guests": "[\"testuser1@test.com\"]"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeleteGuests terá um valor semelhante a este:

    [{
"Success": "true"
}]

Exemplo: fazer upload de um arquivo

Este exemplo mostra como fazer upload de um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadFile e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"FileName": "GoogleCloud_Upload_File.txt",
"AppId": "9",
"Content": "Hello"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadFile terá um valor semelhante a este:

    [{
"FileKey": "4e3b6ca9-0028-41c6-9662-53b151ef9b35",
"Success": "true",
"Id": null,
"Revision": null
}]

Exemplo: adicionar um comentário à conversa

Este exemplo mostra como adicionar um comentário de linha de execução.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddThreadComment e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"SpaceId": 1.0,
"ThreadId": 1.0,
"Text": "Test Comment"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddThreadComment terá um valor semelhante a este:

    [{
"Id": "3",
"Success": "true"
}]

Exemplo: atualizar uma conversa

Este exemplo mostra como atualizar uma linha de execução.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdateThread e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"ThreadId": 1.0,
"Name": "updated thread"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdateThread terá um valor semelhante a este:

    [{
"Success": "true"
}]

Exemplos de operação de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os apps

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Apps na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (").

Também é possível realizar a operação de lista nas entidades "Registro" e "Comentários".

Exemplo: instalar um app

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Apps na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 4 no campo Valor padrão.

    Aqui, 4 é um ID de registro exclusivo na entidade Apps.

Também é possível executar a operação "get" nas seguintes entidades: Deploy, Record, FormFields, FormLayout, Views, GeneralSettings, ProcessManagement, AppPermission, RecordPermission, FieldPermission, GeneralNotification, PerRecordNotification, ReminderNotification, GraphSettings, ActionSettings, Space, SpaceMembers

Exemplo: excluir um registro

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Record na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira 6 no campo Valor padrão.

Você também pode executar a operação de exclusão nas entidades de comentários.

Exemplo: criar um registro

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Record na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"Text": "HelloDemo"
}

    A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

    {
"RecordId": 29.0
}

Exemplo: atualizar um registro

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Record na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"Text_area": "updatedemo"
}
  5. Clique em entityId e insira 22 no campo Valor padrão.

    A execução desse exemplo retorna uma resposta semelhante a esta na variável de saída connectorOutputPayload da tarefa do conector:

    {
"RecordId": "22"
}

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte exemplo de modelo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
allow_special_characters BOOLEAN Falso Determina se os caracteres especiais serão permitidos ou não. Se verdadeiros caracteres especiais não serão substituídos.
check_for_subtables_in STRING Verdadeiro Uma lista separada por vírgulas de apps do Kintone para recuperar subtabelas.
guest_space_id STRING Falso Restringir os resultados da consulta a um espaço de visitante.
number_map_to_double BOOLEAN Falso Determina se o tipo de dados dos campos numéricos será alterado de decimal para duplo.
subtable_separator_character STRING Verdadeiro O caractere usado para dividir tabelas de subtabelas no formato nome da tabela + caractere + subtabela.
use_code_for_field_name BOOLEAN Falso Determina se é necessário usar o rótulo ou o código para o nome do campo.
use_cursor BOOLEAN Falso Booleano que determina se os cursores precisam ser usados para recuperar registros.
user_defined_views STRING Falso Um caminho que aponta para o arquivo de configuração JSON que contém suas visualizações personalizadas.
proxy_enabled BOOLEAN Falso Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Kintone em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
  • Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir