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

Sử dụng Bộ công cụ hỗ trợ tích hợp API và mã để đẩ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ụ 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 tính năng tích hợp mới, bạn cần hiểu 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. Quá trình này bao gồm 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: Cung cấp 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à phương pháp hay nhất của Merchant API dựa trên bối cảnh có thẩm quyền từ tài liệu API chính thức 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 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ụ hỗ trợ tích hợp API và mã để điều chỉnh quy trình thiết lập theo quy trình công việc 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 họ 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ơ sở vững chắc hơn trong khi tăng tốc độ tích hợp.

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

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

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 ngữ cảnh mô hình.

Cách hoạt động

Khi bạn hỏi 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 bối cảnh cho trợ lý lập trình của bạn bằng một phần phụ trợ chuyên dụng về Tạo sinh tăng cường truy xuất (RAG). Hệ thống RAG là hệ thống giúp cải thiện chất lượng câu trả lời của các mô hình ngôn ngữ lớn (LLM) bằng cách kết nối các mô hình này với các nguồn kiến thức bên ngoài và mới nhất. Điều này giúp trợ lý của bạn 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 công việc mẫu:

  1. Bạn đặt câu hỏi trong trợ lý lập trình hoặc Tác nhân 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 gửi yêu cầu về bối cảnh đến điểm cuối MCP.
  3. Dịch vụ MCP tìm kiếm trong bộ sưu tập được lập chỉ mục gồm tài liệu, hướng dẫn và mã mẫu chính thức của Merchant API.
  4. Dịch vụ này trả về các đoạn 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 tận dụng bối cảnh này để tạo câu trả lời có cơ sở hoặc tác 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 với 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ợ 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 tác nhân (không bắt buộc)

Để cho phép tác nhân dịch mã trực tiếp 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 cho nhà bán hàng. Những hướng dẫn này hướng dẫn 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 những 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 ngữ 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:

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 products.insert của 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 hướng dẫn hệ thống và quyền truy cập vào MCP, tác nhân có thể dịch mã Content API for Shopping sang mã Merchant API trực tiếp trong IDE. Trong trường hợp này, tác nhân 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. Tác nhân cũng có thể cập nhật các nội dung 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ã mẫu có liên quan.

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

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

Dịch vụ MCP cung cấp bối cảnh từ các hướng dẫn di chuyển và tài liệu tham khảo chính thức, cho phép trợ lý của bạn trả lời chi tiết, bao gồm cả tên API mới là 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ừ các kho lưu trữ GitHub và hướng dẫn dành cho nhà phát triển chính thức của Google. Sau đó, trợ lý của bạn có thể trình bày một khối mã hoàn chỉnh và sẵn sàng điều chỉnh.

Trường hợp 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ẫ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ảng không quảng cáo 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 để cho phép các lệnh gọi ứng dụng của tôi 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, bao gồm 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 tương tác giữa máy chủ với máy chủ hoặc mã ứng dụng OAuth 2.0 khi thay mặt người dùng thực hiện hành độ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 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 bối cảnh từ phần 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 chuyên dụng custombatch không tồn tại trong Merchant API. Thay vào đó, dịch vụ này cung cấp tài liệu về cách sử dụng tính năng theo lô HTTP với Content-Type là 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 nhiều phần. Điều này giúp 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 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 dành 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, dịch vụ 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 về 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 quy trình di chuyển từ Content API for Shopping và xây dựng các tính năng tích hợp mới. Kỹ năng của tác nhân Merchant API đóng gói kiến thức và công cụ dành riêng cho miền để nâng cao khả năng của các tác nhân AI và cung cấp 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ư Gemini 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 đặc biệt được xây dựng dựa trên tiêu chuẩn mở về Kỹ năng của tác nhân. Kỹ năng của tác nhân mapi-developer-assistant hoạt động như một lớp thông minh giữa các công cụ 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. Kỹ năng này nhúng 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 định 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 thiết lập điểm cuối theo cách thủ công.
  • Quy trình công 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á để truy xuất thông tin có liên quan nhất một cách hiệu quả.
  • Quản lý bối cảnh và hiệu quả của token: Sử dụng "Tiết lộ từng bước" để 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 để có câu trả lời nhất quán, dễ đọc và có thể thực hiện.

Quy trình công việc mẫu:

  1. Bạn đặt câu hỏi về Merchant API trong một công cụ phát triển AI.
  2. Kỹ năng của tác nhân Merchant API 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 theo quy trình của mì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 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 bộ sưu tập được lập chỉ mục gồm tài liệu, hướng dẫn và mã mẫu chính thức của Merchant API.
  5. Tác nhân AI của bạn tận dụng thông tin này để đưa ra câu trả lời tổng hợp và có thể thực hiện.

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ề:

  • Các điều kiện tiên quyết cho 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 từ 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 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 cho 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 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 accountstatuses.get của Content API tương đương với phương thức nào trong Merchant API?

Cho tôi xem ví dụ về Java để xử lý quy trình 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?"

"Điểm 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 chỉ xây dựng cơ sở kiến thức từ các nguồn công khai và chính thức để đảm bảo bối cảnh mà dịch vụ 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: