Integracja interfejsu API i zestaw narzędzi Code Assist

Użyj integracji interfejsu API i Code Assist Toolkit, aby przyspieszyć migrację do Merchant API i tworzyć nowe integracje za pomocą narzędzi dla programistów 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 dla programistów oparte na AI są szczególnie przydatne w przypadku tych operacji:

  • Translacja kodu i migracja: pomaga zrozumieć i przekonwertować starszy kod Content API for Shopping na nowy format Merchant API. Obejmuje to mapowanie atrybutów produktu na nową strukturę i aktualizowanie plików zarządzania zależnościami.
  • Znajomość dokumentacji interfejsu API: zapewnia jasne wyjaśnienia dotyczące zasobów, metod, pól, limitów i sprawdzonych metod Merchant API na podstawie oficjalnej dokumentacji interfejsu API Google.
  • Generowanie kodu: generuje fragmenty kodu dla różnych zadań interfejsu Merchant API w językach takich jak Python, Java, PHP i innych.
  • Rozwiązywanie problemów: pomaga diagnozować i naprawiać typowe błędy interfejsu API.

Wybierz opcję, która najlepiej pasuje do Twojego środowiska programistycznego i konkretnego przypadku użycia. Użyj integracji z interfejsem API i zestawu narzędzi Code Assist, aby dostosować konfigurację do preferowanego przepływu pracy:

Poniższy diagram przedstawia opcje konfiguracji migracji kodu wspomaganej przez AI w najczęściej używanych zintegrowanych środowiskach programistycznych (IDE), takich jak Antigravity, Visual Studio Code, Cursor czy Copilot. Możesz skonfigurować asystentów wspomagania kodowania, takich jak Gemini, Claude, ChatGPT czy Grok, i wyposażyć ich w serwer MCP dokumentacji dla deweloperów Merchant API lub umiejętności agenta Merchant API, aby zwiększyć ich dokładność i przyspieszyć integrację.

(Merchant API) Diagram wspomagania kodowania integracji AI

Serwer MCP dokumentacji dla deweloperów Merchant API

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

Jak to działa

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

Przykładowy przepływ pracy:

  1. Zadajesz pytanie w asystencie wspomagania kodowania lub agencie zgodnym z MCP (np. pytanie w języku naturalnym, prośbę o przykładowy kod lub translację kodu).
  2. Wspomaganie kodowania wysyła prośbę o kontekst do punktu końcowego MCP.
  3. Usługa MCP przeszukuje zindeksowaną 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 wygenerowania odpowiedzi opartej na faktach lub zadania translacji kodu.

Pierwsze kroki

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

1. Używanie zgodnego narzędzia

Otwórz IDE lub wspomaganie kodowania, które obsługuje protokół Model Context Protocol z transportem HTTP z możliwością strumieniowania.

2. Konfigurowanie punktu końcowego

Aby połączyć IDE lub wspomaganie kodowania z MCP, użyj podanych informacji o zdalnym punkcie końcowym. W zależności od konfiguracji narzędzia może być konieczne podanie bezpośredniego adresu URL usługi lub definicji MCP:

Konfiguracje:

Antigravity

Postępuj zgodnie z instrukcjami podanymi 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 wskazują agentowi, jak prawidłowo korzystać z MCP do translacji kodu. W zależności od narzędzia możesz podać te instrukcje w konfiguracji instrukcji systemowych lub jako dodatkowy plik kontekstowy dla agenta.

Przykładowe scenariusze użycia

MCP może przyspieszyć przepływ pracy w tych typowych przypadkach użycia:

Scenariusz 1. Migracja kodu products.insert

Możesz poprosić agenta o bezpośrednią migrację kodu integracji Content API for Shopping products.insert do Merchant API.

Prompt użytkownika:

„Przenieś kod products.insert do interfejsu Merchant API”

Jeśli podasz agentowi instrukcje systemowe i zapewnisz mu dostęp do MCP, będzie on mógł tłumaczyć kod Content API for Shopping na kod Merchant API bezpośrednio w Twoim IDE. W tym przypadku zidentyfikuje productInputs.insert jako odpowiednik wywołania 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 poinstruować agenta, aby wprowadził zmiany na miejscu lub utworzył nowy folder.

Scenariusz 2. Znajdowanie odpowiednika funkcji

Masz już aplikację korzystającą 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:

"What is the Merchant API equivalent for the accountstatuses.get method in the Content API for Shopping?"

Usługa MCP dostarcza kontekst z oficjalnych przewodników po migracji i dokumentacji referencyjnej, dzięki czemu asystent może udzielić szczegółowej odpowiedzi, w tym podać nową nazwę interfejsu API: accounts.issues.

Scenariusz 3. Znajdowanie przykładowego kodu

Wdrażasz nową funkcję i potrzebujesz praktycznego przykładu, który możesz wykorzystać.

Prompt użytkownika:

„Pokaż mi przykładowy kod w Pythonie, który dodaje nową usługę dostawy za pomocą interfejsu Merchant API”.

Usługa MCP pobiera odpowiednie przykładowe kody z oficjalnych repozytoriów Google na GitHubie i przewodników dla programistów. Asystent może wtedy przedstawić kompletny, gotowy do dostosowania blok kodu.

Scenariusz 4. Poznanie koncepcji związanych z interfejsami API

Napotykasz nowe pojęcie lub chcesz zrozumieć strukturę zasobu albo ogólny wzorzec interfejsu Merchant API.

Prompt użytkownika:

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

Usługa MCP zwraca kontekst z dokumentacji zasobów usług 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 i pola związane z asortymentem, które chcesz zaktualizować.

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

Usługa MCP pobiera kontekst z oficjalnych przewodników po uwierzytelnianiu, które obejmują różne metody autoryzacji. Asystent może następnie wyjaśnić dostępne opcje, takie jak użycie konta usługi do interakcji między serwerami lub identyfikatora klienta OAuth 2.0, gdy działa w imieniu użytkownika.

Scenariusz 5. Dostosowywanie się do zmian w interfejsie API

Interfejs Merchant API wprowadza nowe wzorce, takie jak żądania zbiorcze, które różnią się od tych w Content API for Shopping. Content API for Shopping używa konkretnych metod custombatch, a Merchant API korzysta z wbudowanej, ogólnej funkcji grupowania HTTP.

Prompt użytkownika:

„Jak teraz wykonać products.custombatch w interfejsie Merchant API?”

Usługa MCP pobiera kontekst z Refaktoryzacja kodu pod kątem żądań równoczesnych, wyjaśniając, że w Merchant API nie ma dedykowanych metod custombatch. Zamiast tego zawiera dokumentację dotyczącą używania grupowania HTTP z Content-Type o wartości multipart. Asystent może następnie wyjaśnić, jak utworzyć pojedyncze żądanie HTTP zawierające wiele wywołań interfejsu API wysyłanych 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. Translacja zapytania dotyczącego raportowania

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

Prompt użytkownika:

"Przenieś to zapytanie raportujące 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ą dotyczącą raportowania, przewodniki dla programistów i przewodniki po migracji. Na podstawie tych informacji przekształca zapytanie do nowej struktury 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 dla programistów AI. Używaj umiejętności agenta, aby ulepszyć środowisko programistyczne i zoptymalizować zarówno migrację z Content API for Shopping, jak i tworzenie nowych integracji. Pakiety umiejętności agenta Merchant API zawierają wiedzę i narzędzia dotyczące konkretnej domeny, które zwiększają możliwości agentów AI i zapewniają na żądanie pomoc ekspertów w zakresie 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ń opartymi na AI i środowiskami IDE, 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. Umiejętność agenta mapi-developer-assistant działa jako inteligentna warstwa między narzędziami dla programistów AI a podstawowym serwerem MCP dokumentacji dla programistów Merchant API. Zawiera wiedzę specjalistyczną i wskazówki proceduralne, które mają te właściwości:

  • Zero konfiguracji: automatycznie zarządza połączeniami z serwerem MCP, eliminując potrzebę ręcznej konfiguracji punktów końcowych.
  • Przepływy pracy ekspertów: przekształca prompty użytkowników w zoptymalizowane zapytania, aby skutecznie pobierać najbardziej trafne informacje.
  • Zarządzanie kontekstem i wydajność tokenów: wykorzystuje „progresywne ujawnianie”, aby wczytywać informacje na żądanie i zachowywać okno kontekstu AI.
  • Ulepszone formatowanie danych wyjściowych: zawiera instrukcje dotyczące formatowania i struktury danych wyjściowych, aby odpowiedzi były przydatne, czytelne i spójne.

Przykładowy przepływ pracy:

  1. Zadajesz pytanie dotyczące interfejsu Merchant API w narzędziu dla programistów AI.
  2. Umiejętność agenta Merchant API analizuje 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 deweloperów interfejsu Merchant API, który znajduje się pod adresem merchantapi.googleapis.com/devdocs/mcp/.
  4. Usługa MCP przeszukuje zindeksowaną kolekcję oficjalnej dokumentacji, przewodników i przykładowych kodów Merchant API.
  5. Agent AI wykorzystuje te informacje, aby udzielić podsumowanej i przydatnej odpowiedzi.

Pierwsze kroki

W pliku Merchant API Agent Skills README znajdziesz szczegółowe instrukcje dotyczące:

  • Wymagania wstępne dotyczące narzędzi, takich jak narzędzie wiersza poleceń Antigravity.
  • Włączanie obsługi umiejętności agenta w wybranym narzędziu.
  • instalowanie umiejętności 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 dla programistów AI umiejętność mapi-developer-assistant jest zwykle aktywowana automatycznie, gdy zadajesz pytania związane z interfejsem Merchant API.

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

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

Pokaż mi przykład w Javie dotyczący obsługi uwierzytelniania za pomocą 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 interfejsie 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ść dostarczanego kontekstu. Usługa indeksuje całą zawartość oficjalnej witryny dla deweloperów i repozytorium przykładowego kodu, w tym: