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

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

Обзор

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

• Перевод и миграция кода : Помогает понять и преобразовать устаревший код Content API для интернет-магазина в новый формат Merchant API. Это включает в себя сопоставление атрибутов товаров с новой структурой и обновление файлов управления зависимостями.
• Экспертиза в области документации API : Предоставляет четкие объяснения ресурсов, методов, полей, квот и лучших практик API для продавцов на основе авторитетного контекста из официальной документации API Google.
• Генерация кода : Создает фрагменты кода для различных задач Merchant API на таких языках, как Python, Java, PHP и других.
• Устранение неполадок : Помогает в диагностике и устранении распространенных ошибок API.

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

• Документация для разработчиков Merchant API: MCP-сервер для прямого получения контекста.
• Навыки агента API для продавцов , обеспечивающие интуитивно понятное управление рабочим процессом.

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

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

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

Получайте контекстную информацию о Merchant API от выбранного вами помощника по программированию. Теперь в вашей IDE вы можете получить доступ к документации для разработчиков, используя службу Model Context Protocol (MCP). Эта служба передает вашему помощнику по программированию ключевую информацию из официальной документации Google API. Для получения дополнительной информации о самом протоколе см. стандарт Model Context Protocol .

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

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

Чтобы ваш агент мог напрямую переводить код с помощью MCP, предоставьте ему системные инструкции: Протокол агента интегратора продавцов . Эти инструкции помогут агенту правильно использовать MCP для перевода кода. В зависимости от используемого инструмента, вы можете предоставить эти инструкции либо в конфигурации системных инструкций, либо в качестве дополнительного контекстного файла для агента.

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

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: Найти эквивалентную функциональность

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

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

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

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

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

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

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

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

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

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

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

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

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

Сервис MCP возвращает контекст из документации по ресурсам продуктов и соответствующих руководств. Затем ваш помощник может объяснить, как использовать метод accounts.productInputs.insert , и предоставить частичный ресурс продукта, содержащий только productId и поля, связанные с инвентаризацией, которые необходимо обновить.

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

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

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

API для продавцов вводит новые шаблоны — такие как пакетная обработка запросов — которые отличаются от API контента для магазинов. API контента для магазинов использует специальные методы custombatch , в то время как API для продавцов использует встроенную, универсальную функцию пакетной обработки HTTP-запросов.

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

«Как теперь использовать 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.

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

"Перенесите этот запрос для формирования отчетов из 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 получает последнюю справочную документацию по отчетности, руководства для разработчиков и руководства по миграции. На основе этой информации он преобразует запрос в новую структуру и обновляет поля, присваивая им новые имена и значения.

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

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

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

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

Навыки агента Merchant API предоставляют специализированный пакет экспертных знаний, построенный на основе открытого стандарта Agent Skills. Наш навык агента mapi-developer-assistant выступает в качестве интеллектуального слоя между вашими инструментами разработки ИИ и базовым сервером документации разработчика Merchant API Dev Doc MCP. Он включает в себя экспертные знания в предметной области и методические указания, обладая следующими свойствами:

• Нулевая конфигурация : автоматическое управление подключениями к серверу 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-агентами для продавцов, содержится пошаговое руководство по следующим вопросам:

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

Подробные инструкции по установке и настройке различных инструментов искусственного интеллекта, включая инструмент командной строки Gemini, 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?»

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

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

• Сайт для разработчиков Merchant API : все руководства, справочные материалы и документация.
• Сервис Apps Script для работы с API продавца : пример использования API продавца из Apps Script.
• Официальные примеры кода : Все официальные примеры кода для Merchant API, предоставленные Google, находятся в репозитории GitHub.
• Клиентские библиотеки : Все официальные клиентские библиотеки поддерживаются API продавца.