Cuadrado

El conector de Square te permite insertar, eliminar, actualizar y leer datos de Square.

Versiones compatibles

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

Antes de empezar

Antes de usar el conector de Square, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de 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 el artículo Crear una cuenta de servicio.

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

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Integration Connectors > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

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

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

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

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Descripción: escriba una descripción de la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es 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 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. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo afectan los nodos a los precios de los conectores, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    11. + AÑADIR ETIQUETA: haz clic en esta opción para añadir una etiqueta a la conexión en forma de par clave-valor.
    12. Haz clic en SIGUIENTE.
  5. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

      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 saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    2. Haz clic en SIGUIENTE.
  6. Revisar: revisa los detalles de la conexión y la autenticación.
  7. Haz clic en Crear.

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

  • OAuth 2.0 - Código de autorización
    • ID de cliente: introduzca el ID de cliente que quiera usar para la conexión.
    • Permisos: introduce una lista de los permisos que quieras separados por comas.
    • Secreto de cliente: introduce el secreto de cliente que quieras usar para la conexión de Square.
    • Versión del secreto: selecciona la versión del secreto que has elegido más arriba.
    • URL de autorización: introduce la URL de autorización que se generó al crear el cliente.
    • Habilitar 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: introduce el token de acceso personal que quieras usar para la conexión.
    • Versión del secreto: selecciona la versión del secreto que has elegido más arriba.
    • Habilitar anulación de autenticación: especifica si se debe habilitar la anulación de autenticación para la conexión.

Ejemplos de configuración de conexión

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear 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
Habilitar Cloud Logging true
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Número mínimo de nodos 2
Número máximo de nodos 50
Autenticación OAuth 2.0: código de autorización
ID de 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
Secreto de cliente CLIENT_SECRET
Versión de secreto 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
Habilitar Cloud Logging true
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Esquema v2
Usar el entorno aislado true
Número mínimo de nodos 2
Número máximo de nodos 50
Autenticación Token de acceso personal
Token de acceso personal PERSONAL_ACCESS_TOKEN
Versión de secreto 1

Limitaciones del sistema

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

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

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

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Acciones

En esta sección se muestra cómo realizar algunas de las acciones de 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 Cadena Verdadero ID del pago que se va a cancelar.

Para ver un ejemplo de 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 Cadena Verdadero ID del pago que se va a completar.

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

Acción CancelPaymentByIdempotencyKey

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

Parámetros de entrada de la acción CancelPaymentByIdempotencyKey

Nombre del parámetro Tipo de datos Obligatorio Descripción
IdempotencyKey Cadena Verdadero Clave de idempotencia usada para identificar el pago que se va a cancelar.

Para ver un ejemplo de 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 Cadena Verdadero ID de la factura que se va a cancelar.
InvoiceVersion Cadena Verdadero La versión de la factura que se va a cancelar.

Para ver un ejemplo de 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 Cadena Verdadero El ID de la factura que se va a publicar.
InvoiceVersion Int32 Verdadero La versión de la factura que se va a publicar. Debe coincidir con la versión actual de la factura. De lo contrario, la solicitud se rechazará.

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

Acción DeleteInvoiceAttachment

Esta acción elimina un archivo adjunto de una factura.

Parámetros de entrada de la acción DeleteInvoiceAttachment

Nombre del parámetro Tipo de datos Obligatorio Descripción
InvoiceId Cadena Verdadero ID de la factura que contiene el archivo adjunto que se va a eliminar.
AttachmentId Cadena Verdadero ID del archivo adjunto que se va a eliminar.

Para ver un ejemplo de 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 Cadena Verdadero ID de la suscripción que se va a cancelar.

Para ver un ejemplo de 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 de este conector.

Ejemplo: cancelar un pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CancelPayment y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: completar un pago

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CompletePayment y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: Cancelar un pago con una clave de idempotencia

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CancelPaymentByIdempotencyKey y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: cancelar una factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CancelInvoice y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: publicar una factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción PublishInvoice y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: eliminar un archivo adjunto de una factura

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción DeleteInvoiceAttachment y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: cancelar una suscripción

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CancelSubscriptions y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 entidad en este conector.

Ejemplo: listar 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, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, puedes definir el filterClause en función de tus requisitos de filtrado.

    5. Debe usar comillas simples (") para incluir el valor de un filterClause. Puede usar filterClause para filtrar registros en función de las columnas.

Ejemplo: Obtener los detalles de 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 Get y, a continuación, haz clic en Hecho.
  4. Asigna el valor "bb4756c7-38c0-426b-97aa-03b6443e7f16" a entityId, que es la clave que se va a transferir.
  5. Para definir entityId, en la sección Asignación de datos de Data Mapper, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca "bb4756c7-38c0-426b-97aa-03b6443e7f16" en el campo Valor de entrada y elija entityId como variable local.

    6. El valor de entityId debe enviarse directamente, como "bb4756c7-38c0-426b-97aa-03b6443e7f16". En este caso, "bb4756c7-38c0-426b-97aa-03b6443e7f16" es el valor de clave principal único.

    Si al enviar un solo entityId se produce un error debido a la presencia de dos claves compuestas, puede usar filterClause para enviar el valor.

Ejemplo: eliminar 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, a continuación, haz clic en Hecho.
  4. Asigna el valor "62008bbe-effa-4341-9d29-eac7f67b84fe" a entityId, que es la clave que se va a transferir.
  5. Para definir entityId, en la sección Asignación de datos de Data Mapper, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca "62008bbe-effa-4341-9d29-eac7f67b84fe" en el campo Valor de entrada y elija entityId como variable local.

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

Ejemplo: Crear 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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 connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Ejemplo: Crear 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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: Crear 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija 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: Crear 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId o connectorInputPayload como variable local. 
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

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

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Ejemplo: crear una tarjeta 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId o connectorInputPayload como variable local. 
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

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

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Ejemplo: actualizar 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId, connectorInputPayload o filterClause como variable local. 
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. Define el entityId en Data Mapper como la entidad de las facturas.
  6. Para definir el entityId, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId, connectorInputPayload o filterClause como variable local.

    En lugar de especificar el entityId, también puede definir filterClause como 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

    Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    { }

Ejemplo: actualizar 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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId, connectorInputPayload o filterClause como variable local. 
    {
  "Note": "Update Subscription"
}
  5. Define el entityId en Data Mapper como la entidad de las suscripciones.
  6. Para definir el entityId, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId, connectorInputPayload o filterClause como variable local.

    En lugar de especificar el entityId, también puede definir filterClause como '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

    Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    { }

Ejemplo: actualizar los detalles de los pagos

  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, a continuación, haz clic en Hecho.
  4. En la sección Mapeador de datos de la tarea Mapeo de datos, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId, connectorInputPayload o filterClause como variable local. 
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. Define el entityId en Data Mapper como la entidad de los PayOuts.
  6. Para definir el entityId, haga clic en Open Data Mapping Editor y, a continuación, introduzca un valor similar al siguiente en el campo Input Value y elija entityId, connectorInputPayload o filterClause como variable local.

    En lugar de especificar el entityId, también puede definir filterClause como '181352d9-94ef-4e86-8bb9-e3759472325f'.

    Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

    { }

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos