Tích hợp API và Bộ công cụ hỗ trợ mã

Sử dụng Bộ công cụ hỗ trợ mã và tích hợp API để đẩy nhanh quá trình di chuyển sang Merchant API và tạo các tính năng tích hợp mới bằng các công cụ phát triển dựa trên AI.

Tổng quan

Khi di chuyển từ Content API for Shopping sang Merchant API hoặc tạo một mối tích hợp mới, bạn cần hiểu rõ các cấu trúc dịch vụ, tên tài nguyên và phương thức mới. Các công cụ phát triển dựa trên AI đặc biệt phù hợp để hỗ trợ các thao tác sau:

  • Dịch và di chuyển mã: Giúp bạn hiểu và chuyển đổi mã Content API for Shopping cũ sang định dạng Merchant API mới. Trong đó có việc ánh xạ các thuộc tính sản phẩm sang cấu trúc mới và cập nhật các tệp quản lý phần phụ thuộc.
  • Kiến thức chuyên môn về tài liệu API: Cung cấp thông tin giải thích rõ ràng về các tài nguyên, phương thức, trường, hạn mức và các phương pháp hay nhất của Merchant API dựa trên ngữ cảnh có thẩm quyền từ tài liệu chính thức về API của Google.
  • Tạo mã: Tạo đoạn mã cho nhiều tác vụ Merchant API bằng các ngôn ngữ như Python, Java, PHP và các ngôn ngữ khác.
  • Khắc phục sự cố: Hỗ trợ chẩn đoán và khắc phục các lỗi thường gặp về API.

Chọn lựa chọn phù hợp nhất với môi trường phát triển và trường hợp sử dụng cụ thể của bạn. Sử dụng Bộ công cụ hỗ trợ tích hợp API và mã để điều chỉnh chế độ thiết lập theo quy trình công việc mà bạn muốn:

Sơ đồ sau đây minh hoạ các lựa chọn thiết lập để di chuyển mã sử dụng AI trên các Môi trường phát triển tích hợp (IDE) thường dùng nhất, chẳng hạn như Antigravity, Visual Studio Code, Cursor hoặc Copilot. Bạn có thể thiết lập các trợ lý lập trình như Gemini, Claude, ChatGPT, Grok và cung cấp cho các trợ lý này máy chủ MCP Tài liệu dành cho nhà phát triển Merchant API hoặc Kỹ năng của tác nhân Merchant API để có thêm thông tin cơ bản trong khi tăng tốc độ tích hợp.

(Merchant API) Sơ đồ Trợ lý tích hợp AI

Tài liệu dành cho nhà phát triển Merchant API Máy chủ MCP

Nhận thông tin tình báo theo bối cảnh về Merchant API từ trợ lý lập trình mà bạn chọn. Trong IDE, giờ đây, bạn có thể truy cập vào tài liệu dành cho nhà phát triển bằng dịch vụ Giao thức ngữ cảnh mô hình (MCP). Dịch vụ này cung cấp cho trợ lý lập trình của bạn thông tin chính từ tài liệu API chính thức của Google. Để biết thêm thông tin về giao thức này, hãy xem tiêu chuẩn Giao thức bối cảnh mô hình.

Cách hoạt động

Khi bạn đặt câu hỏi cho trợ lý lập trình IDE có hỗ trợ MCP về Merchant API, dịch vụ này sẽ truy xuất các đoạn văn bản và mã có liên quan nhất từ các tài nguyên chính thức rồi trả về các đoạn đó dưới dạng ngữ cảnh cho trợ lý lập trình của bạn bằng cách sử dụng một phần phụ trợ chuyên biệt là Cơ chế tạo được tăng cường khả năng truy xuất (RAG). Hệ thống RAG là hệ thống cải thiện chất lượng câu trả lời của các LLM bằng cách kết nối chúng với các nguồn kiến thức bên ngoài và mới nhất. Nhờ đó, trợ lý của bạn có thể cung cấp câu trả lời chính xác và mới nhất mà bạn không cần phải rời khỏi môi trường phát triển.

Quy trình ví dụ:

  1. Bạn đặt câu hỏi trong Trợ lý lập trình hoặc Agent tương thích với MCP (ví dụ: câu hỏi bằng ngôn ngữ tự nhiên, yêu cầu về mã mẫu hoặc bản dịch mã).
  2. Trợ lý lập trình của bạn sẽ gửi yêu cầu về ngữ cảnh đến điểm cuối MCP.
  3. Dịch vụ MCP tìm kiếm trong bộ sưu tập tài liệu, hướng dẫn và mã mẫu chính thức của Merchant API đã được lập chỉ mục.
  4. Dịch vụ này trả về các đoạn mã có thẩm quyền dưới dạng bối cảnh cho trợ lý lập trình của bạn.
  5. Trợ lý lập trình của bạn sẽ tận dụng bối cảnh này để tạo ra câu trả lời có căn cứ hoặc một nhiệm vụ dịch mã.

Bắt đầu

Để tích hợp và sử dụng MCP, hãy làm theo các bước sau:

1. Sử dụng một công cụ tương thích

Mở một IDE hoặc trợ lý lập trình hỗ trợ Giao thức ngữ cảnh mô hình bằng tính năng truyền tải HTTP có thể truyền trực tuyến.

2. Định cấu hình điểm cuối

Để kết nối IDE hoặc trợ lý lập trình với MCP, hãy sử dụng thông tin chi tiết về điểm cuối từ xa được cung cấp. Bạn có thể phải nhập URL dịch vụ trực tiếp hoặc định nghĩa MCP, tuỳ thuộc vào cấu hình của công cụ:

Thiết lập cấu hình:

Antigravity

Làm theo hướng dẫn trong tài liệu về Antigravity.

"mcpServers": {
  "mapi-devdocs": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://merchantapi.googleapis.com/devdocs/mcp"
    ]
  }
}

Visual Studio Code

Làm theo hướng dẫn trong tài liệu về Visual Studio Code.

"servers": {
"mapi-devdocs": {
  "type": "http",
  "url": "https://merchantapi.googleapis.com/devdocs/mcp/"
  }
}

3. Thêm hướng dẫn cho nhân viên hỗ trợ (không bắt buộc)

Để cho phép tác nhân dịch trực tiếp mã bằng MCP, hãy cung cấp cho tác nhân Hướng dẫn hệ thống: Giao thức tác nhân của đơn vị tích hợp người bán. Những hướng dẫn này giúp nhân viên hỗ trợ biết cách sử dụng MCP một cách chính xác để dịch mã. Tuỳ thuộc vào công cụ bạn sử dụng, bạn có thể cung cấp các chỉ dẫn này trong cấu hình chỉ dẫn hệ thống hoặc dưới dạng một tệp ngữ cảnh bổ sung cho tác nhân.

Ví dụ về các trường hợp sử dụng

MCP có thể đẩy nhanh quy trình làm việc của bạn trong các trường hợp sử dụng phổ biến sau:

Trường hợp 1: Di chuyển mã products.insert

Bạn có thể yêu cầu tác nhân di chuyển trực tiếp mã tích hợp Content API for Shopping products.insert sang Merchant API.

Câu lệnh của người dùng:

"Di chuyển mã products.insert sang Merchant API"

Bằng cách cung cấp cho tác nhân của bạn hướng dẫn hệ thống và quyền truy cập vào MCP, tác nhân của bạn có thể dịch mã Content API for Shopping sang mã Merchant API ngay trong IDE. Trong trường hợp này, thao tác này sẽ xác định productInputs.insert là lệnh gọi tương đương và liên kết các thuộc tính sản phẩm từ định dạng cũ sang định dạng mới mà Merchant API yêu cầu. Công cụ này cũng có thể cập nhật các tệp nhập bắt buộc và tệp quản lý phần phụ thuộc (ví dụ: requirements.txt, pom.xml hoặc package.json). Bạn có thể hướng dẫn tác nhân thực hiện các thay đổi tại chỗ hoặc tạo một thư mục mới.

Trường hợp 2: Tìm chức năng tương đương

Bạn có một ứng dụng hiện có đang sử dụng Content API for Shopping và cần cập nhật ứng dụng đó. Bạn có thể hỏi về một phương thức cũ cụ thể để biết thông tin chi tiết về cách triển khai mới và một mã mẫu có liên quan.

Câu lệnh của người dùng:

"Phương thức tương đương của Merchant API cho phương thức accountstatuses.get trong Content API for Shopping là gì?"

Dịch vụ MCP cung cấp bối cảnh từ hướng dẫn di chuyển chính thức và tài liệu tham khảo, cho phép trợ lý của bạn trả lời bằng một câu trả lời chi tiết, bao gồm cả tên API mới, accounts.issues.

Tình huống 3: Tìm mã mẫu

Bạn đang triển khai một tính năng mới và cần một ví dụ thực tế để làm theo.

Câu lệnh của người dùng:

Cho tôi xem một đoạn mã mẫu Python để thêm dịch vụ vận chuyển mới bằng Merchant API.

Dịch vụ MCP truy xuất các mã mẫu có liên quan từ kho lưu trữ chính thức của Google trên GitHub và hướng dẫn dành cho nhà phát triển. Sau đó, trợ lý của bạn có thể trình bày một khối mã hoàn chỉnh, sẵn sàng điều chỉnh.

Tình huống 4: Tìm hiểu các khái niệm về API

Bạn gặp phải một khái niệm mới hoặc muốn tìm hiểu cấu trúc của một tài nguyên hay mẫu Merchant API tổng thể.

Câu lệnh của người dùng:

"Làm cách nào để cập nhật kho hàng cho một sản phẩm bằng Merchant API?"

Dịch vụ MCP trả về bối cảnh từ tài liệu về tài nguyên sản phẩm và các hướng dẫn có liên quan. Sau đó, trợ lý của bạn có thể giải thích cách sử dụng phương thức accounts.productInputs.insert và cung cấp tài nguyên sản phẩm một phần chỉ chứa productId và các trường liên quan đến khoảng không quảng cáo mà bạn cần cập nhật.

"Làm cách nào để uỷ quyền cho các lệnh gọi ứng dụng bằng Merchant API?"

Dịch vụ MCP truy xuất bối cảnh từ các hướng dẫn xác thực chính thức, trong đó đề cập đến nhiều phương thức uỷ quyền. Sau đó, trợ lý của bạn có thể giải thích các lựa chọn chính hiện có, chẳng hạn như sử dụng tài khoản dịch vụ cho các hoạt động tương tác giữa máy chủ với máy chủ hoặc mã ứng dụng khách OAuth 2.0 khi thay mặt người dùng hành động.

Tình huống 5: Thích ứng với các thay đổi về API

Merchant API giới thiệu các mẫu mới (chẳng hạn như yêu cầu theo lô) khác với Content API for Shopping. Content API for Shopping sử dụng các phương thức custombatch cụ thể, trong khi Merchant API sử dụng một tính năng phân lô HTTP chung, được tích hợp sẵn.

Câu lệnh của người dùng:

"Cách mới để thực hiện products.custombatch trong Merchant API là gì?"

Dịch vụ MCP truy xuất ngữ cảnh từ Tái cấu trúc mã cho các yêu cầu đồng thời, giải thích rằng các phương thức custombatch chuyên dụng không tồn tại trong Merchant API. Thay vào đó, thư viện này cung cấp tài liệu về cách sử dụng tính năng xử lý hàng loạt HTTP với Content-Type của multipart. Sau đó, trợ lý của bạn có thể giải thích cách tạo một yêu cầu HTTP duy nhất chứa nhiều lệnh gọi API, được gửi đến điểm cuối https://merchantapi.googleapis.com/batch/{sub-api}/v1 và cung cấp ví dụ về cách cấu trúc yêu cầu gồm nhiều phần. Việc này sẽ biến một tác vụ di chuyển có thể gây nhầm lẫn thành một quy trình có hướng dẫn.

Trường hợp 6: Dịch truy vấn báo cáo

Bạn có thể yêu cầu tác nhân dịch một truy vấn báo cáo từ Content API for Shopping sang Merchant API.

Câu lệnh của người dùng:

"Di chuyển truy vấn báo cáo này từ Content API sang Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Dịch vụ MCP truy xuất tài liệu tham khảo mới nhất về báo cáo, hướng dẫn dành cho nhà phát triển và hướng dẫn di chuyển. Dựa trên thông tin này, nó sẽ chuyển đổi truy vấn sang cấu trúc mới và cập nhật các trường thành tên và giá trị mới.

Các kỹ năng của Merchant API Agent

Quy cách Kỹ năng của tác nhân là một tiêu chuẩn mở được áp dụng trên các công cụ phát triển AI. Sử dụng Kỹ năng của tác nhân để nâng cao trải nghiệm của nhà phát triển và tối ưu hoá cả hai, di chuyển từ Content API for Shopping và tạo các chức năng tích hợp mới. Các gói Kỹ năng của tác nhân Merchant API có kiến thức và công cụ dành riêng cho từng miền để nâng cao khả năng của các tác nhân AI, đồng thời cung cấp sự trợ giúp của chuyên gia theo yêu cầu cho các truy vấn về tài liệu, việc tạo mã và khắc phục sự cố.

Merchant API Agent Skills tương thích với nhiều công cụ dòng lệnh và IDE dựa trên AI, chẳng hạn như Gemini và Claude Code.

Cách hoạt động

Merchant API Agent Skills cung cấp một gói kiến thức chuyên môn được xây dựng dựa trên tiêu chuẩn Agent Skills mở. Kỹ năng của tác nhân mapi-developer-assistant đóng vai trò là một lớp thông minh giữa các công cụ phát triển AI của bạn và Máy chủ MCP Tài liệu dành cho nhà phát triển Merchant API cơ bản. Nó tích hợp kiến thức chuyên môn về miền và hướng dẫn theo quy trình, có các thuộc tính sau:

  • Không cần cấu hình: Tự động quản lý các kết nối Máy chủ MCP, không cần thiết lập điểm cuối theo cách thủ công.
  • Quy trình làm việc của chuyên gia: Tinh chỉnh câu lệnh của người dùng thành các truy vấn được tối ưu hoá để tìm nạp thông tin phù hợp nhất một cách hiệu quả.
  • Quản lý bối cảnh và hiệu quả của mã thông báo: Sử dụng "Tiết lộ từng bước" để tải thông tin theo yêu cầu và duy trì cửa sổ ngữ cảnh của AI.
  • Định dạng đầu ra nâng cao: Cung cấp hướng dẫn định dạng và cấu trúc đầu ra để có được các câu trả lời nhất quán, dễ đọc và hữu ích.

Quy trình ví dụ:

  1. Bạn đặt câu hỏi về Merchant API trong một công cụ phát triển AI.
  2. Merchant API Agent Skill phân tích ý định của bạn, đưa ra một cụm từ tìm kiếm chính xác và áp dụng kiến thức theo quy trình của mình cho yêu cầu.
  3. Agent Skill gửi yêu cầu về ngữ cảnh đến Máy chủ MCP Tài liệu dành cho nhà phát triển Merchant API nằm tại merchantapi.googleapis.com/devdocs/mcp/.
  4. Dịch vụ MCP tìm kiếm trong bộ sưu tập tài liệu, hướng dẫn và mã mẫu chính thức của Merchant API đã được lập chỉ mục.
  5. Trợ lý AI của bạn sẽ tận dụng thông tin này để đưa ra câu trả lời tổng hợp và hữu ích.

Bắt đầu

Tệp README về các kỹ năng của Merchant API Agent cung cấp hướng dẫn từng bước về:

  • Điều kiện tiên quyết đối với các công cụ như công cụ dòng lệnh Gemini.
  • Bật tính năng hỗ trợ Kỹ năng của tác nhân trong công cụ bạn chọn.
  • Cài đặt kỹ năng mapi-developer-assistant qua kho lưu trữ GitHub theo hướng dẫn trong tệp README.
  • Xác minh quá trình cài đặt.
  • Các lệnh cơ bản để quản lý kỹ năng.

Để biết hướng dẫn chi tiết về cách cài đặt và thiết lập nhiều công cụ AI, bao gồm cả công cụ dòng lệnh Gemini, Claude Code và các công cụ khác, hãy làm theo hướng dẫn trong tệp README.

Câu lệnh mẫu

Sau khi được cài đặt và bật trong các công cụ phát triển AI, kỹ năng mapi-developer-assistant thường được tự động kích hoạt khi bạn đặt câu hỏi liên quan đến Merchant API.

"Làm cách nào để chèn một sản phẩm bằng Merchant API trong Python?"

"Phương thức tương đương của Merchant API cho Content API accountstatuses.get là gì?"

"Cho tôi xem ví dụ về Java để xử lý việc xác thực bằng Merchant API."

"Tôi gặp lỗi "400 Yêu cầu không hợp lệ" kèm theo lỗi xác thực khi gọi productInputs.insert. Làm cách nào để khắc phục vấn đề này?"

"Sự khác biệt giữa ProductInput và Product trong Merchant API là gì?"

Nguồn cơ sở kiến thức

Dịch vụ MCP xây dựng cơ sở kiến thức hoàn toàn từ các nguồn công khai và chính thức để đảm bảo bối cảnh mà dịch vụ này cung cấp là chính xác và đáng tin cậy. Dịch vụ này lập chỉ mục toàn bộ nội dung của trang web chính thức dành cho nhà phát triển và kho lưu trữ mã mẫu, bao gồm: