Square

Le connecteur Square vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur les données Square.

Versions compatibles

Ce connecteur est compatible avec la version 1.0 de Square.

Avant de commencer

Avant d'utiliser le connecteur Square, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour en savoir plus, consultez Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connexions, puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.

    2. Cliquez sur SUIVANT.
  4. Dans la section Détails de la connexion, procédez comme suit :
    1. Connecteur : sélectionnez Square dans la liste des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste des versions disponibles.
    3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent pas dépasser 49 caractères.
    4. Description : saisissez une description de l'instance de connexion.
    5. (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. Schéma : spécifiez le schéma de la connexion, tel que v1 ou v2.
    8. Utiliser le bac à sable : indiquez si vous souhaitez utiliser l'environnement de bac à sable pour la connexion.
    9. ID de l'emplacement : spécifiez l'ID de l'emplacement pour la connexion.
    10. (Facultatif) Configurez les paramètres des nœuds de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.

    11. + AJOUTER UNE ÉTIQUETTE : cliquez sur cette option pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    12. Cliquez sur SUIVANT.
  5. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion Square :

      • Code d'autorisation OAuth 2.0
      • Jeton d'accès personnel

      Pour savoir comment configurer ce type d'authentification, consultez Configurer l'authentification.

    2. Cliquez sur SUIVANT.
  6. Vérifier : vérifiez vos informations de connexion et d'authentification.
  7. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Code d'autorisation OAuth 2.0
    • ID client : saisissez l'ID client à utiliser pour la connexion.
    • Niveaux d'accès : saisissez une liste de niveaux d'accès souhaités, séparés par une virgule.
    • Code secret du client : saisissez le code secret du client à utiliser pour la connexion Square.
    • Version du secret : sélectionnez la version du secret sélectionné ci-dessus.
    • URL d'autorisation : saisissez l'URL d'autorisation générée lors de la création du client.
    • Activer le remplacement de l'authentification : indiquez si vous souhaitez activer le remplacement de l'authentification pour la connexion.
  • Jeton d'accès personnel
    • Jeton d'accès personnel : saisissez le jeton d'accès personnel à utiliser pour la connexion.
    • Version du secret : sélectionnez la version du secret sélectionné ci-dessus.
    • Activer le remplacement de l'authentification : indiquez si vous souhaitez activer le remplacement de l'authentification pour la connexion.

Exemples de configuration de connexion

Cette section présente des exemples de valeurs pour les différents champs que vous configurez lorsque vous créez la connexion.

Type de connexion avec un code d'autorisation OAuth 2.0

Nom du champ Détails
Emplacement us-central1
Connecteur Square
Version du connecteur 1
Nom de connexion square-oauth-ai
Activer Cloud Logging vrai
Compte de service mon-compte-service@mon-projet.iam.gserviceaccount.com
Schéma v2
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Authentification Code d'autorisation OAuth 2.0
ID client ID_CLIENT
Niveaux d'accès 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
Code secret du client SECRET_CLIENT
Version du secret 1
URL d'autorisation https://connect.squareup.com/oauth2/authorize

Type de connexion avec un jeton d'accès personnel

Nom du champ Détails
Emplacement asia-east1
Connecteur Square
Version du connecteur 1
Nom de connexion square-pat-prod-conn
Activer Cloud Logging vrai
Compte de service mon-compte-service@mon-projet.iam.gserviceaccount.com
Schéma v2
Utiliser le bac à sable vrai
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Authentification Jeton d'accès personnel
Jeton d'accès personnel PERSONAL_ACCESS_TOKEN
Version du secret 1

Limites du système

Le connecteur Square peut traiter au maximum 16 transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Utiliser la connexion Square dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Action CancelPayment

Cette action annule un paiement.

Paramètres d'entrée de l'action CancelPayment

Nom du paramètre Type de données Obligatoire Description
PaymentId Chaîne Vrai ID du paiement à annuler.

Pour obtenir un exemple de configuration de l'action CancelPayment, consultez Exemples.

Action CompletePayment

Cette action finalise un paiement.

Paramètres d'entrée de l'action CompletePayment

Nom du paramètre Type de données Obligatoire Description
PaymentId Chaîne Vrai ID du paiement à finaliser.

Pour obtenir un exemple de configuration de l'action CompletePayment, consultez Exemples.

Action CancelPaymentByIdempotencyKey

Cette action annule un paiement à l'aide de sa clé d'idempotence.

Paramètres d'entrée de l'action CancelPaymentByIdempotencyKey

Nom du paramètre Type de données Obligatoire Description
IdempotencyKey Chaîne Vrai Clé d'idempotence utilisée pour identifier le paiement à annuler.

Pour obtenir un exemple de configuration de l'action CancelPaymentByIdempotencyKey, consultez Exemples.

Action CancelInvoice

Cette action annule une facture.

Paramètres d'entrée de l'action CancelInvoice

Nom du paramètre Type de données Obligatoire Description
InvoiceId Chaîne Vrai ID de la facture à annuler.
InvoiceVersion Chaîne Vrai Version de la facture à annuler.

Pour obtenir un exemple de configuration de l'action CancelInvoice, consultez Exemples.

Action PublishInvoice

Cette action publie une facture.

Paramètres d'entrée de l'action PublishInvoice

Nom du paramètre Type de données Obligatoire Description
InvoiceId Chaîne Vrai ID de la facture à publier.
InvoiceVersion Int32 Vrai Version de la facture à publier. Elle doit correspondre à la version actuelle de la facture. Dans le cas contraire, la demande sera refusée.

Pour obtenir un exemple de configuration de l'action PublishInvoice, consultez Exemples.

Action DeleteInvoiceAttachment

Cette action supprime une pièce jointe de facture.

Paramètres d'entrée de l'action DeleteInvoiceAttachment

Nom du paramètre Type de données Obligatoire Description
InvoiceId Chaîne Vrai ID de la facture contenant la pièce jointe à supprimer.
AttachmentId Chaîne Vrai ID de la pièce jointe à supprimer.

Pour obtenir un exemple de configuration de l'action DeleteInvoiceAttachment, consultez Exemples.

Action CancelSubscriptions

Cette action permet d'annuler un abonnement.

Paramètres d'entrée de l'action CancelSubscriptions

Nom du paramètre Type de données Obligatoire Description
Id Chaîne Vrai ID de l'abonnement à résilier.

Pour obtenir un exemple de configuration de l'action CancelSubscriptions, consultez Exemples.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Annuler un paiement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CancelPayment, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [
  {
    "Success": true
  }
]

Exemple : Effectuer un paiement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CompletePayment, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
"Success": true
}]

Exemple : Annuler un paiement à l'aide d'une clé d'idempotence

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CancelPaymentByIdempotencyKey, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
"Success": true
}]

Exemple : Annuler une facture

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CancelInvoice, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
"InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Publier une facture

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action PublishInvoice, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Supprimer une pièce jointe de facture

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DeleteInvoiceAttachment, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
"Success": true
}]

Exemple : Résilier un abonnement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CancelSubscriptions, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

    4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister tous les paiements

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Payments dans la liste Entity.
  3. Sélectionnez l'opération List, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause en fonction de vos besoins de filtrage.

    5. Vous devez placer la valeur d'une filterClause entre des guillemets simples ('). Vous pouvez utiliser filterClause pour filtrer les enregistrements en fonction des colonnes.

Exemple : Obtenir les détails d'un paiement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Payments dans la liste Entity.
  3. Sélectionnez l'opération Get, puis cliquez sur OK.
  4. Définissez entityId sur "bb4756c7-38c0-426b-97aa-03b6443e7f16", qui est la clé à transmettre.
  5. Pour définir entityId, dans la section Data Mapper de Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez "bb4756c7-38c0-426b-97aa-03b6443e7f16" dans le champ Valeur d'entrée et choisissez entityId comme variable locale.

    6. La valeur de entityId doit être transmise directement, par exemple "bb4756c7-38c0-426b-97aa-03b6443e7f16". Ici, "bb4756c7-38c0-426b-97aa-03b6443e7f16" est la valeur de clé primaire unique.

    Si la transmission d'un seul entityId génère une erreur en raison de la présence de deux clés composites, vous pouvez utiliser filterClause pour transmettre la valeur.

Exemple : Supprimer un paiement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Payments dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Définissez entityId sur "62008bbe-effa-4341-9d29-eac7f67b84fe", qui est la clé à transmettre.
  5. Pour définir entityId, dans la section Data Mapper de Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez "62008bbe-effa-4341-9d29-eac7f67b84fe" dans le champ Valeur d'entrée et choisissez entityId comme variable locale.

    6. Si l'entité comporte deux clés métier ou clés primaires composites, vous pouvez définir la filterClause sur id='62008bbe-effa-4341-9d29-eac7f67b84fe' au lieu de spécifier l'entityId.

Exemple : Créer un paiement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Payments dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId ou connectorInputPayload comme variable locale. 
    {
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Exemple : Créer un remboursement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Refunds dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId ou connectorInputPayload comme variable locale. 
    {
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
  "Success": true
}

Exemple : Créer un abonnement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Subscriptions dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId ou connectorInputPayload comme variable locale. 
    {
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Créer un client

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Customers dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId ou connectorInputPayload comme variable locale. 
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Exemple : Créer une carte à joindre à un cadeau

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez GiftCards dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId ou connectorInputPayload comme variable locale. 
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Exemple : Mettre à jour une facture

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Invoices dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId, connectorInputPayload ou filterClause comme variable locale. 
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. Définissez entityId dans Data Mapper sur l'entité Invoices.
  6. Pour définir l'entityId, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId, connectorInputPayload ou filterClause comme variable locale.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    { }

Exemple : Mettre à jour un abonnement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Subscriptions dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId, connectorInputPayload ou filterClause comme variable locale. 
    {
  "Note": "Update Subscription"
}
  5. Définissez entityId dans Data Mapper sur l'entité Subscriptions.
  6. Pour définir l'entityId, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId, connectorInputPayload ou filterClause comme variable locale.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    { }

Exemple : Mettre à jour les informations de paiement

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez PayOuts dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId, connectorInputPayload ou filterClause comme variable locale. 
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. Définissez entityId dans Data Mapper sur l'entité PayOuts.
  6. Pour définir l'entityId, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez entityId, connectorInputPayload ou filterClause comme variable locale.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur '181352d9-94ef-4e86-8bb9-e3759472325f'.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    { }

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes