正方形

Square コネクタを使用すると、Square データに対して挿入、削除、更新、読み取りのアクションを実行できます。

サポート対象のバージョン

このコネクタは Square バージョン 1.0 をサポートしています。

始める前に

Square コネクタを使用する前に、次の作業を行います。

  • Google Cloud プロジェクトで次の操作を行います。
    • コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
    • コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。

    • 次のサービスを有効にします。
      • secretmanager.googleapis.com（Secret Manager API）
      • connectors.googleapis.com（Connectors API）

      サービスを有効にする方法については、サービスを有効にするをご覧ください。

    以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

  1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [接続] ページに移動

  2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
  3. [ロケーション] セクションで、接続のロケーションを選択します。
    1. リージョン: プルダウン リストからロケーションを選択します

      サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。

    2. [NEXT] をクリックします。
  4. [接続の詳細] セクションで、次の操作を行います。
    1. コネクタ: 使用可能なコネクタのリストから [Square] を選択します。
    2. コネクタのバージョン: 使用可能なバージョンのリストからコネクタのバージョンを選択します。
    3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
    4. 説明: 接続インスタンスの説明を入力します。
    5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
    6. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
    7. スキーマ: 接続のスキーマ（v1 や v2 など）を指定します。
    8. サンドボックスを使用する: 接続にサンドボックス環境を使用するかどうかを指定します。
    9. ロケーション ID: 接続のロケーション ID を指定します。
    10. 必要に応じて、接続ノードの設定を構成します。

      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

    11. + ラベルを追加: これをクリックして、Key-Value ペアの形式でラベルを接続に追加します。
    12. [NEXT] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

      Square 接続でサポートされる認証タイプは次のとおりです。

      • OAuth 2.0 - 認証コード
      • 個人用アクセス トークン

      これらの認証タイプの構成方法については、認証を構成するをご覧ください。

    2. [NEXT] をクリックします。
  6. Review: 接続と認証の詳細を確認します。
  7. [作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

  • OAuth 2.0 - 認証コード
    • クライアント ID: 接続に使用するクライアント ID を入力します。
    • スコープ: 必要なスコープをカンマ区切りのリストで入力します。
    • クライアント シークレット: Square 接続に使用するクライアント シークレットを入力します。
    • シークレット バージョン: 上で選択したシークレットのシークレット バージョンを選択します。
    • 認証 URL: クライアントの作成時に生成された認証 URL を入力します。
    • 認証オーバーライドを有効にする: 接続の認証オーバーライドを有効にするかどうかを指定します。
  • 個人用アクセス トークン
    • Personal Access Token: 接続に使用する個人用アクセス トークンを入力します。
    • シークレット バージョン: 上で選択したシークレットのシークレット バージョンを選択します。
    • 認証オーバーライドを有効にする: 接続の認証オーバーライドを有効にするかどうかを指定します。

接続構成のサンプル

このセクションでは、接続の作成時に構成するさまざまなフィールドのサンプル値を示します。

OAuth 2.0 - 認証コードの接続タイプ

フィールド名 詳細
ロケーション us-central1
コネクタ 正方形
コネクタのバージョン 1
接続名 square-oauth-ai
Cloud Logging を有効にする true
サービス アカウント my-service-account@my-project.iam.gserviceaccount.com
スキーマ v2
ノードの最小数 2
ノードの最大数 50
認証 OAuth 2.0 - 認証コード
クライアント ID CLIENT_ID
スコープ 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
クライアント シークレット CLIENT_SECRET
シークレットのバージョン 1
認証 URL https://connect.squareup.com/oauth2/authorize

個人用アクセス トークンの接続タイプ

フィールド名 詳細
場所 asia-east1
コネクタ 正方形
コネクタのバージョン 1
接続名 square-pat-prod-conn
Cloud Logging を有効にする true
サービス アカウント my-service-account@my-project.iam.gserviceaccount.com
スキーマ v2
サンドボックスを使用する true
ノードの最小数 2
ノードの最大数 50
認証 個人用アクセス トークン
個人用アクセス トークン PERSONAL_ACCESS_TOKEN
シークレットのバージョン 1

システムの上限

Square コネクタは、ノードごとに 1 秒あたり最大 16 件のトランザクションを処理し、この上限を超えるトランザクションをスロットル調整します。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

統合で Square 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

  • Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
  • Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

操作

このセクションでは、このコネクタでアクションの一部を実行する方法について説明します。

CancelPayment アクション

この操作を行うと、支払いがキャンセルされます。

CancelPayment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
PaymentId 文字列 正しい キャンセルする支払いの ID。

CancelPayment アクションの構成例については、例をご覧ください。

CompletePayment アクション

このアクションは支払いを完了します。

CompletePayment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
PaymentId 文字列 正しい 完了する支払いの ID。

CompletePayment アクションの構成例については、例をご覧ください。

CancelPaymentByIdempotencyKey アクション

このアクションは、べき等キーを使用して支払いをキャンセルします。

CancelPaymentByIdempotencyKey アクションの入力パラメータ

パラメータ名 データ型 必須 説明
IdempotencyKey 文字列 正しい キャンセルする支払いを識別するために使用されるべき等性キー。

CancelPaymentByIdempotencyKey アクションの構成例については、例をご覧ください。

CancelInvoice アクション

このアクションにより、請求書がキャンセルされます。

CancelInvoice アクションの入力パラメータ

パラメータ名 データ型 必須 説明
InvoiceId 文字列 正しい キャンセルする請求書の ID。
InvoiceVersion 文字列 正しい キャンセルする請求書のバージョン。

CancelInvoice アクションの構成例については、例をご覧ください。

PublishInvoice アクション

このアクションは請求書を公開します。

PublishInvoice アクションの入力パラメータ

パラメータ名 データ型 必須 説明
InvoiceId 文字列 正しい 公開する請求書の ID。
InvoiceVersion Int32 正しい 公開する請求書のバージョン。これは請求書の現在のバージョンと一致している必要があります。一致していない場合、リクエストは拒否されます。

PublishInvoice アクションの構成例については、例をご覧ください。

DeleteInvoiceAttachment アクション

このアクションにより、請求書の添付ファイルが削除されます。

DeleteInvoiceAttachment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
InvoiceId 文字列 正しい 削除する添付ファイルを含む請求書の ID。
AttachmentId 文字列 正しい 削除する添付ファイルの ID。

DeleteInvoiceAttachment アクションの構成例については、例をご覧ください。

CancelSubscriptions アクション

この操作を行うと、定期購入が解約されます。

CancelSubscriptions アクションの入力パラメータ

パラメータ名 データ型 必須 説明
ID 文字列 正しい 解約する定期購入の ID。

CancelSubscriptions アクションの構成例については、例をご覧ください。

アクションの例

このセクションでは、このコネクタでアクションの例の一部を実行する方法について説明します。

例 - お支払いをキャンセルする

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [CancelPayment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [
  {
    "Success": true
  }
]

例 - 支払いを完了する

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [CompletePayment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
"Success": true
}]

例 - べき等キーを使用して支払いをキャンセルする

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [CancelPaymentByIdempotencyKey] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
"Success": true
}]

例 - 請求書をキャンセルする

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [CancelInvoice] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

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

例 - 請求書を公開する

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [PublishInvoice] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

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

例 - 請求書の添付ファイルを削除する

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [DeleteInvoiceAttachment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
"Success": true
}]

例 - サブスクリプションを解約する

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [CancelSubscriptions] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

    4. アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

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

}]

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

例 - すべての支払いを一覧表示する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Payments を選択します。
  3. [List] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、フィルタリングの要件に基づいて filterClause を設定できます。

    5. filterClause の値を囲むには、単一引用符（'）を使用する必要があります。filterClause を使用すると、列に基づいてレコードをフィルタできます。

例 - お支払いの詳細を取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Payments を選択します。
  3. [Get] オペレーションを選択し、[完了] をクリックします。
  4. entityId を "bb4756c7-38c0-426b-97aa-03b6443e7f16" に設定します。これは渡されるキーです。
  5. entityId を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに "bb4756c7-38c0-426b-97aa-03b6443e7f16" を入力し、entityId をローカル変数として選択します。

    6. entityId の値は直接渡す必要があります（"bb4756c7-38c0-426b-97aa-03b6443e7f16" など）。ここで、"bb4756c7-38c0-426b-97aa-03b6443e7f16" は一意の主キー値です。

    2 つの複合キーが存在するために単一の entityId を渡すとエラーがスローされる場合は、filterClause を使用して値を渡すことができます。

例 - 支払いを削除する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Payments を選択します。
  3. [Delete] オペレーションを選択し、[完了] をクリックします。
  4. entityId を "62008bbe-effa-4341-9d29-eac7f67b84fe" に設定します。これは渡されるキーです。
  5. entityId を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに "62008bbe-effa-4341-9d29-eac7f67b84fe" を入力し、entityId をローカル変数として選択します。

    6. エンティティに 2 つの複合ビジネスキーまたは主キーがある場合は、entityId を指定する代わりに、filterClause を id='62008bbe-effa-4341-9d29-eac7f67b84fe' に設定することもできます。

例 - 支払いを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Payments を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、ローカル変数として entityId または connectorInputPayload を選択します。
    {
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータには次に似た値が含まれます。

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

例 - 払い戻しを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Refunds を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、ローカル変数として entityId または connectorInputPayload を選択します。
    {
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Success": true
}

例 - サブスクリプションを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Subscriptions を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、ローカル変数として entityId または connectorInputPayload を選択します。
    {
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

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

例 - 顧客を作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Customers を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、ローカル変数として entityId または connectorInputPayload を選択します。
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

例 - ギフトカードを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から GiftCards を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、ローカル変数として entityId または connectorInputPayload を選択します。
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

    統合が成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

例 - 請求書を更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Invoices を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、entityId、connectorInputPayload、または filterClause をローカル変数として選択します。
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. データマッパーで entityId を請求書のエンティティに設定します。
  6. entityId を設定するには、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、entityId、connectorInputPayload、または filterClause をローカル変数として選択します。

    [entityId] を指定する代わりに、[filterClause] を 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO' に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    { }

例 - サブスクリプションを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から Subscriptions を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、entityId、connectorInputPayload、または filterClause をローカル変数として選択します。
    {
  "Note": "Update Subscription"
}
  5. データマッパーで entityId をサブスクリプションのエンティティに設定します。
  6. entityId を設定するには、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、entityId、connectorInputPayload、または filterClause をローカル変数として選択します。

    [entityId] を指定する代わりに、[filterClause] を '40da986b-08e4-45bf-9ba2-d11cf9f589fb' に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    { }

例 - お支払い情報を更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity から PayOuts を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、entityId、connectorInputPayload、または filterClause をローカル変数として選択します。
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. データマッパーで entityId を PayOuts のエンティティに設定します。
  6. entityId を設定するには、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、entityId、connectorInputPayload、または filterClause をローカル変数として選択します。

    [entityId] を指定する代わりに、[filterClause] を '181352d9-94ef-4e86-8bb9-e3759472325f' に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    { }

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

次のステップ