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

Sử dụng Bộ công cụ tích hợp API và trợ giúp lập trình để đẩy nhanh quá trình di chuyển sang Merchant API và xây dựng các tính năng tích hợp mới bằng các công cụ cho nhà 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 xây dựng một quy trình tích hợp mới, bạn cần nắm đượ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ụ cho nhà phát triển sử dụng AI đặc biệt phù hợp để hỗ trợ các hoạt động sau:

  • Biên dịch mã và di chuyển: Giúp bạn hiểu và chuyển đổi mã Content API for Shopping cũ sang định dạng Merchant API mới. Việc này bao gồm cả việc liên kết các thuộc tính sản phẩm với cấu trúc mới và cập nhật các tệp quản lý phần phụ thuộc.
  • Chuyên môn về tài liệu API: Đưa ra nội dung 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 bối cảnh có căn cứ 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 nhiệm vụ của 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 API thường gặp.

Chọn phương á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ụ tích hợp API và hỗ trợ lập trình để điều chỉnh quy trình thiết lập cho phù hợp với quy trình làm việc bạn muốn:

Sơ đồ sau đây minh hoạ các lựa chọn thiết lập cho quy trình di chuyển mã có sự hỗ trợ của AI trên các Môi trường phát triển tích hợp (IDE) được sử dụng phổ biến nhất như Antigravity, Visual Studio Code, Cursor hoặc Copilot. Bạn có thể thiết lập các trợ giúp lập trình như Gemini, Claude, ChatGPT, Grok và hỗ trợ các trợ giúp này bằng 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ác trợ giúp này có thể neo bám hơn, đồng thời tăng tốc độ tích hợp.

(Merchant API) Sơ đồ trợ giúp lập trình tích hợp AI

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

Nhận thông tin theo bối cảnh về Merchant API từ trợ giúp 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 quan trọng từ tài liệu chính thức về API của Google. Để biết thêm thông tin về chính 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ợ giúp 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ã phù hợp nhất từ các tài nguyên chính thức rồi trả về dưới dạng ngữ cảnh cho trợ giúp lập trình của bạn bằng cách sử dụng phần phụ trợ Tạo tăng cường truy xuất (RAG) chuyên biệt. Hệ thống RAG là hệ thống cải thiện chất lượng câu trả lời của 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ó thể đưa ra câu trả lời chính xác, 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 làm việc mẫu:

  1. Bạn đặt câu hỏi trong Tác nhân hoặc trợ giúp lập trình 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 cung cấp mã mẫu hoặc biên dịch mã).
  2. Trợ giúp lập trình của bạn sẽ gửi yêu cầu cung cấp bối cảnh đến điểm cuối MCP.
  3. Dịch vụ MCP tìm kiếm trong tập hợ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ã đáng tin cậy làm bối cảnh cho trợ lý lập trình của bạn.
  5. Trợ giúp lập trình của bạn tận dụng bối cảnh này để tạo câu trả lời neo bám hoặc thực hiện nhiệm vụ biên 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 công cụ tương thích

Mở một IDE hoặc trợ giúp lập trình hỗ trợ Giao thức ngữ cảnh mô hình có giao thức 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ợ giúp 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. Thông tin này có thể yêu cầu bạn 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 tác nhân (không bắt buộc)

Để cho phép tác nhân trực tiếp dịch 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 tích hợp của người bán. Những hướng dẫn này chỉ dẫn cho tác nhân cách sử dụng MCP đúng cách để dịch mã. Tuỳ thuộc vào công cụ, bạn có thể cung cấp các hướng dẫn này trong cấu hình hướng dẫn hệ thống hoặc dưới dạng tệp bối cảnh bổ sung cho tác nhân.

Các trường hợp sử dụng mẫu

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

Tình huống 1: Di chuyển mã products.insert

Bạn có thể yêu cầu nhân viên hỗ trợ trực tiếp di chuyển mã tích hợp products.insert Content API for Shopping 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 các chỉ 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 của bạn. Trong trường hợp này, hệ thống 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 và tệp quản lý phần phụ thuộc bắt buộ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ó 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ã mẫu có liên quan.

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

"Phương thức nào trong Merchant API tương đương với phương thức accountstatuses.get trong Content API for Shopping?"

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, giúp trợ lý của bạn đưa ra câu trả lời chi tiết, bao gồm cả tên API mới, accounts.issues.

Trường hợp 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ã 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ữ GitHub chính thức của Google và hướng dẫn cho nhà phát triển. Sau đó, trợ lý 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 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 hoặc mô hình tổng thể của Merchant API.

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ó 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 hàng 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ó nhiều phương thức uỷ quyền. Sau đó, trợ lý 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 hành động thay mặt người dùng.

Trường hợp 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 tính năng gom theo lô HTTP chung, 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ừ Cải tiến 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 đó, tài liệu này cung cấp thông tin về cách sử dụng tính năng phân lô HTTP với Content-Type của multipart. Sau đó, trợ lý 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à đưa ra ví dụ về cách tạo cấu trúc cho yêu cầu gồm nhiều phần. Điều này giúp biến một nhiệm 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 một truy vấn báo cáo

Bạn có thể yêu cầu nhân viên hỗ trợ 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 báo cáo, hướng dẫn cho nhà phát triển và hướng dẫn di chuyển mới nhất. Dựa trên thông tin này, công cụ 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.

Kỹ năng của tác nhân Merchant API

Thông số kỹ thuật 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ụ cho nhà phát triển AI. Hãy 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 việc: di chuyển từ Content API for Shopping và xây dựng các công cụ tích hợp mới. Gói Kỹ năng của tác nhân Merchant API đóng gói kiến thức và công cụ theo miền cụ thể để nâng cao khả năng của các tác nhân AI, đồng thời cung cấp dịch vụ hỗ trợ theo yêu cầu của chuyên gia cho các truy vấn về tài liệu, tạo mã và khắc phục sự cố.

Kỹ năng của tác nhân Merchant API 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ư Antigravity và Claude Code.

Cách hoạt động

Kỹ năng của tác nhân Merchant API cung cấp một gói chuyên môn chuyên biệt được xây dựng dựa trên tiêu chuẩn Kỹ năng của tác nhân mở. Kỹ năng 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ụ cho nhà phát triển AI và Máy chủ MCP tài liệu dành cho nhà phát triển Merchant API cơ bản. Mô hình này tích hợp kiến thức chuyên môn về miền và hướng dẫn về 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, giúp bạn không cần phải 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ý ngữ cảnh và hiệu quả của mã thông báo: Sử dụng "Tiết lộ dần dần" để tải thông tin theo yêu cầu và giữ nguyên 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 cho các câu trả lời hữu ích, dễ đọc và nhất quán.

Quy trình làm việc mẫu:

  1. Bạn đặt câu hỏi về Merchant API trong một công cụ cho nhà phát triển AI.
  2. Kỹ năng của tác nhân Merchant API sẽ phân tích ý định của bạn, xây dựng một truy vấn chính xác và áp dụng kiến thức về quy trình cho yêu cầu đó.
  3. Kỹ năng của tác nhân gửi yêu cầu về bối cảnh đến Máy chủ MCP của Tài liệu dành cho nhà phát triển Merchant API tại merchantapi.googleapis.com/devdocs/mcp/.
  4. Dịch vụ MCP tìm kiếm trong tập hợ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. Tác nhân 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à có thể hành động.

Bắt đầu

Tệp README về kỹ năng của tác nhân Merchant API 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 Antigravity.
  • Bật tính năng hỗ trợ Kỹ năng của nhân viên hỗ trợ trong công cụ bạn chọn.
  • Cài đặt kỹ năng mapi-developer-assistant từ kho lưu trữ GitHub theo hướng dẫn trong tệp README.
  • Đang xác minh việc cài đặt.
  • Các lệnh quản lý kỹ năng cơ bản.

Để 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 Antigravity, 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ụ cho nhà phát triển AI, kỹ năng mapi-developer-assistant thường được kích hoạt tự động khi bạn đặt câu hỏi liên quan đến Merchant API.

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

"Phương thức Merchant API nào tương đương với phương thức accountstatuses.get của Content API?"

"Cho tôi xem một 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 lỗi 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: