Shopify
透過 Shopify 連接器,您可以在 Shopify 上執行插入、刪除、更新和讀取作業。
支援的版本
這個連接器會將 Shopify 管理 API 模擬為關聯式資料庫。
事前準備
使用 Shopify 連接器前,請先完成下列工作:
- 在 Google Cloud 專案中:
- 確認已設定網路連線。如要瞭解網路模式,請參閱「網路連線」。
- 將 roles/connectors.admin IAM 角色授予設定連結器的使用者。
- 將下列 IAM 角色授予要用於連接器的服務帳戶:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
服務帳戶是特殊的 Google 帳戶類型,主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶,請建立服務帳戶。連接器和服務帳戶必須位於相同專案。詳情請參閱「建立服務帳戶」。
- 啟用下列服務:
secretmanager.googleapis.com(Secret Manager API)connectors.googleapis.com(Connectors API)
如要瞭解如何啟用服務,請參閱「啟用服務」。
如果專案先前未啟用這些服務或權限,系統會在設定連結器時提示您啟用。
設定連接器
連線專屬於資料來源。也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連結,請按照下列步驟操作:
- 在 Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。
- 按一下「+ 建立新項目」,開啟「建立連線」頁面。
- 在「位置」部分中,選擇連線的位置。
- 區域:從下拉式清單中選取位置。
如需所有支援區域的清單,請參閱「地點」一文。
- 點按「下一步」。
- 區域:從下拉式清單中選取位置。
- 在「連線詳細資料」部分,完成下列步驟:
- 連接器:從可用連接器的下拉式清單中選取「Shopify」。
- 連接器版本:從可用版本的下拉式清單中選取連接器版本。
- 在「連線名稱」欄位中,輸入連線執行個體的名稱。
連線名稱必須符合下列條件:
- 連線名稱可使用英文字母、數字或連字號。
- 字母必須為小寫。
- 連線名稱開頭必須是英文字母,結尾則須為英文字母或數字。
- 連結名稱不得超過 49 個字元。
- 視需要輸入連線執行個體的「Description」(說明)。
- 或者,可啟用 Cloud Logging,然後選取記錄層級。記錄層級預設為
Error。 - 服務帳戶:選取具備必要角色的服務帳戶。
- 視需要設定「連線節點設定」:
- 節點數量下限:輸入連線節點數量下限。
- 節點數量上限:輸入連線節點數量上限。
節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多,就需要越多節點;反之,處理的交易量越少,需要的節點就越少。如要瞭解節點對連接器定價的影響,請參閱「 連線節點定價」。如未輸入任何值,系統預設會將節點下限設為 2 (提高可用性),節點上限則設為 50。
- 每次通話最高點數:指定每次通話的點數費用。
- 結構定義:指定要連線的 Shopify 伺服器版本。
- (選用) 在「進階設定」部分,選取「使用 Proxy」核取方塊,為連線設定 Proxy 伺服器,並設定下列值:
-
「Proxy Auth Scheme」(Proxy 驗證配置):選取要用於 Proxy 伺服器的驗證類型。支援的驗證類型如下:
- 基本:基本 HTTP 驗證。
- 摘要:摘要 HTTP 驗證。
- Proxy 使用者:用於向 Proxy 伺服器驗證的使用者名稱。
- Proxy 密碼:使用者密碼的 Secret Manager 密碼。
-
Proxy SSL Type:連線至 Proxy 伺服器時要使用的 SSL 類型。支援的驗證類型如下:
- 自動:預設設定。如果網址是 HTTPS 網址,則會使用「通道」選項。如果網址是 HTTP 網址,系統會使用「永不」選項。
- 「Always」(一律):連線一律啟用 SSL。
- 「永不」:連線未啟用 SSL。
- 通道:連線是透過通道 Proxy 建立。Proxy 伺服器會開啟與遠端主機的連線,流量會透過 Proxy 來回傳送。
- 在「Proxy 伺服器」部分,輸入 Proxy 伺服器的詳細資料。
- (選用) 按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
- 點按「下一步」。
- 在「目的地」部分,輸入要連線的遠端主機 (後端系統) 詳細資料。
- 目的地類型:選取目的地類型。
- 如要指定目的地主機名稱或 IP 位址,請選取「主機位址」,然後在「主機 1」欄位中輸入位址。
- 如要建立私人連線,請選取「主機位址」,並使用 HTTPS 通訊協定新增為 SAP Gateway 建立的端點附件。
如要建立與後端系統的公開連線,並加強安全性,可以為連線設定靜態輸出 IP 位址,然後設定防火牆規則,只允許特定靜態 IP 位址。
如要輸入其他目的地,請按一下「+新增目的地」。
- 點按「下一步」。
- 目的地類型:選取目的地類型。
- 在「Authentication」部分,指定「Access Token」詳細資料。
- 點按「下一步」。
- 檢查:檢查連結和驗證詳細資料。
- 點選「建立」。
建立存取權杖和 API 憑證
- 登入 Shopify 帳戶。
- 在 Shopify 開發人員入口網站中,按一下「設定」。
- 依序選取「應用程式和銷售管道」>「開發應用程式」。
- 按一下「建立應用程式」。
- 在隨即顯示的對話方塊中輸入應用程式名稱,然後按一下「建立」。
- 在「總覽」頁面中,按一下「設定 Admin API 範圍」,然後選取應用程式的存取權。
- 按一下 [儲存]。
- 在「API Credentials」(API 憑證) 頁面中,選取「Install app」(安裝應用程式)。
- 在隨即顯示的對話方塊中,按一下「安裝」。
- 在「API 憑證」頁面中,選取「顯示權杖一次」,然後複製「API 管理員存取權權杖」,以便稍後設定連線的驗證方式。
- 從「API key」和「API secret key」欄位複製金鑰,稍後設定連線的驗證時會用到。
實體、作業和動作
所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化存取應用程式的物件。您會看到實體、作業和動作等抽象概念。
- 實體: 實體可以視為已連結應用程式或服務中的物件,或屬性集合。實體的定義與連接器到連接器不同。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。
不過,連接器可能不支援或沒有任何實體,在這種情況下,
Entities清單會是空白。 - 作業: 作業是指您可對實體執行的活動。您可以對實體執行下列任一操作:
從可用清單中選取實體,系統會產生該實體可用的作業清單。如需作業的詳細說明,請參閱「連結器」工作中的實體作業。 不過,如果連接器不支援任何實體作業,
Operations清單就不會列出這類不支援的作業。 - 動作: 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體,且因連接器而異。一般來說,動作會有一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,此時
Actions清單會是空白。
實體作業範例
範例 - 列出所有產品
這個範例會列出 Products 實體中的所有記錄。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「Products」。 - 選取「
List」作業,然後按一下「完成」。
範例 - 取得顧客詳細資料
這個範例會從 Customers 實體取得指定客戶的詳細資料。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「Customers」。 - 選取「
Get」作業,然後按一下「完成」。 - 輸入要擷取詳細資料的客戶實體 ID。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
365009521884E12。
範例 - 刪除訂單記錄
這個範例會從
Order 實體中刪除指定訂單。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「Order」。 - 選取「
Delete」作業,然後按一下「完成」。 - 輸入要刪除訂單的實體 ID。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
475009571483E15。
範例 - 新增顧客
這個範例會將指定客戶新增至 Customer 實體。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「Customer」。 - 選取「
Create」作業,然後按一下「完成」。 - 在「連線器」任務的「任務輸入內容」部分,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "FirstName": "Test", "LastName": "Customer5" }
執行這個範例後,連接器工作
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": 6448083206296 }
範例 - 在 DiscountCode 中建立記錄
這個範例會在 DiscountCode 實體中建立新記錄。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「DiscountCode」。 - 選取「
Create」作業,然後按一下「完成」。 - 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 部分中,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "PriceRuleId": 1.394097291568E12, "Code": "FREESHIP2025798" }
執行這個範例後,連接器工作
connectorOutputPayload輸出變數會傳回類似下列內容的回應:{ "Id": 1.97836790828E13, "PriceRuleId": null }
範例 - 在 Pricerule 中建立記錄
這個範例會在 Pricerule 實體中建立新記錄。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「Pricerule」。 - 選取「
Create」作業,然後按一下「完成」。 - 在「連線器」任務的「任務輸入內容」部分,按一下
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 實體中建立新記錄。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「ProductVariant」。 - 選取「
Create」作業,然後按一下「完成」。 - 在「連線器」任務的「任務輸入內容」部分,按一下
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 實體中指定客戶的詳細資料。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「Customer」。 - 選取「
Update」作業,然後按一下「完成」。 - 在「連線器」任務的「任務輸入內容」部分,按一下
connectorInputPayload,然後在Default Value欄位中輸入類似下列的值:{ "FirstName": "Test", "LastName": "Customer2" }
- 輸入要刪除的客戶實體 ID。
在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入
648400653532。或者,您也可以將 filterClause 設為
648400653532,而非指定 entityId。執行這個範例後,連接器工作
connectorOutputPayload輸出變數會傳回類似以下的回應:{ "Id": 648400653532 }
範例 - 更新 ProductVariant 中的記錄
這個範例會更新 ProductVariant 實體中的記錄。
- 在
Configure connector task對話方塊中,按一下Entities。 - 從「
Entity」清單中選取「ProductVariant」。 - 選取「
Update」作業,然後按一下「完成」。 - 在「連線器」任務的「任務輸入內容」部分,按一下
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 }
- 指定要更新的記錄實體 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 伺服器。 |
| proxy_auth_scheme | ENUM | 否 | 用於向 ProxyServer Proxy 驗證的驗證類型。支援的值包括:BASIC、DIGEST、NONE |
| proxy_user | STRING | 否 | 用於向 ProxyServer Proxy 驗證的使用者名稱。 |
| proxy_password | SECRET | 否 | 用於向 ProxyServer Proxy 驗證身分的密碼。 |
| proxy_ssltype | ENUM | 否 | 連線至 ProxyServer Proxy 時要使用的 SSL 類型。支援的值包括:AUTO、ALWAYS、NEVER、TUNNEL |
在整合中運用 Shopify 連結
建立連線後,Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。
- 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作,請參閱「連接器工作」。
- 如要瞭解如何在 Application Integration 中建立及使用連接器工作,請參閱「連接器工作」。