使用 API 整合和 Code Assist 工具包,加速遷移至 Merchant API,並透過 AI 輔助開發工具建構新的整合功能。
總覽
從 Content API for Shopping 遷移至 Merchant API,或是建構新的整合時,您需要瞭解新的服務結構、資源名稱和方法。AI 輔助開發工具特別適合協助執行下列作業:
- 程式碼翻譯和遷移:協助你瞭解舊版 Content API for Shopping 程式碼,並轉換為新版 Merchant API 格式。包括將產品屬性對應至新結構,以及更新依附元件管理檔案。
- API 說明文件專業知識:根據 Google 官方 API 說明文件的權威內容,清楚說明 Merchant API 資源、方法、欄位、配額和最佳做法。
- 程式碼生成:以 Python、Java、PHP 等語言,生成各種 Merchant API 工作適用的程式碼片段。
- 疑難排解:協助診斷及修正常見的 API 錯誤。
請選擇最適合開發環境和特定用途的選項。使用 API 整合和程式碼輔助工具包,根據偏好的工作流程調整設定:
- Merchant API 開發人員說明文件 MCP 伺服器 ,用於直接擷取內容
- Merchant API 代理程式技能 提供工作流程導向的指引
下圖說明在最常用的整合式開發環境 (IDE) (例如 Antigravity、Visual Studio Code、Cursor 或 Copilot) 中,使用 AI 輔助程式碼遷移的設定選項。你可以設定 Gemini、Claude、ChatGPT、Grok 等程式設計助理,並透過 Merchant API 開發人員說明文件 MCP 伺服器或 Merchant API 代理程式技能,讓這些助理在整合作業中更貼近現實,同時加快整合速度。
Merchant API 開發人員說明文件 MCP 伺服器
從您選擇的程式碼輔助工具取得 Merchant API 的情境智慧。現在您可以在 IDE 中,使用 Model Context Protocol (MCP) 服務存取開發人員說明文件。這項服務會從 Google API 官方說明文件提供重要資訊給程式碼輔助工具。如要進一步瞭解通訊協定本身,請參閱模型內容通訊協定標準。
運作方式
當您向啟用 MCP 的 IDE 程式碼助理詢問 Merchant API 相關問題時,這項服務會從官方資源擷取最相關的文字和程式碼片段,並使用專門的擷取擴增生成 (RAG) 後端,將這些片段做為背景資訊傳回給程式碼助理。RAG 系統會連結至外部最新知識來源,藉此提升 LLM 的回覆品質。這樣一來,助理就能提供準確且符合現況的答案,您也不必離開開發環境。
工作流程範例:
- 在與 MCP 相容的程式設計助理或代理程式中提出問題 (例如自然語言問題、要求程式碼範例或程式碼翻譯)。
- 程式碼輔助工具會向 MCP 端點傳送要求,索取背景資訊。
- MCP 服務會搜尋已建立索引的官方 Merchant API 說明文件、指南和程式碼範例。
- 這項服務會傳回權威程式碼片段,做為程式碼助理的背景資訊。
- 程式設計助理會運用這些背景資訊,生成有根據的答案或程式碼翻譯工作。
開始使用
如要整合及使用 MCP,請按照下列步驟操作:
1. 使用相容的工具
開啟支援 Model Context Protocol 的 IDE 或程式碼輔助工具,並使用可串流的 HTTP 傳輸。
2. 設定端點
如要將 IDE 或程式碼助理連線至 MCP,請使用提供的遠端端點詳細資料,視工具設定而定,您可能需要輸入直接服務網址或 MCP 定義:
設定配置:
Antigravity
請按照Antigravity 說明文件中的指示操作。
"mcpServers": {
"mapi-devdocs": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://merchantapi.googleapis.com/devdocs/mcp"
]
}
}
Visual Studio Code
請按照 Visual Studio Code 說明文件中的指示操作。
"servers": {
"mapi-devdocs": {
"type": "http",
"url": "https://merchantapi.googleapis.com/devdocs/mcp/"
}
}
3. 新增代理指示 (選用)
如要讓代理程式直接使用 MCP 翻譯程式碼,請提供「系統指令:商家整合代理程式通訊協定」。這些指示會引導服務專員正確使用 MCP 翻譯程式碼。視工具而定,您可以在系統指令設定中提供這些指令,也可以將指令做為代理程式的額外內容檔案。
應用情境示例
在下列常見用途中,MCP 可加快工作流程:
情境 1:遷移 products.insert 程式碼
你可以要求專員直接將 Content API for Shopping 整合程式碼遷移至 Merchant API。products.insert
使用者提示:
「將
products.insert程式碼遷移至 Merchant API」
只要提供系統指令給代理程式,並授予 MCP 存取權,代理程式就能直接在 IDE 中,將 Content API for Shopping 程式碼轉換為 Merchant API 程式碼。在本例中,系統會將 productInputs.insert 識別為對等呼叫,並將舊格式的產品屬性對應至 Merchant API 規定的新格式。此外,也可以更新必要匯入項目和依附元件管理檔案 (例如 requirements.txt、pom.xml 或 package.json)。您可以指示代理程式直接進行變更,或建立新資料夾。
情境 2:尋找對等功能
您現有的應用程式使用 Content API for Shopping,且需要更新。您可以詢問特定舊版方法,瞭解新實作方式的詳細資料和相關程式碼範例。
使用者提示:
「在 Content API for Shopping 中,accountstatuses.get 方法的 Merchant API 對應項目為何?」
MCP 服務會提供官方遷移指南和參考文件中的背景資訊,讓助理提供詳細的答案,包括新的 API 名稱 accounts.issues。
情境 3:尋找程式碼範例
您正在導入新功能,需要實用範例做為參考。
使用者提示:
「Show me a Python code sample for adding a new shipping service using Merchant API.」(請提供 Python 程式碼範例,說明如何使用 Merchant API 新增運送服務)。
MCP 服務會從官方 Google GitHub 存放區和開發人員指南中,擷取相關程式碼範例。然後,Google 助理就能提供完整且可直接套用的程式碼區塊。
情境 4:瞭解 API 概念
您遇到新概念,或想瞭解資源結構或整體 Merchant API 模式。
使用者提示:
「如何使用 Merchant API 更新產品的庫存?」
MCP 服務會從產品資源說明文件和相關指南傳回內容。然後,助理會說明如何使用 accounts.productInputs.insert 方法,並提供只包含 productId 和需要更新的目錄相關欄位的部分產品資源。
「如何使用 Merchant API 授權應用程式呼叫?」
MCP 服務會從官方驗證指南擷取內容,其中涵蓋不同的授權方法。然後,助理可以說明主要選項,例如使用服務帳戶進行伺服器對伺服器互動,或代表使用者執行動作時使用 OAuth 2.0 用戶端 ID。
情境 5:因應 API 變更
Merchant API 導入了新的模式 (例如批次處理要求),與 Content API for Shopping 不同。Content API for Shopping 使用特定custombatch方法,而 Merchant API 則使用內建的通用 HTTP 批次處理功能。
使用者提示:
「在 Merchant API 中,產品自訂批次作業的新做法是什麼?」
MCP 服務會從「Refactor code for concurrent requests」一文擷取背景資訊,說明 Merchant API 中沒有專屬的 custombatch 方法。而是提供使用 HTTP 批次處理的說明文件,其中包含 Content-Type 的 multipart。然後,助理會說明如何建構單一 HTTP 要求,其中包含多個 API 呼叫,並傳送至 https://merchantapi.googleapis.com/batch/{sub-api}/v1 端點,還會提供多部分要求結構的範例。這項功能可將可能令人困惑的遷移工作,轉變為引導式程序。
情境 6:翻譯報表查詢
你可以要求代理程式將 Content API for Shopping 的報表查詢翻譯為 Merchant API。
使用者提示:
「將這項報表查詢從 Content API 遷移至 Merchant API:SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'」
MCP 服務會擷取最新的報表參考說明文件、開發人員指南和遷移指南。根據這項資訊,轉換查詢至新結構,並將欄位更新為新名稱和值。
Merchant API Agent Skills
Agent Skills 規格是 AI 開發工具採用的開放標準。使用代理程式技能提升開發人員體驗,並從 Shopping 的 Content API 遷移及建構新的整合功能,藉此最佳化兩者。Merchant API Agent Skills 套件提供特定領域的知識和工具,可提升 AI 代理程式的功能,並針對說明文件查詢、程式碼生成和疑難排解,提供隨選的專家協助。
Merchant API 代理程式技能與各種 AI 技術輔助的指令列工具和 IDE 相容,例如 Gemini 和 Claude Code。
運作方式
Merchant API Agent Skills 是一套以開放式 Agent Skills 標準為基礎建構的專業知識套件。我們的代理程式技能 mapi-developer-assistant 可做為 AI 開發工具與基礎 Merchant API 開發人員說明文件 MCP 伺服器之間的智慧層。這項工具內建網域專業知識和程序指引,具有下列屬性:
- 零設定:自動管理 MCP 伺服器連線,不必手動設定端點。
- 專家工作流程:將使用者提示精簡為最佳化查詢,有效擷取最相關的資訊。
- 脈絡管理和權杖效率:使用「漸進式揭露」技術,視需要載入資訊,並保留 AI 的脈絡窗口。
- 強化輸出格式:提供格式設定和結構化輸出內容的操作說明,確保回覆內容實用、易讀且一致。
工作流程範例:
- 在 AI 開發工具中詢問 Merchant API 相關問題。
- Merchant API 代理程式技能會分析你的意圖、擬定精確的查詢,並將程序知識套用至要求。
- Agent Skill 會向位於
merchantapi.googleapis.com/devdocs/mcp/的 Merchant API 開發人員文件 MCP 伺服器傳送情境要求。 - MCP 服務會搜尋已建立索引的官方 Merchant API 說明文件、指南和程式碼範例。
- AI 代理程式會運用這項資訊,提供統整且可行的回覆。
開始使用
Merchant API Agent Skills README 提供逐步指南,說明如何:
- Gemini 指令列工具等工具的必要條件。
- 在所選工具中啟用 Agent Skills 支援。
- 按照 README 說明,從 GitHub 存放區安裝
mapi-developer-assistant技能。 - 驗證安裝作業。
- 基本技能管理指令。
如需各種 AI 工具 (包括 Gemini 指令列工具、Claude Code 等) 的詳細安裝和設定說明,請按照 README 檔案中的指引操作。
提示詞範例
在 AI 開發工具中安裝並啟用後,當你提出與 Merchant API 相關的問題時,mapi-developer-assistant技能通常會自動啟動。
「如何使用 Python 中的 Merchant API 插入產品?」
「Content API
accountstatuses.get方法的 Merchant API 對等項目為何?」
「Show me a Java example for handling authentication with Merchant API.」(請提供 Java 範例,說明如何使用 Merchant API 處理驗證程序)。
「呼叫
productInputs.insert時,我收到『400 Bad Request』,並出現驗證錯誤。我該如何解決這個問題?"
「Merchant API 中的
ProductInput和Product有何不同?」
知識庫來源
MCP 服務只會從公開和官方來源建立知識庫,確保提供的內容準確可靠。這項服務會為官方開發人員網站和程式碼範例存放區的完整內容建立索引,包括:
- Merchant API 開發人員網站: 所有指南、參考資料和說明文件。
- Merchant API Apps Script 服務: 從 Apps Script 使用 Merchant API 的範例。
- 官方程式碼範例: GitHub 存放區中所有由 Google 提供的 Merchant API 官方程式碼範例。
- 用戶端程式庫:Merchant API 支援的所有官方用戶端程式庫。