Shopify

借助 Shopify 连接器，您可以对 Shopify 执行插入、删除、更新和读取操作。

支持的版本

此连接器将 Shopify Admin API 建模为关系型数据库。

准备工作

在使用 Shopify 连接器之前，请先完成以下任务：

  • 在您的 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. 连接器：从可用连接器的下拉列表中选择 Shopify。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. （可选）输入连接实例的说明。
    5. （可选）启用 Cloud Logging。 然后选择一个日志级别默认情况下，日志级别设置为 Error。
    6. 服务账号：选择具有所需角色的服务账号。
    7. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

    8. 应用 ID：Admin API 的 AppId。
    9. 每次调用的最大点数：指定每次调用的成本点。
    10. 架构：指定要连接的 Shopify 服务器版本。
    11. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
      • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
        • 基本：基本 HTTP 身份验证。
        • 摘要：摘要 HTTP 身份验证。
      • 代理用户：用于向代理服务器进行身份验证的用户名。
      • 代理密码：用户密码的 Secret Manager 密文。
      • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
        • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
        • 始终：连接始终启用 SSL。
        • 永不：连接未启用 SSL。
        • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
      • 在代理服务器部分中，输入代理服务器的详细信息。
        1. 点击+ 添加目标。
        2. 选择目标类型。
          • 主机地址：指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接，请执行以下操作：

    12. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    13. 点击下一步。
  5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
    1. 目的地类型：选择目的地类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

      要输入其他目标，请点击 + 添加目标。

    2. 点击下一步。
  6. 在 Authentication（身份验证）部分中，输入身份验证详细信息。
    1. Shopify 连接不需要任何身份验证。
    2. 点击下一步。
  7. 查看：查看您的连接和身份验证详细信息。
  8. 点击创建。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

    但是，连接器可能不支持或不支持任何实体，在这种情况下， “Entities”列表将为空。

  • 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：

    从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作， 操作未在 Operations 列表中列出。

  • 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作有一些输入参数和一个输出 参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

实体操作示例

示例 - 列出所有商品

以下示例列出了 Products 实体中的所有记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Products。
  3. 选择 List 操作，然后点击完成。

示例 - 获取客户详细信息

以下示例会从 Customers 实体获取指定客户的详细信息。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Customers。
  3. 选择 Get 操作，然后点击 完成。
  4. 输入要提取其详细信息的客户的实体 ID。

    在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 365009521884E12。

示例 - 删除订单记录

此示例会从 Order 实体中删除指定的订单。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Order。
  3. 选择 Delete 操作，然后点击 完成。
  4. 输入要删除的订单的实体 ID。

    在连接器任务的任务输入部分， 点击 entityId，然后输入 475009571483E15 默认值字段。

示例 - 添加客户

此示例将指定客户添加到 Customer 实体中。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Customer。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"FirstName": "Test",
"LastName": "Customer5"
}

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

    {
"Id": 6448083206296
}

示例 - 在 DiscountCode 中创建记录

此示例在 DiscountCode 实体中创建了一条新记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 DiscountCode。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}

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

    {
"Id": 1.97836790828E13,
"PriceRuleId": null
}

示例 - 在 Pricerule 中创建记录

此示例在 Pricerule 实体中创建了一条新记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Pricerule。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Id": 7.13459564696E11,
"AllocationMethod": "each",
"CustomerSelection": "all",
"TargetType": "line_item",
"UsageLimit": 100.0,
"Title": "DP_PriceRule"
}

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

    {
"Id": 197836790834,
"PriceRuleId": null
}

示例 - 在 ProductVariant 中创建记录

此示例会在 ProductVariant 实体中创建新记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 ProductVariant。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Id": 1070325065,
"ProductId": 7652181016728,
"ImageId": null,
"Price": 1,
"CompareAtPrice": null,
"Title": "Yellow",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryPolicy": "deny",
"InventoryQuantity": 1070325069,
"Option1": "Yellow",
"Option2": null,
"Option3": null,
"Position": 5,
"Sku": "",
"Taxable": true
}

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

    {
"Id": 42711984373912
}

示例 - 更新客户详细信息

此示例更新了 Customer 实体中指定客户的详细信息。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Customer。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"FirstName": "Test",
"LastName": "Customer2"
}
  5. 输入要删除的客户的实体 ID。

    在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 648400653532。

    或者，您也可以将 filterClause 设置为 648400653532，而不是指定 entityId。

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

    {
"Id": 648400653532
}

示例 - 在 ProductVariant 中更新记录

此示例会更新 ProductVariant 实体中的记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 ProductVariant。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"ProductId": 7.652181016728E12,
"ImageId": null,
"Price": 200.0,
"CompareAtPrice": null,
"Title": "Yellow Updated",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryQuantity": 1.070325069E9,
"Option1": "Yellow new",
"Option2": null,
"Option3": null,
"Position": 5.0,
"Sku": "",
"Taxable": true
}
  5. 指定要更新的记录的实体 ID。

    如需设置实体 ID 点击 entityId，然后在 Default Value 中输入 34601602744472 字段。

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

    {
"Id": 2484258073471
}

使用 Terraform 创建连接

您可以使用 Terraform 资源以创建新连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅模板示例。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称 数据类型 必需 说明
max_points_per_call STRING 错误 指定通话的积分数。
schema_v23 ENUM 错误 指定要连接的 Shopify 服务器版本。支持的值包括：REST-2023-04、REST-2023-07、GRAPHQL-2023-04、GRAPHQL-2023-07
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 Shopify 连接

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

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

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛。

后续步骤