API 整合和 Code Assist Toolkit

使用 API 整合和 Code Assist Toolkit,加快遷移至 Merchant API 的速度,並運用 AI 輔助開發人員工具建構新的整合功能。

總覽

從 Content API for Shopping 遷移至 Merchant API,或建立新的整合項目時,您需要瞭解新的服務結構、資源名稱和方法。AI 輔助開發人員工具特別適合協助下列作業:

  • 程式碼翻譯和遷移:協助您瞭解舊版 Content API for Shopping 程式碼,並轉換為新的 Merchant API 格式。包括將產品屬性對應至新結構,以及更新依附元件管理檔案。
  • API 說明文件專業知識:根據 Google API 官方說明文件的權威內容,清楚說明 Merchant API 資源、方法、欄位、配額和最佳做法。
  • 程式碼生成:為各種 Merchant API 工作生成程式碼片段,支援 Python、Java、PHP 等語言。
  • 疑難排解:協助診斷及修正常見的 API 錯誤。

請根據開發環境和特定用途,選擇最合適的選項。使用 API 整合和 Code Assist 工具包,根據偏好的工作流程自訂設定:

下圖說明在最常用的整合式開發環境 (IDE) (例如 Antigravity、Visual Studio Code、Cursor 或 Copilot) 中,AI 輔助程式碼遷移作業的設定選項。您可以設定 Gemini、Claude、ChatGPT、Grok 等程式開發輔助,並透過 Merchant API 開發人員說明文件 MCP 伺服器或 Merchant API 代理技能,讓這些助理更貼近實際需求,同時提升整合速度。

(Merchant API) AI 整合程式碼輔助圖表

Merchant API 開發人員說明文件 MCP 伺服器

透過您選擇的程式開發輔助,取得 Merchant API 的情境智慧。現在,您可以在 IDE 中使用 Model Context Protocol (MCP) 服務存取開發人員說明文件。這項服務會從 Google API 官方說明文件,擷取重要資訊提供給程式碼助理。如要進一步瞭解通訊協定本身,請參閱 Model Context Protocol 標準。

運作方式

當您向支援 MCP 的 IDE 程式開發輔助詢問 Merchant API 相關問題時,該服務會從官方資源擷取最相關的文字和程式碼片段,並使用專門的檢索增強生成 (RAG) 後端,將這些片段做為背景資訊傳回給程式開發輔助。RAG 系統會將 LLM 連結至最新的外部知識來源,提升回覆品質。這樣一來,助理就能提供準確、最新的答案,您也不必離開開發環境。

工作流程範例:

  1. 您在與 MCP 相容的程式開發輔助或代理中提出問題 (例如自然語言問題、要求程式碼範例或程式碼翻譯)。
  2. 程式開發輔助會向 MCP 端點傳送脈絡要求。
  3. MCP 服務會搜尋已建立索引的官方 Merchant API 說明文件、指南和程式碼範例。
  4. 這項服務會將權威程式碼片段做為背景資訊,傳回給程式碼助理。
  5. 程式開發輔助會利用這項背景資訊,生成有依據的答案或程式碼翻譯工作。

開始使用

如要整合及使用 MCP,請按照下列步驟操作:

1. 使用相容的工具

開啟支援 Model Context Protocol 且可串流 HTTP 傳輸的 IDE 或程式開發輔助。

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 轉換程式碼,請提供系統指令:Merchant Integrator Agent Protocol。這些指令會引導代理正確使用 MCP 進行程式碼翻譯。視工具而定,您可以在系統指令設定中提供這些指令,也可以為代理提供額外的背景資訊檔案。

使用情境範例

MCP 可在下列常見用途中加快工作流程:

情境 1:遷移 products.insert 程式碼

您可以要求代理直接將 Content API for Shopping products.insert 整合代碼遷移至 Merchant API。

使用者提示詞:

「將 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:尋找程式碼範例

您正在實作新功能,需要參考實際範例。

使用者提示詞:

「請提供 Python 程式碼範例,說明如何使用 Merchant API 新增運送服務。」

MCP 服務會從官方 Google GitHub 存放區和開發人員指南中,擷取相關的程式碼範例。接著,助理就能提供完整、可直接調整的程式碼區塊。

情境 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 中,執行 products.custombatch 的新方法為何?」

MCP 服務會從「重構程式碼以處理並行要求」擷取背景資訊,說明 Merchant API 中沒有專屬的 custombatch 方法。而是提供說明文件,說明如何使用 multipart 的 Content-Type 進行 HTTP 批次處理。接著,助理可以說明如何建構包含多個 API 呼叫的單一 HTTP 要求,並傳送至 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 規格是 AI 開發人員工具採用的開放標準。使用代理程式技能,提升開發人員體驗,並最佳化從 Content API for Shopping 遷移和建構新整合。Merchant API 代理技能套件提供特定領域的知識和工具,可強化 AI 代理的功能,並在查詢說明文件、生成程式碼和排解問題時,提供即時的專家協助。

Merchant API Agent Skills 與各種 AI 輔助指令列工具和 IDE 相容,例如 Antigravity 和 Claude Code。

運作方式

Merchant API 代理技能提供專業知識套件,以開放式代理技能標準為基礎。代理技能 mapi-developer-assistant 是 AI 開發人員工具與底層 Merchant API Dev Doc MCP 伺服器之間的智慧層。這類模型具備領域專業知識和程序指引,並具有下列特性:

  • 零設定:自動管理 MCP 伺服器連線,無須手動設定端點。
  • 專家工作流程:將使用者提示詞最佳化,有效擷取最相關的資訊。
  • 脈絡管理和詞元效率:採用「漸進式揭露」技術,隨選載入資訊,並保留 AI 的脈絡窗口。
  • 強化輸出格式設定:提供格式和結構設定操作說明,確保輸出內容實用、易讀且一致。

工作流程範例:

  1. 您在 AI 開發人員工具中詢問 Merchant API 相關問題。
  2. Merchant API 代理技能會分析您的意圖、制定精確的查詢,並將程序知識套用至要求。
  3. Agent Skill 會向位於 merchantapi.googleapis.com/devdocs/mcp/ 的 Merchant API 開發人員文件 MCP 伺服器傳送要求,取得相關背景資訊。
  4. MCP 服務會搜尋已建立索引的官方 Merchant API 說明文件、指南和程式碼範例。
  5. AI 代理會運用這項資訊,提供統整且可行的回覆。

開始使用

Merchant API Agent Skills README 提供逐步指南,說明如何:

  • Antigravity 指令列工具等工具的必要條件。
  • 在所選工具中啟用代理技能支援。
  • 按照 README 的指引,從 GitHub 存放區安裝 mapi-developer-assistant 技能。
  • 驗證安裝。
  • 基本技能管理指令。

如需各種 AI 工具 (包括 Antigravity 指令列工具、Claude Code 等) 的詳細安裝和設定操作說明,請按照 README 檔案中的指引操作。

提示詞範例

在 AI 開發人員工具中安裝並啟用 mapi-developer-assistant 技能後,當你提出與 Merchant API 相關的問題時,這項技能通常會自動啟動。

「如何使用 Python 透過 Merchant API 插入產品?」

「Content API accountstatuses.get 方法對應的 Merchant API 是什麼?」

「請提供 Java 範例,說明如何使用 Merchant API 處理驗證。」

「呼叫 productInputs.insert 時,我收到『400 Bad Request』和驗證錯誤。該如何解決這個問題?」

「Merchant API 中的 ProductInput 和 Product 有何不同?」

知識庫來源

MCP 服務的知識庫完全建立在公開和官方來源上,確保提供的背景資訊準確可靠。這項服務會為官方開發人員網站和程式碼範例存放區的完整內容建立索引,包括: