Quadrado

O conetor do Square permite-lhe realizar ações de inserção, eliminação, atualização e leitura nos dados do Square.

Versões suportadas

Este conector suporta a versão 1.0 do Square.

Antes de começar

Antes de usar o conector do Square, faça as seguintes tarefas:

  • No seu projeto do Google Cloud:
    • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
    • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. Para mais informações, consulte o artigo Criar uma conta de serviço.

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

      Para saber como ativar serviços, consulte o artigo Ativar serviços.

    Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

  1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

    Aceda à página Ligações

  2. Clique em + CRIAR NOVO para abrir a página Criar associação.
  3. Na secção Localização, escolha a localização para a ligação.
    1. Região: selecione uma localização na lista pendente.

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

    2. Clique em SEGUINTE.
  4. Na secção Detalhes da associação, conclua 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 associação, introduza um nome para a instância da associação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
    4. Descrição: introduza uma descrição para a instância de associação.
    5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
    7. Esquema: especifique o esquema da associação, como v1 ou v2.
    8. Usar sandbox: especifique se deve usar o ambiente de sandbox para a ligação.
    9. ID de localização: especifique o ID de localização da associação.
    10. Opcionalmente, configure as definições do nó de associação:

      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

    11. + ADICIONAR ETIQUETA Clique aqui para adicionar uma etiqueta à associação sob a forma de um par de chave/valor.
    12. Clique em SEGUINTE.
  5. Na secção Autenticação, introduza os detalhes de autenticação.
    1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela associação do Square:

      • OAuth 2.0 – Código de autorização
      • Token de acesso pessoal

      Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

    2. Clique em SEGUINTE.
  6. Rever: reveja os detalhes da ligação e da autenticação.
  7. Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

  • OAuth 2.0 – Código de autorização
    • ID de cliente: introduza o ID de cliente a usar para a associação.
    • Âmbitos: introduza uma lista de âmbitos desejados separada por vírgulas.
    • Segredo do cliente: introduza o segredo do cliente a usar para a ligação ao Square.
    • Versão do Secret: selecione a versão do Secret para o Secret selecionado acima.
    • URL de autorização: introduza o URL de autorização que foi gerado durante a criação do cliente.
    • Ativar substituição de autenticação: especifique se pretende ativar a substituição de autenticação para a ligação.
  • Chave de acesso pessoal
    • Chave de acesso pessoal: introduza a chave de acesso pessoal a usar para a associação.
    • Versão do Secret: selecione a versão do Secret para o Secret selecionado acima.
    • Ativar substituição de autenticação: especifique se pretende ativar a substituição de autenticação para a ligação.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo dos vários campos que configura quando cria a associação.

OAuth 2.0 – Tipo de ligação de código de autorização

Nome do campo Detalhes
Localização us-central1
Conetor Quadrado
Versão do conetor 1
Nome da ligação square-oauth-ai
Ative o 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 OAuth 2.0 – Código de autorização
ID do cliente CLIENT_ID
Âmbitos 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
Segredo do cliente CLIENT_SECRET
Versão do Secret 1
URL de autorização https://connect.squareup.com/oauth2/authorize

Tipo de ligação da chave de acesso pessoal

Nome do campo Detalhes
Localização asia-east1
Conetor Quadrado
Versão do conetor 1
Nome da ligação square-pat-prod-conn
Ative o Cloud Logging verdadeiro
Conta de serviço my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Use a sandbox 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 um máximo de 16 transações por segundo, por nó e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Use a associação da Square numa integração

Depois de criar a associação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

  • Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
  • Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Ações

Esta secção mostra como realizar algumas das ações neste conector.

Ação CancelPayment

Esta ação cancela um pagamento.

Introduza os parâmetros da ação CancelPayment

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

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

Ação CompletePayment

Esta ação conclui um pagamento.

Introduza os parâmetros da ação CompletePayment

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

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

Ação CancelPaymentByIdempotencyKey

Esta ação cancela um pagamento através da respetiva chave de idempotência.

Parâmetros de entrada da ação CancelPaymentByIdempotencyKey

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

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

Ação CancelInvoice

Esta ação cancela uma fatura.

Introduza os parâmetros da ação CancelInvoice

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

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

Ação PublishInvoice

Esta ação publica uma fatura.

Introduza os parâmetros da ação PublishInvoice

Nome do parâmetro Tipo de dados Obrigatória Descrição
InvoiceId String Verdadeiro O ID da fatura a publicar.
InvoiceVersion Int32 Verdadeiro A versão da fatura a publicar. Este valor tem de corresponder ao da versão atual da fatura. Caso contrário, o pedido é rejeitado.

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

Ação DeleteInvoiceAttachment

Esta ação elimina um anexo de fatura.

Introduza os parâmetros da ação DeleteInvoiceAttachment

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

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

Ação CancelSubscriptions

Esta ação cancela uma subscrição.

Parâmetros de entrada da ação CancelSubscriptions

Nome do parâmetro Tipo de dados Obrigatória Descrição
ID String Verdadeiro O ID da subscrição a cancelar.

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

Exemplos de ações

Esta secção mostra como realizar alguns dos exemplos de ações neste conetor.

Exemplo: cancele um pagamento

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelPayment e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value: 
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

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

    [
  {
    "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, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value: 
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

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

    [{
"Success": true
}]

Exemplo: cancele um pagamento através de uma chave de idempotência

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelPaymentByIdempotencyKey e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 ao seguinte:

    [{
"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, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

    [
  {
    "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: publique uma fatura

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação PublishInvoice e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

    [
  {
    "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: elimine um anexo de fatura

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteInvoiceAttachment e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 ao seguinte:

    [{
"Success": true
}]

Exemplo: cancelar uma subscrição

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelSubscriptions e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 ao seguinte:

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

}]

Exemplos de operações de entidades

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

Exemplo: lista 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, de seguida, clique em Concluído.
  4. Na secção Entrada de tarefas da tarefa Conectores, pode definir o filterClause com base nos seus requisitos de filtragem.

    5. Tem de usar aspas simples (') para incluir o valor de uma filterClause. Pode usar o elemento filterClause para filtrar registos com base nas colunas.

Exemplo: obtenha 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, de seguida, 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 secção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e, de seguida, introduza "bb4756c7-38c0-426b-97aa-03b6443e7f16" no campo Valor de entrada e escolha o entityId como variável local.

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

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

Exemplo: elimine 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, de seguida, 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 secção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e, de seguida, introduza "62008bbe-effa-4341-9d29-eac7f67b84fe" no campo Valor de entrada e escolha o entityId como variável local.

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

Exemplo: crie 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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Exemplo: crie 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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 da tarefa do conector tem um valor semelhante ao seguinte:connectorOutputPayload

    {
  "Success": true
}

Exemplo: crie uma subscrição

  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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 da tarefa do conector tem um valor semelhante ao seguinte:connectorOutputPayload

    {
  "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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Exemplo: crie um vale de oferta

  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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Exemplo: atualize 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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 mapeador de dados para a entidade das faturas.
  6. Para definir o entityId, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha entityId, connectorInputPayload ou filterClause como variável local.

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

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

    { }

Exemplo: atualize uma subscrição

  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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 mapeador de dados para a entidade das subscrições.
  6. Para definir o entityId, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha entityId, connectorInputPayload ou filterClause como variável local.

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

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

    { }

Exemplo: atualize os detalhes do 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, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza 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 mapeador de dados para a entidade dos pagamentos.
  6. Para definir o entityId, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha entityId, connectorInputPayload ou filterClause como variável local.

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

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

    { }

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?