正方形

您可以使用 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」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「位置」部分中，選擇連線的位置。
    1. 區域：從下拉式清單中選取位置。

      如需所有支援區域的清單，請參閱「地點」一文。

    2. 點按「下一步」。
  4. 在「連線詳細資料」部分，完成下列步驟：
    1. 連接器：從可用連接器清單中選取「Square」。
    2. 連接器版本：從可用版本清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
    4. 說明：輸入連線執行個體的說明。
    5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
    6. 服務帳戶：選取具備必要角色的服務帳戶。
    7. 結構定義：指定連線的結構定義，例如 v1 或 v2。
    8. 使用沙箱：指定是否要使用沙箱環境建立連線。
    9. 地區 ID：指定連線的地區 ID。
    10. 視需要設定「連線節點設定」：

      • 節點數下限：輸入連線節點的數量下限。
      • 節點數上限：輸入連線節點數上限。

      節點是用來處理交易的連線單位 (或備用資源)。如要處理更多連線交易，就需要更多節點；反之，如要處理較少的交易，則需要較少的節點。如要瞭解節點對連線器價格的影響，請參閱「 連線節點的定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

    11. + 新增標籤：按一下這個按鈕，即可為連線新增鍵/值組合形式的標籤。
    12. 點按「下一步」。
  5. 在「Authentication」(驗證) 部分，輸入驗證詳細資料。
    1. 選取「驗證類型」，然後輸入相關詳細資料。

      Square 連線支援下列驗證類型：

      • OAuth 2.0 - 授權碼
      • 個人存取權杖

      如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點按「下一步」。
  6. 檢查：檢查連結和驗證詳細資料。
  7. 點選「建立」。

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • OAuth 2.0 - 授權碼
    • 「Client ID」(用戶端 ID)：輸入要用於連線的用戶端 ID。
    • 範圍：輸入所需範圍，並以半形逗號分隔。
    • 用戶端密鑰：輸入要用於 Square 連線的用戶端密鑰。
    • 密鑰版本：選取上述所選密鑰的密鑰版本。
    • 授權網址：輸入建立用戶端時產生的授權網址。
    • 啟用驗證覆寫：指定是否要為連線啟用覆寫驗證。
  • 個人存取權杖
    • 個人存取權杖：輸入用於連線的個人存取權杖。
    • 密鑰版本：選取上述所選密鑰的密鑰版本。
    • 啟用驗證覆寫：指定是否要為連線啟用覆寫驗證。

連線設定範例

本節列出建立連線時設定各個欄位的範例值。

OAuth 2.0 - 授權碼連線類型

Fieldname 詳細資料
位置 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
授權網址 https://connect.squareup.com/oauth2/authorize

個人存取權杖連線類型

Fieldname 詳細資料
位置 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 連接器每秒最多可處理 16 筆交易，超過此限制的交易都會遭到節流。根據預設，Integration Connectors 會為連線分配 2 個節點 (提高可用性)。

如要瞭解 Integration Connectors 適用的限制，請參閱「限制」一文。

在整合服務中使用 Square 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作，請參閱「連接器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用連接器工作，請參閱「連接器工作」。

動作

本節說明如何在這個連接器中執行部分動作。

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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

    4. 如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：

    [
  {
    "Success": true
  }
]

範例 - 完成付款

  1. 在 Configure connector task 對話方塊中，按一下 Actions。
  2. 選取「CompletePayment」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

    4. 如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：

    [{
"Success": true
}]

範例 - 使用冪等鍵取消付款

  1. 在 Configure connector task 對話方塊中，按一下 Actions。
  2. 選取「CancelPaymentByIdempotencyKey」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

    4. 如果動作成功，連接器工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Success": true
}]

範例 - 取消月結單

  1. 在 Configure connector task 對話方塊中，按一下 Actions。
  2. 選取「CancelInvoice」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 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. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
  "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

    4. 如果動作成功，連接器工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Success": true
}]

範例 - 取消訂閱

  1. 在 Configure connector task 對話方塊中，按一下 Actions。
  2. 選取「CancelSubscriptions」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 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" 是不重複的主鍵值。

    如果傳遞單一 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. 如果實體有兩個複合式商家或主鍵，除了指定 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 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟