Quadrado

Com o conector da Square, você realiza ações de inserção, exclusão, atualização e leitura nos dados da Square.

Versões compatíveis

Esse conector é compatível com a versão 1.0 do Square.

Antes de começar

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

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda o papel do 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

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, faça o seguinte:

  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 Square na lista de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista 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 exceder 49 caracteres.
    4. Descrição: insira uma descrição para a instância de conexão.
    5. Se quiser, 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. Esquema: especifique o esquema da conexão, como v1 ou v2.
    8. Usar sandbox: especifique se quer usar o ambiente de sandbox para a conexão.
    9. ID do local: especifique o ID do local da conexão.
    10. 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.

    11. + ADICIONAR RÓTULO: clique aqui para adicionar um rótulo à conexão na forma de um par de chave-valor.
    12. Clique em PRÓXIMA.
  5. 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 Square aceita os seguintes tipos de autenticação:

      • OAuth 2.0: código de autorização
      • Token de acesso pessoal

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

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

Configurar a autenticação

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

  • OAuth 2.0 - Código de autorização
    • ID do cliente: insira o ID do cliente a ser usado na conexão.
    • Escopos: insira uma lista separada por vírgulas dos escopos desejados.
    • Chave secreta do cliente: insira a chave secreta a ser usada na conexão com o Square.
    • Versão do secret: selecione a versão do secret escolhido acima.
    • URL de autorização: insira o URL de autorização gerado ao criar o cliente.
    • Ativar substituição de autenticação: especifique se a substituição de autenticação será ativada para a conexão.
  • Token de acesso pessoal
    • Token de acesso pessoal: insira o token de acesso pessoal a ser usado na conexão.
    • Versão do secret: selecione a versão do secret escolhido acima.
    • Ativar substituição de autenticação: especifique se a substituição de autenticação será ativada para a conexã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 a conexão.

OAuth 2.0: tipo de conexão de código de autorização

Nome do campo Detalhes
Local us-central1
Conector Quadrado
Versão do conector 1
Nome da conexão square-oauth-ai
Ativar Cloud Logging verdadeiro
Conta de serviço my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Código de autorização OAuth 2.0
ID do cliente CLIENT_ID
Escopos BANK_ACCOUNTS_READ, CASH_DRAWER_READ, CUSTOMERS_READ, CUSTOMERS_WRITE, DEVICE_CREDENTIAL_MANAGEMENT, EMPLOYEES_READ, EMPLOYEES_WRITE, INVENTORY_READ, INVENTORY_WRITE, ITEMS_READ, ITEMS_WRITE, LOYALTY_READ, LOYALTY_WRITE, MERCHANT_PROFILE_READ, ORDERS_READ, ORDERS_WRITE, PAYMENTS_READ, PAYMENTS_WRITE, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS, PAYMENTS_WRITE_IN_PERSON, SETTLEMENTS_READ, TIMECARDS_READ, TIMECARDS_WRITE, TIMECARDS_SETTINGS_READ, TIMECARDS_SETTINGS_WRITE, APPOINTMENTS_READ, APPOINTMENTS_WRITE, APPOINTMENTS_BUSINESS_SETTINGS_READ, INVOICES_READ, INVOICES_WRITE, SUBSCRIPTIONS_READ, SUBSCRIPTIONS_WRITE, DISPUTES_READ, DISPUTES_WRITE, GIFTCARDS_READ, GIFTCARDS_WRITE, ONLINE_STORE_SNIPPETS_WRITE, ONLINE_STORE_SNIPPETS_READ, ONLINE_STORE_SITE_READ, PAYMENTS_WRITE_SHARED_ONFILE, APPOINTMENTS_ALL_READ, APPOINTMENTS_ALL_WRITE, MERCHANT_PROFILE_WRITE, VENDOR_READ, VENDOR_WRITE, PAYOUTS_READ, DEVICES_READ
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://connect.squareup.com/oauth2/authorize

Tipo de conexão de token de acesso pessoal

Nome do campo Detalhes
Local asia-east1
Conector Quadrado
Versão do conector 1
Nome da conexão square-pat-prod-conn
Ativar Cloud Logging verdadeiro
Conta de serviço my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Usar a caixa de areia verdadeiro
Número mínimo de nós 2
Número máximo de nós 50
Autenticação Token de acesso pessoal
Token de acesso pessoal PERSONAL_ACCESS_TOKEN
Versão do secret 1

Limitações do sistema

O conector do Square pode processar no máximo 16 transações por segundo, por nó, e limita as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós (para melhor disponibilidade) para uma conexão.

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

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

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

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

Ações

Nesta seção, mostramos como realizar algumas das ações neste conector.

Ação CancelPayment

Essa ação cancela um pagamento.

Parâmetros de entrada da ação CancelPayment

Nome do parâmetro Tipo de dados Obrigatório Descrição
PaymentId String Verdadeiro O ID do pagamento a ser cancelado.

Para ver um exemplo de como configurar a ação CancelPayment, consulte Exemplos.

Ação CompletePayment

Essa ação conclui um pagamento.

Parâmetros de entrada da ação CompletePayment

Nome do parâmetro Tipo de dados Obrigatório Descrição
PaymentId String Verdadeiro O ID do pagamento a ser concluído.

Para ver um exemplo de como configurar a ação CompletePayment, consulte Exemplos.

Ação CancelPaymentByIdempotencyKey

Essa ação cancela um pagamento usando a chave de idempotência.

Parâmetros de entrada da ação CancelPaymentByIdempotencyKey

Nome do parâmetro Tipo de dados Obrigatório Descrição
IdempotencyKey String Verdadeiro A chave de idempotência usada para identificar o pagamento a ser cancelado.

Para ver um exemplo de como configurar a ação CancelPaymentByIdempotencyKey, consulte Exemplos.

Ação CancelInvoice

Essa ação cancela uma fatura.

Parâmetros de entrada da ação CancelInvoice

Nome do parâmetro Tipo de dados Obrigatório Descrição
InvoiceId String Verdadeiro O ID da fatura a ser cancelada.
InvoiceVersion String Verdadeiro A versão da fatura a ser cancelada.

Para ver um exemplo de como configurar a ação CancelInvoice, consulte Exemplos.

Ação PublishInvoice

Essa ação publica uma fatura.

Parâmetros de entrada da ação PublishInvoice

Nome do parâmetro Tipo de dados Obrigatório Descrição
InvoiceId String Verdadeiro O ID da fatura a ser publicada.
InvoiceVersion Int32 Verdadeiro A versão da fatura a ser publicada. Ela precisa corresponder à versão atual da fatura. Caso contrário, a solicitação será rejeitada.

Para ver um exemplo de como configurar a ação PublishInvoice, consulte Exemplos.

Ação DeleteInvoiceAttachment

Essa ação exclui um anexo de fatura.

Parâmetros de entrada da ação DeleteInvoiceAttachment

Nome do parâmetro Tipo de dados Obrigatório Descrição
InvoiceId String Verdadeiro O ID da fatura que contém o anexo a ser excluído.
AttachmentId String Verdadeiro O ID do anexo a ser excluído.

Para ver um exemplo de como configurar a ação DeleteInvoiceAttachment, consulte Exemplos.

Ação CancelSubscriptions

Essa ação cancela uma assinatura.

Parâmetros de entrada da ação CancelSubscriptions

Nome do parâmetro Tipo de dados Obrigatório Descrição
ID String Verdadeiro O ID da assinatura a ser cancelada.

Para ver um exemplo de como configurar a ação CancelSubscriptions, consulte Exemplos.

Exemplos de ações

Nesta seção, mostramos como realizar alguns dos exemplos de ações neste conector.

Exemplo: cancelar um pagamento

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelPayment 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: 
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

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

    [
  {
    "Success": true
  }
]

Exemplo: concluir um pagamento

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CompletePayment 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: 
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

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

    [{
"Success": true
}]

Exemplo: cancelar um pagamento usando uma chave de idempotência

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelPaymentByIdempotencyKey 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: 
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

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

    [{
"Success": true
}]

Exemplo: cancelar uma fatura

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelInvoice 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: 
    {
"InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}

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

    [
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "3",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "NOT_APPLICABLE",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_status": "CANCELED",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:57:24Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Exemplo: publicar uma fatura

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação PublishInvoice 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: 
    {
  "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}

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

    [
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "2",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "PENDING",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_next_payment_amount_money_amount": "60",
    "invoice_next_payment_amount_money_currency": "USD",
    "invoice_status": "UNPAID",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:52:13Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Exemplo: excluir um anexo de fatura

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteInvoiceAttachment 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: 
    {
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

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

    [{
"Success": true
}]

Exemplo: cancelar uma assinatura

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelSubscriptions 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: 
    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

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

    [{
"Success": true,
"Status": "CANCELED"

}]

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os pagamentos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Payments na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause com base nos seus requisitos de filtragem.

    5. Use aspas simples (') para incluir o valor de uma filterClause. Use a filterClause para filtrar registros com base nas colunas.

Exemplo: receber detalhes de pagamento

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Payments na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Defina o entityId como "bb4756c7-38c0-426b-97aa-03b6443e7f16", que é a chave a ser transmitida.
  5. Para definir o entityId, na seção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e insira "bb4756c7-38c0-426b-97aa-03b6443e7f16" no campo Valor de entrada. Depois, escolha entityId como variável local.

    6. O valor de entityId precisa ser transmitido diretamente, como "bb4756c7-38c0-426b-97aa-03b6443e7f16". Aqui, "bb4756c7-38c0-426b-97aa-03b6443e7f16" é o valor exclusivo da chave primária.

    Se a transmissão de um único entityId gerar um erro devido à presença de duas chaves compostas, use a filterClause para transmitir o valor.

Exemplo: excluir um pagamento

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Payments na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Defina o entityId como "62008bbe-effa-4341-9d29-eac7f67b84fe", que é a chave a ser transmitida.
  5. Para definir o entityId, na seção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e insira "62008bbe-effa-4341-9d29-eac7f67b84fe" no campo Valor de entrada. Depois, escolha entityId como variável local.

    6. Se a entidade tiver duas chaves primárias ou de negócios compostas, em vez de especificar o entityId, você também poderá definir a filterClause como id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

Exemplo: criar um pagamento

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Payments na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId ou connectorInputPayload como variável local. 
    {
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}

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

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Exemplo: criar um reembolso

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Refunds na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId ou connectorInputPayload como variável local. 
    {
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}

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

    {
  "Success": true
}

Exemplo: criar uma assinatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Subscriptions na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId ou connectorInputPayload como variável local. 
    {
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}

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

    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

Exemplo: criar um cliente

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Customers na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId ou connectorInputPayload como variável local. 
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

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

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Exemplo: criar um vale-presente

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione GiftCards na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId ou connectorInputPayload como variável local. 
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

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

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Exemplo: atualizar uma fatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Invoices na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId, connectorInputPayload ou filterClause como variável local. 
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. Defina o entityId no Data Mapper como a entidade das faturas.
  6. Para definir o entityId, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId, connectorInputPayload ou filterClause como variável local.

    Em vez de especificar o entityId, você também pode definir a filterClause como 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

    A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    { }

Exemplo: atualizar uma assinatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Subscriptions na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId, connectorInputPayload ou filterClause como variável local. 
    {
  "Note": "Update Subscription"
}
  5. Defina o entityId no Data Mapper como a entidade das assinaturas.
  6. Para definir o entityId, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId, connectorInputPayload ou filterClause como variável local.

    Em vez de especificar o entityId, você também pode definir a filterClause como '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

    A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    { }

Exemplo: atualizar detalhes de pagamento

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione PayOuts na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha entityId, connectorInputPayload ou filterClause como variável local. 
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. Defina o entityId no Data Mapper como a entidade dos pagamentos.
  6. Para definir o entityId, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId, connectorInputPayload ou filterClause como variável local.

    Em vez de especificar o entityId, você também pode definir a filterClause como '181352d9-94ef-4e86-8bb9-e3759472325f'.

    A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    { }

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