API-Integration und Code Assist Toolkit

Mit dem API Integration and Code Assist Toolkit können Sie die Migration zur Merchant API beschleunigen und mit KI-gestützten Entwicklungstools neue Integrationen erstellen.

Übersicht

Wenn Sie von der Content API for Shopping zur Merchant API migrieren oder eine neue Integration erstellen, müssen Sie die neuen Dienststrukturen, Ressourcennamen und Methoden kennen. KI-basierte Entwicklungstools eignen sich besonders gut für die folgenden Vorgänge:

  • Codeübersetzung und ‑migration: Hier erfahren Sie, wie Sie Legacy-Code der Content API for Shopping in das neue Merchant API-Format konvertieren. Dazu gehört, Produktattribute der neuen Struktur zuzuordnen und Dateien für die Abhängigkeitsverwaltung zu aktualisieren.
  • Fachwissen zur API-Dokumentation: Bietet klare Erläuterungen zu Merchant API-Ressourcen, -Methoden, -Feldern, -Kontingenten und ‑Best Practices basierend auf maßgeblichen Informationen aus der offiziellen Google API-Dokumentation.
  • Codegenerierung: Generiert Code-Snippets für verschiedene Merchant API-Aufgaben in Sprachen wie Python, Java und PHP.
  • Fehlerbehebung: Hilft bei der Diagnose und Behebung häufiger API-Fehler.

Wählen Sie die Option aus, die am besten zu Ihrer Entwicklungsumgebung und Ihrem spezifischen Anwendungsfall passt. Mit dem API Integration and Code Assist Toolkit können Sie die Einrichtung an Ihren bevorzugten Workflow anpassen:

Das folgende Diagramm veranschaulicht die Einrichtungsoptionen für eine KI-gestützte Code-Migration in den am häufigsten verwendeten integrierten Entwicklungsumgebungen (IDEs) wie Antigravity, Visual Studio Code, Cursor oder Copilot. Es ist möglich, Coding-Assistenten wie Gemini, Claude, ChatGPT und Grok einzurichten und sie mit dem MCP-Server (Model Context Protocol) der Merchant API-Entwicklerdokumentation oder den Merchant API-Agent-Skills zu optimieren, um die Integrationsgeschwindigkeit zu erhöhen.

(Merchant API) AI Integration Code Assist diagram

MCP-Server für die Entwicklerdokumentation zur Merchant API

Kontextbezogene Informationen zur Merchant API vom Coding-Assistenten Ihrer Wahl erhalten In Ihrer IDE können Sie jetzt über den MCP-Dienst (Model Context Protocol) auf die Entwicklerdokumentation zugreifen. Dieser Dienst stellt Ihrem Coding-Assistenten wichtige Informationen aus der offiziellen Google API-Dokumentation zur Verfügung. Weitere Informationen zum Protokoll selbst finden Sie im Model Context Protocol-Standard.

Funktionsweise

Wenn Sie Ihrem MCP-fähigen IDE-Coding-Assistenten eine Frage zur Merchant API stellen, ruft der Dienst die relevantesten Text- und Code-Snippets aus offiziellen Ressourcen ab und gibt sie als Kontext an Ihren Coding-Assistenten zurück. Dazu wird ein spezielles RAG-Backend (Retrieval-Augmented Generation) verwendet. Ein RAG-System verbessert die Qualität der Antworten von LLMs, indem es sie mit externen, aktuellen Wissensquellen verbindet. So kann Ihr Assistent genaue, aktuelle Antworten geben, ohne dass Sie Ihre Entwicklungsumgebung verlassen müssen.

Beispielworkflow:

  1. Sie stellen eine Frage in Ihrem MCP-kompatiblen Coding-Assistenten oder ‑Agenten (z.B. eine Frage in natürlicher Sprache, eine Anfrage für ein Codebeispiel oder eine Codeübersetzung).
  2. Ihr Coding-Assistent sendet eine Anfrage nach Kontext an den MCP-Endpunkt.
  3. Der MCP-Dienst durchsucht seine indexierte Sammlung offizieller Merchant API-Dokumentation, Leitfäden und Codebeispiele.
  4. Der Dienst gibt autoritative Snippets als Kontext für Ihren Coding-Assistenten zurück.
  5. Ihr Coding-Assistent nutzt diesen Kontext, um eine fundierte Antwort oder eine Aufgabe zur Codeübersetzung zu generieren.

Erste Schritte

So integrieren und verwenden Sie MCP:

1. Kompatibles Tool verwenden

Öffnen Sie eine IDE oder einen Coding-Assistenten, der das Model Context Protocol mit streamable HTTP-Transport unterstützt.

2. Endpunkt konfigurieren

Wenn Sie Ihre IDE oder Ihren Codeassistenten mit MCP verbinden möchten, verwenden Sie die bereitgestellten Details zum Remote-Endpunkt. Je nach Konfiguration Ihres Tools müssen Sie entweder die direkte Dienst-URL oder die MCP-Definition eingeben:

Konfigurationen:

Antigravity

Folgen Sie der Anleitung in der Antigravity-Dokumentation.

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

Visual Studio Code

Folgen Sie der Anleitung in der Visual Studio Code-Dokumentation.

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

3. Anweisungen für den Agenten hinzufügen (optional)

Damit Ihr Agent Code mithilfe von MCP direkt übersetzen kann, müssen Sie ihm die System Instructions: Merchant Integrator Agent Protocol (Systemanweisungen: Merchant Integrator Agent Protocol) zur Verfügung stellen. Diese Anleitung hilft dem Agent, MCP für die Codeübersetzung richtig zu verwenden. Je nach Tool können Sie diese Anweisungen entweder in der Konfiguration der Systemanweisungen oder als zusätzliche Kontextdatei für den KI-Agenten angeben.

Beispielszenarien

Mit MCP können Sie Ihren Workflow in den folgenden gängigen Anwendungsfällen beschleunigen:

Szenario 1: products.insert-Code migrieren

Sie können den Agenten bitten, einen Integrationscode für die Content API for Shopping products.insert direkt zur Merchant API zu migrieren.

Nutzer-Prompt:

„products.insert-Code zur Merchant API migrieren“

Wenn Sie Ihrem Agenten Systemanweisungen und Zugriff auf MCP gewähren, kann er Content API for Shopping-Code direkt in Ihrer IDE in Merchant API-Code übersetzen. In diesem Fall wird productInputs.insert als entsprechender Aufruf identifiziert und die Produktattribute aus dem alten Format werden dem neuen Format zugeordnet, das für die Merchant API erforderlich ist. Außerdem können erforderliche Importe und die Datei für die Abhängigkeitsverwaltung (z. B. requirements.txt, pom.xml oder package.json) aktualisiert werden. Sie können den Agenten anweisen, die Änderungen direkt vorzunehmen oder einen neuen Ordner zu erstellen.

Szenario 2: Äquivalente Funktionen finden

Sie haben eine vorhandene Anwendung, die die Content API for Shopping verwendet, und müssen sie aktualisieren. Sie können nach einer bestimmten Legacy-Methode fragen, um Details zur neuen Implementierung und ein entsprechendes Codebeispiel zu erhalten.

Nutzer-Prompt:

„Was ist das Merchant API-Äquivalent für die Methode ‚accountstatuses.get‘ in der Content API for Shopping?“

Der MCP-Dienst liefert Kontext aus den offiziellen Migrationsleitfäden und der Referenzdokumentation, sodass Ihr Assistent mit einer detaillierten Antwort reagieren kann, einschließlich des neuen API-Namens accounts.issues.

Szenario 3: Codebeispiel finden

Sie implementieren eine neue Funktion und benötigen ein praktisches Beispiel.

Nutzer-Prompt:

„Zeig mir ein Python-Codebeispiel zum Hinzufügen eines neuen Versandservices mit der Merchant API.“

Der MCP-Dienst ruft relevante Codebeispiele aus den offiziellen Google GitHub-Repositories und Entwicklerleitfäden ab. Ihr Assistent kann dann einen vollständigen, anpassungsbereiten Codeblock präsentieren.

Szenario 4: API-Konzepte verstehen

Sie stoßen auf ein neues Konzept oder möchten die Struktur einer Ressource oder das allgemeine Merchant API-Muster verstehen.

Nutzer-Prompt:

„Wie aktualisiere ich den Lagerbestand für ein Produkt über die Merchant API?“

Der MCP-Dienst gibt Kontext aus der Dokumentation der Produktressource und relevanten Anleitungen zurück. Ihr Assistent kann dann erklären, wie Sie die Methode accounts.productInputs.insert verwenden, und die teilweise Produktressource mit nur den Feldern productId und den inventarbezogenen Feldern bereitstellen, die Sie aktualisieren müssen.

„Wie autorisiere ich meine Anwendungsaufrufe mit der Merchant API?“

Der MCP-Dienst ruft Kontext aus den offiziellen Authentifizierungsleitfäden ab, in denen verschiedene Autorisierungsmethoden beschrieben werden. Ihr Assistent kann dann die wichtigsten verfügbaren Optionen erläutern, z. B. die Verwendung eines Dienstkontos für Server-zu-Server-Interaktionen oder einer OAuth 2.0-Client-ID, wenn er im Namen eines Nutzers handelt.

Szenario 5: Anpassung an API-Änderungen

Die Merchant API führt neue Muster ein, z. B. Batching-Anfragen, die sich von der Content API for Shopping unterscheiden. Die Content API for Shopping verwendet spezifische custombatch-Methoden, während die Merchant API eine integrierte, generische HTTP-Batching-Funktion verwendet.

Nutzer-Prompt:

„Wie kann ich in der Merchant API einen products.custombatch erstellen?“

Der MCP-Dienst ruft Kontext aus Code für gleichzeitige Anfragen umgestalten ab. Dort wird erklärt, dass in der Merchant API keine dedizierten custombatch-Methoden vorhanden sind. Stattdessen wird die Verwendung von HTTP-Batching mit einem Content-Type von multipart dokumentiert. Ihr Assistent kann dann erklären, wie Sie eine einzelne HTTP-Anfrage mit mehreren API-Aufrufen erstellen, die an den https://merchantapi.googleapis.com/batch/{sub-api}/v1-Endpunkt gesendet wird, und ein Beispiel für die Strukturierung der Multipart-Anfrage bereitstellen. So wird aus einer potenziell verwirrenden Migrationsaufgabe ein geführter Prozess.

Szenario 6: Berichtsabfrage übersetzen

Sie können den KI-Datenagenten bitten, eine Berichtsabfrage aus der Content API for Shopping in die Merchant API zu übersetzen.

Nutzer-Prompt:

„Migriere diese Berichtsanfrage von der Content API zur Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'“

Der MCP-Dienst ruft die aktuelle Referenzdokumentation für Berichte, Entwicklerleitfäden und Migrationsleitfäden ab. Anhand dieser Informationen wird die Abfrage in die neue Struktur umgewandelt und die Felder werden auf die neuen Namen und Werte aktualisiert.

Merchant API-Agent Skills

Die Spezifikation Agent Skills ist ein offener Standard, der in allen KI-Entwicklungstools verwendet wird. Mit Agent Skills können Sie die Entwicklerfreundlichkeit verbessern und sowohl die Migration von der Content API for Shopping als auch die Entwicklung neuer Integrationen optimieren. Merchant API Agent Skills-Pakete enthalten domänenspezifisches Wissen und Tools, um die Fähigkeiten von KI-Agenten zu verbessern. Außerdem bieten sie On-Demand-Expertenunterstützung für Dokumentationsanfragen, die Codegenerierung und die Fehlerbehebung.

Merchant API Agent Skills sind mit verschiedenen KI-basierten Befehlszeilentools und IDEs wie Gemini und Claude Code kompatibel.

Funktionsweise

Merchant API Agent Skills sind ein spezielles Know-how-Paket, das auf dem offenen Agent Skills-Standard basiert. Unser Agent-Skill mapi-developer-assistant fungiert als intelligente Ebene zwischen Ihren KI-Entwicklungstools und dem zugrunde liegenden MCP-Server für die Merchant API-Entwicklerdokumentation. Es enthält Fachwissen und Verfahrensanleitungen und hat die folgenden Eigenschaften:

  • Zero Configuration: Verwaltet MCP-Serververbindungen automatisch, sodass keine manuelle Endpunkteinrichtung erforderlich ist.
  • Expert Workflows: Verfeinert Nutzer-Prompts in optimierte Abfragen, um die relevantesten Informationen effektiv abzurufen.
  • Kontextverwaltung und Token-Effizienz: Verwendet „Progressive Disclosure“, um Informationen bei Bedarf zu laden und das Kontextfenster der KI zu schonen.
  • Verbesserte Ausgabeformatierung: Enthält Anweisungen zum Formatieren und Strukturieren der Ausgabe für verwertbare, lesbare und konsistente Antworten.

Beispielworkflow:

  1. Sie stellen in einem KI-Entwicklungstool eine Frage zur Merchant API.
  2. Der Merchant API Agent Skill analysiert Ihre Intention, formuliert eine präzise Anfrage und wendet sein prozedurales Wissen auf die Anfrage an.
  3. Der Agent Skill sendet eine Anfrage für Kontext an den Merchant API Dev Doc MCP-Server unter merchantapi.googleapis.com/devdocs/mcp/.
  4. Der MCP-Dienst durchsucht seine indexierte Sammlung offizieller Merchant API-Dokumentation, Leitfäden und Codebeispiele.
  5. Ihr KI-Agent nutzt diese Informationen, um eine zusammengefasste und umsetzbare Antwort zu geben.

Erste Schritte

Die README-Datei für Merchant API Agent Skills enthält eine Schritt-für-Schritt-Anleitung für Folgendes:

  • Voraussetzungen für Tools wie das Gemini-Befehlszeilentool.
  • Aktivieren Sie die Unterstützung für Agent-Skills in Ihrem ausgewählten Tool.
  • Installieren Sie den mapi-developer-assistant-Skill aus dem GitHub-Repository gemäß der README-Datei.
  • Installation prüfen
  • Grundlegende Befehle zur Skill-Verwaltung.

Eine detaillierte Installations- und Einrichtungsanleitung für verschiedene KI-Tools, darunter das Gemini-Befehlszeilentool und Claude Code, finden Sie in der README-Datei.

Beispiele für Prompts

Nach der Installation und Aktivierung in Ihren KI-Entwicklungstools wird der mapi-developer-assistant-Skill in der Regel automatisch aktiviert, wenn Sie Fragen zur Merchant API stellen.

„Wie füge ich ein Produkt mit der Merchant API in Python ein?“

„Welche Merchant API-Methode entspricht der Content API-Methode accountstatuses.get?“

„Zeige mir ein Java-Beispiel für die Authentifizierung mit der Merchant API.“

„Ich erhalte beim Aufrufen von productInputs.insert die Fehlermeldung ‚400 Bad Request‘ mit einem Validierungsfehler. Was kann ich tun?“

„Was ist der Unterschied zwischen ProductInput und Product in der Merchant API?“

Quellen der Wissensdatenbank

Der MCP-Dienst erstellt seine Wissensdatenbank ausschließlich aus öffentlichen und offiziellen Quellen, um sicherzustellen, dass der bereitgestellte Kontext korrekt und zuverlässig ist. Der Dienst indexiert den gesamten Inhalt der offiziellen Entwicklerwebsite und des Codebeispiel-Repositorys, einschließlich: