Инструментарий для интеграции API и помощи в написании кода

Используйте набор инструментов для интеграции API и помощи в написании кода, чтобы ускорить переход на Merchant API и создавать новые интеграции с помощью инструментов разработки на основе искусственного интеллекта.

Обзор

When migrating from Content API for Shopping to Merchant API or building a new integration, you need to understand new service structures, resource names, and methods. AI-powered development tools are particularly suited to assist with the following operations:

  • Code translation and migration : Helps you understand and convert legacy Content API for Shopping code into the new Merchant API format. This includes mapping product attributes to the new structure and updating dependency management files.
  • API documentation expertise : Provides clear explanations of Merchant API resources, methods, fields, quotas, and best practices based on authoritative context from official Google API documentation.
  • Генерация кода : Создает фрагменты кода для различных задач Merchant API на таких языках, как Python, Java, PHP и других.
  • Устранение неполадок : Помогает в диагностике и устранении распространенных ошибок API.

Выберите вариант, который лучше всего подходит для вашей среды разработки и конкретного сценария использования. Используйте набор инструментов интеграции API и помощи в написании кода, чтобы настроить параметры под ваш предпочтительный рабочий процесс:

На следующей диаграмме показаны варианты настройки миграции кода с помощью ИИ в наиболее часто используемых интегрированных средах разработки (IDE), таких как Antigravity, Visual Studio Code, Cursor или Copilot. Можно настроить помощников по программированию, таких как Gemini, Claude, ChatGPT, Grok, и интегрировать их с сервером документации для разработчиков Merchant API MCP или навыками агента Merchant API, чтобы повысить эффективность и ускорить интеграцию.

(Merchant API) AI Integration Code Assist diagram

Документация для разработчиков API для продавцов, сервер MCP

Get contextual intelligence about Merchant API from the coding assistant of your choice. Within your IDE, you can now access the developer documentation using the Model Context Protocol (MCP) service. This service feeds your coding assistant key information from official Google API documentation. For more information on the protocol itself, see the Model Context Protocol standard .

Как это работает

Когда вы задаете своему помощнику по программированию в IDE с поддержкой MCP вопрос об Merchant API, сервис извлекает наиболее релевантные фрагменты текста и кода из официальных источников и возвращает их в качестве контекста вашему помощнику по программированию, используя специализированную систему генерации с расширенным извлечением (RAG). Система RAG — это система, которая повышает качество ответов от LLM, связывая их с внешними, актуальными источниками знаний. Это позволяет вашему помощнику предоставлять точные и актуальные ответы, не требуя от вас покидать среду разработки.

Пример рабочего процесса:

  1. Вы задаете вопрос в своем MCP-совместимом помощнике по программированию или в Агенте (например, вопрос на естественном языке, запрос на пример кода или перевод кода).
  2. Ваш помощник по программированию отправляет запрос на получение контекста на конечную точку MCP.
  3. Сервис MCP осуществляет поиск по своей индексированной коллекции официальной документации, руководств и примеров кода Merchant API.
  4. Сервис возвращает авторитетные фрагменты кода в качестве контекста для вашего помощника по программированию.
  5. Ваш помощник по программированию использует этот контекст для генерации обоснованного ответа или задачи по переводу кода.

Начиная

Для интеграции и использования MCP выполните следующие шаги:

1. Используйте совместимый инструмент.

Откройте интегрированную среду разработки (IDE) или помощник по программированию, поддерживающий протокол контекста модели (Model Context Protocol) с потоковой передачей HTTP-трафика.

2. Настройте конечную точку

Для подключения вашей IDE или помощника по программированию к MCP используйте предоставленные данные удаленной конечной точки, которые могут потребовать ввода либо прямого URL-адреса службы, либо определения MCP, в зависимости от конфигурации вашего инструмента:

Настройки конфигурации:

Антигравитация

Следуйте инструкциям в документации по системе 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. Добавить инструкции для агента (необязательно)

To enable your agent to directly translate code using MCP, provide it with the System Instructions: Merchant Integrator Agent Protocol . These instructions guide the agent on how to correctly utilize MCP for code translation. Depending on your tool, you can provide these instructions either in the system instructions configuration or as an additional context file for the agent.

Примеры сценариев использования

MCP может ускорить ваш рабочий процесс в следующих распространенных сценариях использования:

Сценарий 1: Миграция products.insert Вставьте код

Вы можете попросить агента напрямую перенести код интеграции Content API для products.insert в Shopping в Merchant API.

Запрос пользователя:

"Перенести код products.insert в API продавца"

Предоставив вашему агенту системные инструкции и доступ к MCP, вы сможете преобразовывать код Content API для покупок в код Merchant API непосредственно в вашей IDE. В этом случае он определит вызов productInputs.insert как эквивалентный и сопоставит атрибуты продукта из старого формата с новым форматом, требуемым Merchant API. Он также сможет обновить необходимые импорты и файл управления зависимостями (например, requirements.txt , pom.xml или package.json ). Вы можете указать агенту внести изменения на месте или создать новую папку.

Сценарий 2: Найти эквивалентную функциональность

You have an existing application using the Content API for Shopping and need to update it. You can ask about a specific legacy method to get details on the new implementation and a relevant code sample.

Запрос пользователя:

«Какой аналог метода accountstatuses.get в Content API для Shopping используется в Merchant API?»

The MCP service provides context from the official migration guides and reference documentation, letting your assistant respond with a detailed answer, including the new API name, accounts.issues .

Сценарий 3: Поиск примера кода

Вы внедряете новую функцию и вам нужен практический пример для подражания.

Запрос пользователя:

«Покажите мне пример кода на Python для добавления новой службы доставки с использованием API продавца».

Сервис MCP извлекает соответствующие примеры кода из официальных репозиториев Google GitHub и руководств для разработчиков. Затем ваш ассистент может представить полный, готовый к адаптации блок кода.

Сценарий 4: Понимание концепций API

Вы столкнулись с новой концепцией, хотите понять структуру ресурса или общую модель работы API для продавцов.

Запрос пользователя:

«Как обновить информацию о наличии товара с помощью API продавца?»

The MCP service returns context from the products resource documentation and relevant guides. Your assistant can then explain how to use the accounts.productInputs.insert method and provide the partial product resource containing just the productId and the inventory-related fields you need to update.

«Как авторизовать вызовы моего приложения через Merchant API?»

The MCP service retrieves context from the official authentication guides, which cover different authorization methods. Your assistant can then explain the primary options available, such as using a service account for server-to-server interactions or an OAuth 2.0 client ID when acting on behalf of a user.

Сценарий 5: Адаптация к изменениям API

Merchant API introduces new patterns — such as batching requests — that differ from the Content API for Shopping. The Content API for Shopping uses specific custombatch methods, while Merchant API uses a built-in, generic HTTP batching feature.

Запрос пользователя:

«Как теперь использовать products.custombatch в Merchant API?»

Сервис MCP извлекает контекст из кода рефакторинга для параллельных запросов, объясняя, что в Merchant API отсутствуют специальные методы custombatch . Вместо этого он предоставляет документацию по использованию пакетной обработки HTTP с Content-Type равным multipart . Затем ваш помощник может объяснить, как сформировать один HTTP-запрос, содержащий несколько вызовов API, отправленный на конечную точку https://merchantapi.googleapis.com/batch/{sub-api}/v1 , и предоставить пример структуры запроса multipart. Это превращает потенциально сложную задачу миграции в пошаговый процесс.

Сценарий 6: Перевод запроса для формирования отчета

Вы можете попросить агента перевести запрос для формирования отчетов из Content API для покупок в Merchant API.

Запрос пользователя:

"Migrate this reporting query from Content API to Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Сервис MCP получает последнюю справочную документацию по отчетности, руководства для разработчиков и руководства по миграции. На основе этой информации он преобразует запрос в новую структуру и обновляет поля, присваивая им новые имена и значения.

Навыки агента API для продавцов

Спецификация Agent Skills — это открытый стандарт, используемый во всех инструментах разработки ИИ. Используйте Agent Skills, чтобы улучшить опыт разработчиков и оптимизировать как переход с Content API для покупок, так и создание новых интеграций. Agent Skills для Merchant API предоставляет специализированные знания и инструменты для расширения возможностей агентов ИИ, а также обеспечивает экспертную помощь по запросу в вопросах документации, генерации кода и устранении неполадок.

Навыки агентов Merchant API совместимы с различными инструментами командной строки и IDE, работающими на основе искусственного интеллекта, такими как Antigravity и Claude Code.

Как это работает

Merchant API Agent Skills provide a specialized expertise package built on the open Agent Skills standard. Our agent skill mapi-developer-assistant acts as an intelligent layer between your AI development tools and the underlying Merchant API Dev Doc MCP Server. It embeds domain expertise and procedural guidance, having the following properties:

  • Нулевая конфигурация : автоматическое управление подключениями к серверу MCP, исключающее необходимость ручной настройки конечных точек.
  • Экспертные рабочие процессы : Преобразуют запросы пользователей в оптимизированные запросы для эффективного получения наиболее релевантной информации.
  • Управление контекстом и эффективность токенов : Использует «прогрессивное раскрытие» для загрузки информации по запросу и сохранения контекстного окна ИИ.
  • Расширенное форматирование вывода : предоставляет инструкции по форматированию и структурированию вывода для получения действенных, читаемых и согласованных ответов.

Пример рабочего процесса:

  1. Вы задаёте вопрос об API для продавцов в инструменте разработки ИИ.
  2. Навык Merchant API Agent Skill анализирует ваши намерения, формирует точный запрос и применяет свои процедурные знания к этому запросу.
  3. Навык Agent отправляет запрос на получение контекста на сервер документации разработчика Merchant API MCP, расположенный по адресу merchantapi.googleapis.com/devdocs/mcp/ .
  4. Сервис MCP осуществляет поиск по своей индексированной коллекции официальной документации, руководств и примеров кода Merchant API.
  5. Ваш ИИ-агент использует эту информацию для предоставления синтезированного и действенного ответа.

Начиная

В файле README, посвященном навыкам работы с API-агентами для продавцов, содержится пошаговое руководство по следующим вопросам:

  • Необходимые условия для работы таких инструментов, как инструмент командной строки Antigravity.
  • Включение поддержки навыков агента в выбранном вами инструменте.
  • Установка навыка mapi-developer-assistant из репозитория GitHub в соответствии с инструкциями в файле README.
  • Проверка установки.
  • Основные команды управления навыками.

Подробные инструкции по установке и настройке различных инструментов искусственного интеллекта, включая инструмент командной строки Antigravity, Claude Code и другие, см. в файле README.

Примеры подсказок

После установки и включения в ваших инструментах разработки ИИ навык mapi-developer-assistant обычно активируется автоматически, когда вы задаете вопросы, связанные с Merchant API.

«Как добавить товар с помощью Merchant API в Python?»

«Какой аналог метода accountstatuses.get из API контента используется в Merchant API?»

«Покажите мне пример на Java для обработки аутентификации с помощью Merchant API».

«При вызове productInputs.insert я получаю ошибку '400 Bad Request' с проверкой данных. Как это исправить?»

«В чём разница между ProductInput и Product в Merchant API?»

Источники базы знаний

The MCP service builds its knowledge base exclusively from public and official sources to ensure the context it provides is accurate and reliable. The service indexes the entire content of the official developer site and code sample repository, including: