Integracja interfejsu API i zestaw narzędzi Code Assist

Skorzystaj z zestawu narzędzi do integracji interfejsu API i Code Assist, aby przyspieszyć migrację do interfejsu Merchant API i tworzyć nowe integracje za pomocą narzędzi deweloperskich opartych na AI.

Przegląd

Podczas migracji z Content API for Shopping na Merchant API lub tworzenia nowej integracji musisz poznać nowe struktury usług, nazwy zasobów i metody. Narzędzia programistyczne oparte na AI są szczególnie przydatne w przypadku tych operacji:

  • Tłumaczenie i migracja kodu: pomaga zrozumieć i przekonwertować starszy kod Content API for Shopping na nowy format Merchant API. Obejmuje to mapowanie atrybutów produktów na nową strukturę i aktualizowanie plików zarządzania zależnościami.
  • Wiedza o dokumentacji interfejsu API: zawiera jasne wyjaśnienia zasobów, metod, pól, limitów i sprawdzonych metod Merchant API na podstawie wiarygodnych informacji z oficjalnej dokumentacji interfejsu API Google.
  • Generowanie kodu: generuje fragmenty kodu do różnych zadań interfejsu Merchant API w językach takich jak Python, Java, PHP i inne.
  • Rozwiązywanie problemów: pomaga w diagnozowaniu i naprawianiu typowych błędów interfejsu API.

Wybierz opcję, która najlepiej pasuje do Twojego środowiska programistycznego i konkretnego przypadku użycia. Skorzystaj z zestawu narzędzi do integracji interfejsu API i pomocy w pisaniu kodu, aby dostosować konfigurację do preferowanego przepływu pracy:

Poniższy diagram przedstawia opcje konfiguracji migracji kodu z pomocą AI w najczęściej używanych zintegrowanych środowiskach programistycznych (IDE), takich jak Antigravity, Visual Studio Code, Cursor czy Copilot. Możesz skonfigurować asystentów kodowania, takich jak Gemini, Claude, ChatGPT czy Grok, i wzmocnić ich działanie za pomocą serwera MCP dokumentacji dla programistów Merchant API lub umiejętności agenta Merchant API, aby zwiększyć ich wiarygodność i przyspieszyć integrację.

(Merchant API) Diagram asystenta kodowania integracji AI

Dokumentacja interfejsu Merchant API dla programistów – serwer MCP

Uzyskaj kontekstowe informacje o Merchant API od wybranego asystenta kodowania. W zintegrowanym środowisku programistycznym możesz teraz uzyskać dostęp do dokumentacji dla programistów za pomocą usługi Model Context Protocol (MCP). Ta usługa przekazuje asystentowi kodowania kluczowe informacje z oficjalnej dokumentacji interfejsu Google API. Więcej informacji o tym protokole znajdziesz w standardzie Model Context Protocol.

Jak to działa

Gdy zadajesz pytanie asystentowi kodowania w zintegrowanym środowisku programistycznym (IDE) z włączonym protokołem MCP dotyczące Merchant API, usługa pobiera najbardziej odpowiednie fragmenty tekstu i kodu z oficjalnych zasobów i zwraca je jako kontekst do asystenta kodowania za pomocą specjalistycznego backendu generowania wspomaganego wyszukiwaniem (RAG). System RAG poprawia jakość odpowiedzi modeli LLM, łącząc je z zewnętrznymi, aktualnymi źródłami wiedzy. Dzięki temu Twój asystent może udzielać dokładnych i aktualnych odpowiedzi bez konieczności opuszczania środowiska programistycznego.

Przykładowy proces:

  1. Zadajesz pytanie w asystencie do kodowania lub agencie zgodnym z MCP (np. pytanie w języku naturalnym, prośba o przykładowy kod lub tłumaczenie kodu).
  2. Asystent kodowania wysyła żądanie kontekstu do punktu końcowego MCP.
  3. Usługa MCP przeszukuje zaindeksowaną kolekcję oficjalnej dokumentacji, przewodników i przykładowych kodów Merchant API.
  4. Usługa zwraca autorytatywne fragmenty kodu jako kontekst dla asystenta kodowania.
  5. Asystent kodowania wykorzystuje ten kontekst do generowania odpowiedzi lub zadania tłumaczenia kodu.

Pierwsze kroki

Aby zintegrować i używać MCP, wykonaj te czynności:

1. Używanie zgodnego narzędzia

Otwórz IDE lub asystenta kodowania, który obsługuje protokół Model Context Protocol z przesyłaniem strumieniowym HTTP.

2. Konfigurowanie punktu końcowego

Aby połączyć IDE lub asystenta kodowania z MCP, użyj podanych szczegółów zdalnego punktu końcowego. W zależności od konfiguracji narzędzia może być konieczne wpisanie bezpośredniego adresu URL usługi lub definicji MCP:

Konfiguracje:

Antigravity

Postępuj zgodnie z instrukcjami w dokumentacji Antigravity.

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

Visual Studio Code

Postępuj zgodnie z instrukcjami w dokumentacji Visual Studio Code.

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

3. Dodawanie instrukcji dla agenta (opcjonalnie)

Aby umożliwić agentowi bezpośrednie tłumaczenie kodu za pomocą MCP, podaj mu instrukcje systemowe: protokół agenta integratora sprzedawcy. Te instrukcje pomogą agentowi prawidłowo korzystać z MCP do tłumaczenia kodu. W zależności od narzędzia możesz podać te instrukcje w konfiguracji instrukcji systemowych lub jako dodatkowy plik kontekstu dla agenta.

Przykładowe scenariusze użycia

MCP może przyspieszyć pracę w tych typowych przypadkach użycia:

Scenariusz 1. Przenoszenie kodu products.insert

Możesz poprosić pracownika obsługi klienta o bezpośrednie przeniesienie kodu integracji Content API for Shopping products.insert do Merchant API.

Prompt użytkownika:

„Przenieś kod products.insert do Merchant API”

Gdy udostępnisz agentowi instrukcje systemowe i dostęp do MCP, będzie on mógł tłumaczyć kod Content API for Shopping na kod Merchant API bezpośrednio w zintegrowanym środowisku programistycznym. W tym przypadku zidentyfikuje on productInputs.insert jako równoważne wywołanie i zmapuje atrybuty produktu ze starego formatu na nowy format wymagany przez interfejs Merchant API. Może też aktualizować wymagane importy i plik zarządzania zależnościami (np. requirements.txt, pom.xml lub package.json). Możesz polecić agentowi wprowadzenie zmian w miejscu lub utworzenie nowego folderu.

Scenariusz 2. Znajdowanie równoważnej funkcjonalności

Masz aplikację, która korzysta z Content API for Shopping, i musisz ją zaktualizować. Możesz zapytać o konkretną starszą metodę, aby uzyskać szczegółowe informacje o nowej implementacji i odpowiedni przykładowy kod.

Prompt użytkownika:

„Jaki jest odpowiednik metody accountstatuses.get w Content API for Shopping w Merchant API?”

Usługa MCP udostępnia kontekst z oficjalnych przewodników migracji i dokumentacji referencyjnej, dzięki czemu asystent może udzielać szczegółowych odpowiedzi, w tym podawać nową nazwę interfejsu API, accounts.issues.

Scenariusz 3. Znajdowanie przykładowego kodu

Wdrażasz nową funkcję i potrzebujesz praktycznego przykładu.

Prompt użytkownika:

„Pokaż mi przykładowy kod w Pythonie, który umożliwia dodanie nowej usługi dostawy za pomocą interfejsu Merchant API”.

Usługa MCP pobiera odpowiednie przykłady kodu z oficjalnych repozytoriów Google GitHub i przewodników dla deweloperów. Asystent może wtedy przedstawić kompletny blok kodu gotowy do dostosowania.

Scenariusz 4. Zrozumienie koncepcji interfejsu API

Chcesz poznać nowe pojęcie lub zrozumieć strukturę zasobu albo ogólny wzorzec Merchant API.

Prompt użytkownika:

„Jak zaktualizować asortyment produktu za pomocą Merchant API?”

Usługa MCP zwraca kontekst z dokumentacji zasobu produktów i odpowiednich przewodników. Asystent może wtedy wyjaśnić, jak używać metody accounts.productInputs.insert, i podać częściowy zasób produktu zawierający tylko pole productId oraz pola związane z asortymentem, które musisz zaktualizować.

„Jak autoryzować wywołania aplikacji za pomocą interfejsu Merchant API?”

Usługa MCP pobiera kontekst z oficjalnych przewodników uwierzytelniania, które obejmują różne metody autoryzacji. Asystent może wtedy wyjaśnić główne dostępne opcje, takie jak używanie konta usługi do interakcji między serwerami lub identyfikatora klienta OAuth 2.0 podczas działania w imieniu użytkownika.

Scenariusz 5. Dostosowywanie się do zmian w interfejsie API

Merchant API wprowadza nowe wzorce, takie jak żądania zbiorcze, które różnią się od Content API for Shopping. Content API for Shopping używa określonych metod, a Merchant API korzysta z wbudowanej, ogólnej funkcji żądań zbiorczych HTTP.custombatch

Prompt użytkownika:

„Jaki jest nowy sposób na wykonanie products.custombatch w interfejsie Merchant API?”

Usługa MCP pobiera kontekst z artykułu Refactor code for concurrent requests, w którym wyjaśniono, że w Merchant API nie ma dedykowanych metod custombatch. Zamiast tego zawiera dokumentację dotyczącą używania przetwarzania wsadowego HTTP z wartością Content-Type parametru multipart. Asystent może wtedy wyjaśnić, jak utworzyć jedno żądanie HTTP zawierające wiele wywołań interfejsu API, które jest wysyłane do punktu końcowego https://merchantapi.googleapis.com/batch/{sub-api}/v1, i podać przykład struktury żądania wieloczęściowego. Dzięki temu potencjalnie skomplikowane zadanie migracji staje się procesem z instrukcjami.

Scenariusz 6. Tłumaczenie zapytania o raport

Możesz poprosić agenta o przetłumaczenie zapytania raportowania z Content API for Shopping na Merchant API.

Prompt użytkownika:

„Przenieś to zapytanie raportowania z Content API do Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'”

Usługa MCP pobiera najnowszą dokumentację referencyjną raportowania, przewodniki dla programistów i przewodniki migracji. Na podstawie tych informacji przekształca zapytanie w nową strukturę i aktualizuje pola, nadając im nowe nazwy i wartości.

Umiejętności agenta Merchant API

Specyfikacja Umiejętności agenta to otwarty standard przyjęty w narzędziach do tworzenia AI. Używaj umiejętności agenta, aby ulepszać środowisko deweloperskie i optymalizować je, migrując z Content API for Shopping i tworząc nowe integracje. Pakiety umiejętności agenta Merchant API zawierają wiedzę i narzędzia z określonej dziedziny, które zwiększają możliwości agentów AI i zapewniają pomoc ekspertów na żądanie w przypadku zapytań dotyczących dokumentacji, generowania kodu i rozwiązywania problemów.

Umiejętności agenta Merchant API są zgodne z różnymi narzędziami wiersza poleceń i IDE opartymi na AI, takimi jak Antigravity i Claude Code.

Jak to działa

Umiejętności agenta Merchant API to specjalistyczny pakiet wiedzy oparty na otwartym standardzie umiejętności agenta. Nasza umiejętność agenta mapi-developer-assistant działa jako inteligentna warstwa między narzędziami do tworzenia AI a serwerem MCP dokumentacji deweloperskiej interfejsu Merchant API. Zawiera wiedzę specjalistyczną i wskazówki proceduralne, a także te właściwości:

  • Zero Configuration: automatycznie zarządza połączeniami z serwerem MCP, eliminując konieczność ręcznej konfiguracji punktu końcowego.
  • Expert Workflows: przekształca prompty użytkowników w zoptymalizowane zapytania, aby skutecznie pobierać najbardziej trafne informacje.
  • Zarządzanie kontekstem i wydajność tokenów: wykorzystuje „stopniowe ujawnianie”, aby wczytywać informacje na żądanie i zachowywać okno kontekstu AI.
  • Ulepszone formatowanie danych wyjściowych: zawiera instrukcje formatowania i strukturyzowania danych wyjściowych, aby uzyskać praktyczne, czytelne i spójne odpowiedzi.

Przykładowy proces:

  1. Zadajesz pytanie dotyczące Merchant API w narzędziu do tworzenia AI.
  2. Funkcja Merchant API Agent Skill analizuje Twoje intencje, formułuje precyzyjne zapytanie i stosuje do żądania swoją wiedzę proceduralną.
  3. Umiejętność agenta wysyła żądanie kontekstu do serwera MCP dokumentacji dla programistów interfejsu Merchant API znajdującego się pod adresem merchantapi.googleapis.com/devdocs/mcp/.
  4. Usługa MCP przeszukuje zaindeksowaną kolekcję oficjalnej dokumentacji, przewodników i przykładowych kodów Merchant API.
  5. Agent AI wykorzystuje te informacje, aby podać zsyntetyzowaną i przydatną odpowiedź.

Pierwsze kroki

Plik README dotyczący umiejętności agenta Merchant API zawiera szczegółowe instrukcje dotyczące:

  • Wymagania wstępne dotyczące narzędzi takich jak narzędzie wiersza poleceń Antigravity.
  • włączenie obsługi umiejętności agenta w wybranym narzędziu;
  • Zainstaluj umiejętność mapi-developer-assistant z repozytorium GitHub zgodnie z instrukcjami w pliku README.
  • Sprawdzam instalację.
  • Podstawowe polecenia zarządzania umiejętnościami.

Szczegółowe instrukcje instalacji i konfiguracji różnych narzędzi AI, w tym narzędzia wiersza poleceń Antigravity, Claude Code i innych, znajdziesz w pliku README.

Przykładowe prompty

Po zainstalowaniu i włączeniu w narzędziach do tworzenia AI ta mapi-developer-assistantumiejętność jest zwykle aktywowana automatycznie, gdy zadajesz pytania związane z interfejsem Merchant API.

„Jak wstawić produkt za pomocą interfejsu Merchant API w Pythonie?”

„Jaki jest odpowiednik metody Content API accountstatuses.get w Merchant API?”

„Pokaż mi przykład w Javie, jak obsługiwać uwierzytelnianie za pomocą interfejsu Merchant API”.

„Podczas wywoływania productInputs.insert pojawia się błąd „400: Nieprawidłowe żądanie” z błędem weryfikacji. Jak rozwiązać ten problem?”

„Jaka jest różnica między ProductInput a Product w Merchant API?”

Źródła bazy wiedzy

Usługa MCP tworzy bazę wiedzy wyłącznie na podstawie publicznych i oficjalnych źródeł, aby zapewnić dokładność i wiarygodność kontekstu. Usługa indeksuje całą zawartość oficjalnej witryny dewelopera i repozytorium przykładowego kodu, w tym: