從您選擇的程式碼輔助工具取得 Merchant API 的情境智慧。在整合式開發環境 (IDE) 中,您現在可以使用 Model Context Protocol (MCP) 服務,存取開發人員說明文件整合功能。這項服務會根據 Google 官方 API 說明文件,為程式碼輔助工具提供權威的背景資訊,加快整合及遷移工作流程的開發速度。
如要進一步瞭解通訊協定本身,請參閱 Model Context Protocol 標準。
總覽
從 Content API for Shopping 遷移至 Merchant API,或建構新的整合時,您需要瞭解新的服務結構、資源名稱和方法。MCP 服務會將官方文件和程式碼範例提供給程式設計助理,簡化這項作業。
這項服務採用高度專業的檢索增強生成 (RAG) 後端。當你向啟用 MCP 的 IDE 程式碼輔助工具詢問 Merchant API 相關問題時,這項服務會從 Google 官方資源擷取最相關的文字和程式碼片段,並以脈絡的形式傳回給程式碼輔助工具。這樣一來,助理就能提供準確且符合現況的答案,您完全不必離開開發環境。
運作方式
使用 MCP 整合開發人員說明文件,可整合至現代化的 AI 輔助開發工作流程:
- 在與 MCP 相容的程式碼輔助工具或 Agent 中提出問題。這可以是自然語言問題,也可以是要求提供 Merchant API 方法實作的程式碼範例。
- 程式碼輔助工具會向 MCP 端點傳送要求,索取背景資訊。
- MCP 服務會搜尋已建立索引的官方 Merchant API 文件、指南和程式碼範例,找出最相關的資訊。
- 這項服務會將這些權威程式碼片段做為背景資訊,提供給程式碼撰寫助理。
- 程式碼助理會使用這項優質背景資訊,針對您原先的問題生成精確實用的答案。
開始使用
如要使用 MCP,您需要支援 Model Context Protocol 的 IDE 或程式碼助理,並搭配可串流的 HTTP 傳輸。
端點設定
如要將工具連線至服務,請使用提供的遠端端點詳細資料,視工具設定而定,您可能需要輸入直接服務網址或 MCP 定義。
服務網址為:
MCP Server Name: "MAPI Docs MCP"
MCP Server URL: "https://merchantapi.googleapis.com/devdocs/mcp/"
應用情境示例
在這些常見用途中,MCP 可加快工作流程。
情境 1:遷移舊版 API 呼叫
您現有的應用程式使用 Content API for Shopping,且需要更新。您可以詢問特定舊版方法,瞭解新實作方式的詳細資料和相關程式碼範例。
使用者提示:
「在 Content API for Shopping 中,accountstatuses.get 方法的 Merchant API 對應項目為何?」
MCP 服務會提供官方遷移指南和參考文件中的背景資訊,讓助理提供詳細的答案,包括新的 API 名稱 accounts.issues
。
情境 2:尋找程式碼範例
您要導入新功能,需要實用範例做為參考。
使用者提示:
「Show me a Python code sample for adding a new shipping service using Merchant API.」(請提供 Python 程式碼範例,說明如何使用 Merchant API 新增運送服務)。
MCP 服務會從官方 Google GitHub 存放區和開發人員指南中,擷取相關程式碼範例。然後,Google 助理就能提供完整的程式碼區塊,方便您直接採用。
情境 3:瞭解 API 概念
您遇到新概念,或想瞭解資源結構或整體 Merchant API 模式。
使用者提示:
「如何使用 Merchant API 更新產品的庫存?」
MCP 服務會從產品資源說明文件和相關指南傳回內容。然後,助理會說明如何使用 accounts.productInputs.insert
方法,並提供只包含 productId
和需要更新的目錄相關欄位的部分產品資源。
「如何使用 Merchant API 授權應用程式呼叫?」
MCP 服務會從官方驗證指南擷取內容,其中涵蓋不同的授權方法。然後,助理可以說明可用的主要選項,例如使用服務帳戶進行伺服器對伺服器互動,或代表使用者執行動作時使用 OAuth 2.0 用戶端 ID。
情境 4:因應 API 變更
Merchant API 導入了新的模式 (例如批次處理要求),與 Content API for Shopping 不同。Content API for Shopping 使用特定 custombatch
方法,而 Merchant API 則使用內建的通用 HTTP 批次處理功能。
使用者提示:
「在 Merchant API 中,產品自訂批次的新做法是什麼?」
MCP 服務會從「重構程式碼以處理並行要求」一文擷取背景資訊,說明 Merchant API 中沒有專屬的 custombatch
方法。而是提供使用 HTTP 批次處理的說明文件,並搭配 Content-Type
的 multipart
。然後,助理會說明如何建構單一 HTTP 要求,其中包含多個 API 呼叫,並傳送至 https://merchantapi.googleapis.com/batch/{sub-api}/v1
端點,還會提供多部分要求結構的範例。這項功能可將可能令人困惑的遷移工作,轉變成引導式程序。
知識庫來源
MCP 服務的知識庫完全是根據公開和官方來源建立,確保提供的內容準確可靠。這項服務會為官方開發人員網站和程式碼範例存放區的完整內容建立索引,包括:
- Merchant API 開發人員網站:所有指南、參考資料和說明文件。
- Merchant API Apps Script 服務: 從 Apps Script 使用 Merchant API 的範例。
- 官方程式碼範例: GitHub 存放區中所有官方的 Merchant API 程式碼範例,皆由 Google 提供。
- 用戶端程式庫: Merchant 支援的所有官方用戶端程式庫