Cuadrado

El conector de Square te permite realizar acciones de inserción, eliminación, actualización y lectura en los datos de Square.

Versiones compatibles

Este conector es compatible con la versión 1.0 de Square.

Antes de comenzar

Antes de usar el conector de Square, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, haz lo siguiente:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en SIGUIENTE.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona Square en la lista de conectores disponibles.
    2. Versión del conector: Selecciona la versión del conector de la lista de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 49 caracteres.
    4. Descripción: Ingresa una descripción para la instancia de conexión.
    5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Esquema: Especifica el esquema de la conexión, como v1 o v2.
    8. Usar la zona de pruebas: Especifica si se debe usar el entorno de zona de pruebas para la conexión.
    9. ID de ubicación: Especifica el ID de ubicación de la conexión.
    10. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    11. + AGREGAR ETIQUETA: Haz clic aquí para agregar una etiqueta a la conexión en forma de un par clave-valor.
    12. Haz clic en SIGUIENTE.
  5. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de Square admite los siguientes tipos de autenticación:

      • OAuth 2.0, código de autorización
      • Token de acceso personal

      Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haga clic en SIGUIENTE.
  6. Revisa: Revisa tus detalles de conexión y autenticación.
  7. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • OAuth 2.0, código de autorización
    • ID de cliente: Ingresa el ID de cliente que se usará para la conexión.
    • Permisos: Ingresa una lista de los permisos deseados separados por comas.
    • Secreto de cliente: Ingresa el secreto del cliente que se usará para la conexión de Square.
    • Versión del secreto: Selecciona la versión del secreto que se indicó anteriormente.
    • URL de autorización: Ingresa la URL de autorización que se generó cuando creaste el cliente.
    • Habilitar la anulación de autenticación: Especifica si se debe habilitar la anulación de autenticación para la conexión.
  • Token de acceso personal
    • Token de acceso personal: Ingresa el token de acceso personal que se usará para la conexión.
    • Versión del secreto: Selecciona la versión del secreto para el secreto seleccionado anteriormente.
    • Habilitar la anulación de autenticación: Especifica si se debe habilitar la anulación de autenticación para la conexión.

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra para los distintos campos que configuras cuando creas la conexión.

OAuth 2.0: Tipo de conexión de código de autorización

Nombre del campo Detalles
Ubicación us-central1
Conector Cuadrado
Versión del conector 1
Nombre de la conexión square-oauth-ai
Habilita Cloud Logging verdadero
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Autenticación OAuth 2.0, código de autorización
ID de cliente CLIENT_ID
Permisos 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
Secreto del cliente CLIENT_SECRET
Versión del Secret 1
URL de autorización https://connect.squareup.com/oauth2/authorize

Tipo de conexión de token de acceso personal

Nombre del campo Detalles
Ubicación asia-east1
Conector Cuadrado
Versión del conector 1
Nombre de la conexión square-pat-prod-conn
Habilita Cloud Logging verdadero
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Usar la zona de pruebas verdadero
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Autenticación Token de acceso personal
Token de acceso personal PERSONAL_ACCESS_TOKEN
Versión del Secret 1

Limitaciones del sistema

El conector de Square puede procesar un máximo de 16 transacciones por segundo, por nodo, y regula cualquier transacción que supere este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Usa la conexión de Square en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en Application Integration. Puedes usar la conexión en una integración a través de la tarea Connectors.

  • Para comprender cómo crear y usar la tarea Connectors en Apigee Integration, consulta Tarea Connectors.
  • Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta Tarea Connectors.

Acciones

En esta sección, se muestra cómo realizar algunas de las acciones en este conector.

Acción CancelPayment

Esta acción cancela un pago.

Parámetros de entrada de la acción CancelPayment

Nombre del parámetro Tipo de datos Obligatorio Descripción
PaymentId String Verdadero Es el ID del pago que se cancelará.

Para ver un ejemplo sobre cómo configurar la acción CancelPayment, consulta Ejemplos.

Acción CompletePayment

Esta acción completa un pago.

Parámetros de entrada de la acción CompletePayment

Nombre del parámetro Tipo de datos Obligatorio Descripción
PaymentId String Verdadero Es el ID del pago que se completará.

Para ver un ejemplo sobre cómo configurar la acción CompletePayment, consulta Ejemplos.

Acción CancelPaymentByIdempotencyKey

Esta acción cancela un pago con su clave de idempotencia.

Parámetros de entrada de la acción CancelPaymentByIdempotencyKey

Nombre del parámetro Tipo de datos Obligatorio Descripción
IdempotencyKey String Verdadero Es la clave de idempotencia que se usa para identificar el pago que se cancelará.

Para ver un ejemplo sobre cómo configurar la acción CancelPaymentByIdempotencyKey, consulta Ejemplos.

Acción CancelInvoice

Esta acción cancela una factura.

Parámetros de entrada de la acción CancelInvoice

Nombre del parámetro Tipo de datos Obligatorio Descripción
InvoiceId String Verdadero Es el ID de la factura que se cancelará.
InvoiceVersion String Verdadero Es la versión de la factura que se cancelará.

Para ver un ejemplo sobre cómo configurar la acción CancelInvoice, consulta Ejemplos.

Acción PublishInvoice

Esta acción publica una factura.

Parámetros de entrada de la acción PublishInvoice

Nombre del parámetro Tipo de datos Obligatorio Descripción
InvoiceId String Verdadero Es el ID de la factura que se publicará.
InvoiceVersion Int32 Verdadero Es la versión de la factura que se publicará. Debe coincidir con la versión actual de la factura; de lo contrario, se rechazará la solicitud.

Para ver un ejemplo sobre cómo configurar la acción PublishInvoice, consulta Ejemplos.

Acción DeleteInvoiceAttachment

Esta acción borra un adjunto de factura.

Parámetros de entrada de la acción DeleteInvoiceAttachment

Nombre del parámetro Tipo de datos Obligatorio Descripción
InvoiceId String Verdadero Es el ID de la factura que contiene el adjunto que se borrará.
AttachmentId String Verdadero Es el ID del adjunto que se borrará.

Para ver un ejemplo sobre cómo configurar la acción DeleteInvoiceAttachment, consulta Ejemplos.

Acción CancelSubscriptions

Esta acción cancela una suscripción.

Parámetros de entrada de la acción CancelSubscriptions

Nombre del parámetro Tipo de datos Obligatorio Descripción
ID String Verdadero Es el ID de la suscripción que se cancelará.

Para ver un ejemplo sobre cómo configurar la acción CancelSubscriptions, consulta Ejemplos.

Ejemplos de acciones

En esta sección, se muestra cómo realizar algunos de los ejemplos de acciones en este conector.

Ejemplo: Cancela un pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CancelPayment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [
  {
    "Success": true
  }
]

Ejemplo: Completa un pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CompletePayment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Success": true
}]

Ejemplo: Cancela un pago con una clave de idempotencia

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CancelPaymentByIdempotencyKey y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Success": true
}]

Ejemplo: Cancela una factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CancelInvoice y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [
  {
    "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
  }
]

Ejemplo: Publica una factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción PublishInvoice y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [
  {
    "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
  }
]

Ejemplo: Borra un archivo adjunto de factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DeleteInvoiceAttachment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Success": true
}]

Ejemplo: Cancela una suscripción

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CancelSubscriptions y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

}]

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de la entidad en este conector.

Ejemplo: Enumera todos los pagos

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Payments en la lista Entity.
  3. Selecciona la operación List y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, puedes establecer la filterClause según tus requisitos de filtrado.

    5. Debes usar comillas simples ("'") para incluir el valor de una filterClause. Puedes usar filterClause para filtrar registros según las columnas.

Ejemplo: Obtén detalles del pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Payments en la lista Entity.
  3. Selecciona la operación Get y haz clic en Listo.
  4. Establece entityId en "bb4756c7-38c0-426b-97aa-03b6443e7f16", que es la clave que se pasará.
  5. Para establecer el entityId, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa "bb4756c7-38c0-426b-97aa-03b6443e7f16" en el campo Input Value y elige entityId como variable local.

    6. El valor de entityId debe pasarse directamente, como "bb4756c7-38c0-426b-97aa-03b6443e7f16". Aquí, "bb4756c7-38c0-426b-97aa-03b6443e7f16" es el valor único de la clave primaria.

    Si pasar un solo entityId arroja un error debido a la presencia de dos claves compuestas, puedes usar filterClause para pasar el valor.

Ejemplo: Borra un pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Payments en la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. Establece entityId en "62008bbe-effa-4341-9d29-eac7f67b84fe", que es la clave que se pasará.
  5. Para establecer el entityId, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa "62008bbe-effa-4341-9d29-eac7f67b84fe" en el campo Input Value y elige entityId como variable local.

    6. Si la entidad tiene dos claves comerciales o primarias compuestas, en lugar de especificar entityId, también puedes establecer filterClause en id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

Ejemplo: Crea un pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Payments en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId o connectorInputPayload como variable local. 
    {
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}

    Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Ejemplo: Crea un reembolso

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Refunds en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId o connectorInputPayload como variable local. 
    {
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}

    Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
  "Success": true
}

Ejemplo: Crea una suscripción

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Subscriptions en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId o connectorInputPayload como variable local. 
    {
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}

    Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: Crea un cliente

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Customers en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId o connectorInputPayload como variable local. 
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

    Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Ejemplo: Crea una tarjeta de regalo

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona GiftCards en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId o connectorInputPayload como variable local. 
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

    Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Ejemplo: Actualiza una factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Invoices en la lista Entity.
  3. Selecciona la operación Update y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId, connectorInputPayload o filterClause como variable local. 
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. Establece entityId en Data Mapper en la entidad de las facturas.
  6. Para establecer entityId, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId, connectorInputPayload o filterClause como variable local.

    En lugar de especificar entityId, también puedes establecer filterClause en 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

    Cuando ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    { }

Ejemplo: Actualiza una suscripción

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Subscriptions en la lista Entity.
  3. Selecciona la operación Update y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId, connectorInputPayload o filterClause como variable local. 
    {
  "Note": "Update Subscription"
}
  5. Establece el entityId en Data Mapper en la entidad de las suscripciones.
  6. Para establecer entityId, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId, connectorInputPayload o filterClause como variable local.

    En lugar de especificar entityId, también puedes establecer filterClause en '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

    Cuando ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    { }

Ejemplo: Actualiza los detalles de pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona PayOuts en la lista Entity.
  3. Selecciona la operación Update y haz clic en Listo.
  4. En la sección Data Mapper de la tarea Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId, connectorInputPayload o filterClause como variable local. 
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. Establece entityId en Data Mapper como la entidad de PayOuts.
  6. Para establecer entityId, haz clic en Open Data Mapping Editor y, luego, ingresa un valor similar al siguiente en el campo Input Value y elige entityId, connectorInputPayload o filterClause como variable local.

    En lugar de especificar entityId, también puedes establecer filterClause en '181352d9-94ef-4e86-8bb9-e3759472325f'.

    Cuando ejecutas este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    { }

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?