方形

借助 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. 点击下一步。
  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. 在身份验证部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

      Square 连接支持以下身份验证类型：

      • OAuth 2.0 - 授权代码
      • 个人访问令牌

      如需了解如何配置这些身份验证类型，请参阅配置身份验证。

    2. 点击下一步。
  6. 查看：查看您的连接和身份验证详细信息。
  7. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • OAuth 2.0 - 授权代码
    • 客户端 ID：输入要用于连接的客户端 ID。
    • 范围：输入以英文逗号分隔的所需范围列表。
    • 客户端密钥：输入用于 Square 连接的客户端密钥。
    • 密文版本：为上面选择的密文选择密文版本。
    • 授权网址：输入创建客户端时生成的授权网址。
    • 启用身份验证替换：指定是否为连接启用替换身份验证。
  • 个人访问令牌
    • 个人访问令牌：输入要用于连接的个人访问令牌。
    • 密文版本：为上面选择的密文选择密文版本。
    • 启用身份验证替换：指定是否为连接启用替换身份验证。

连接配置示例

本部分列出了您在创建连接时配置的各个字段的示例值。

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
Secret 版本 1
授权网址 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
Secret 版本 1

系统限制

Square 连接器每秒最多可以处理 16 笔交易（每节点），并且会限制超出此限额的任何交易。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

在集成中使用 Square 连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过“连接器”任务在集成中使用该连接。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
  • 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

操作

本部分介绍如何在此连接器中执行一些操作。

CancelPayment 操作

此操作会取消付款。

CancelPayment 操作的输入参数

参数名称 数据类型 必需 说明
PaymentId 字符串 True 要取消的付款的 ID。

如需查看有关如何配置 CancelPayment 操作的示例，请参阅示例。

CompletePayment 操作

此操作用于完成付款。

CompletePayment 操作的输入参数

参数名称 数据类型 必需 说明
PaymentId 字符串 True 要完成的付款的 ID。

如需查看有关如何配置 CompletePayment 操作的示例，请参阅示例。

CancelPaymentByIdempotencyKey 操作

此操作会使用付款的幂等键取消付款。

CancelPaymentByIdempotencyKey 操作的输入参数

参数名称 数据类型 必需 说明
IdempotencyKey 字符串 True 用于标识要取消的付款的幂等性密钥。

如需查看有关如何配置 CancelPaymentByIdempotencyKey 操作的示例，请参阅示例。

CancelInvoice 操作

此操作会取消账单。

CancelInvoice 操作的输入参数

参数名称 数据类型 必需 说明
InvoiceId 字符串 True 要取消的账单的 ID。
InvoiceVersion 字符串 True 要取消的账单的版本。

如需查看有关如何配置 CancelInvoice 操作的示例，请参阅示例。

PublishInvoice 操作

此操作会发布账单。

PublishInvoice 操作的输入参数

参数名称 数据类型 必需 说明
InvoiceId 字符串 True 要发布的账单的 ID。
InvoiceVersion Int32 True 要发布的账单的版本。此值必须与账单的当前版本一致；否则，系统会拒绝相应请求。

如需查看有关如何配置 PublishInvoice 操作的示例，请参阅示例。

DeleteInvoiceAttachment 操作

此操作会删除账单附件。

DeleteInvoiceAttachment 操作的输入参数

参数名称 数据类型 必需 说明
InvoiceId 字符串 True 要删除的附件所在账单的 ID。
AttachmentId 字符串 True 要删除的附件的 ID。

如需查看有关如何配置 DeleteInvoiceAttachment 操作的示例，请参阅示例。

CancelSubscriptions 操作

此操作会取消订阅。

CancelSubscriptions 操作的输入参数

参数名称 数据类型 必需 说明
ID 字符串 True 要取消的订阅的 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" 是唯一的主键值。

    如果传递单个 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. 如果实体具有两个复合业务键或主键，您也可以将 filterClause 设置为 id='62008bbe-effa-4341-9d29-eac7f67b84fe'，而不是指定 entityId。

示例 - 创建付款

  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 作为局部变量。

    您也可以将 filterClause 设置为 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'，而不是指定 entityId。

    运行此示例后，连接器任务的 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 作为局部变量。

    您也可以将 filterClause 设置为 '40da986b-08e4-45bf-9ba2-d11cf9f589fb'，而不是指定 entityId。

    运行此示例后，连接器任务的 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. 在 Data Mapper 中将 entityId 设置为 PayOuts 的实体。
  6. 如需设置 entityId，请点击 Open Data Mapping Editor，然后在 Input Value 字段中输入类似于以下内容的值，并选择 entityId、connectorInputPayload 或 filterClause 作为局部变量。

    您也可以将 filterClause 设置为 '181352d9-94ef-4e86-8bb9-e3759472325f'，而不是指定 entityId。

    运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

    { }

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤