API-Integration und Code Assist Toolkit

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

Übersicht

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

  • Codeübersetzung und ‑migration: Hier erfahren Sie, wie Sie alten Content API for Shopping-Code in das neue Merchant API-Format konvertieren. Dazu gehört das Zuordnen von Produktattributen zur neuen Struktur und das Aktualisieren von Dateien für die Abhängigkeitsverwaltung.
  • Fachwissen zur API-Dokumentation: Bietet klare Erläuterungen zu Merchant API-Ressourcen, ‑Methoden, ‑Feldern, ‑Kontingenten und Best Practices basierend auf maßgeblichen Kontexten aus der offiziellen Google API-Dokumentation.
  • Codegenerierung: Generiert Code-Snippets für verschiedene Merchant API-Aufgaben in Sprachen wie Python, Java, PHP und anderen Sprachen.
  • 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-Integrations- und Code Assist-Toolkit können Sie die Einrichtung an Ihren bevorzugten Workflow anpassen:

Das folgende Diagramm zeigt die Einrichtungsoptionen für eine KI-gestützte Codemigration in den am häufigsten verwendeten integrierten Entwicklungsumgebungen (IDEs) wie Antigravity, Visual Studio Code, Cursor oder Copilot. Sie können Unterstützung beim Programmieren wie Gemini, Claude, ChatGPT und Grok einrichten und sie mit dem MCP-Server für die Merchant API-Entwicklerdokumentation oder den Merchant API-KI-Agenten-Skills ausstatten, um die Integration zu beschleunigen und gleichzeitig fundiertere Ergebnisse zu erhalten.

Diagramm zur KI-Integration von Code Assist (Merchant API)

MCP-Server für die Entwicklerdokumentation zur Merchant API

Kontextbezogene Informationen zur Merchant API erhalten Sie vom Programmierassistenten Ihrer Wahl. In Ihrer IDE können Sie jetzt über den MCP-Dienst (Model Context Protocol) auf die Entwicklerdokumentation zugreifen. Dieser Dienst versorgt Ihren Programmierassistenten mit wichtigen Informationen aus der offiziellen Google API-Dokumentation. Weitere Informationen zum Protokoll selbst finden Sie im Model Context Protocol-Standard.

Funktionsweise

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

Beispielworkflow:

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

Erste Schritte

So binden Sie das MCP ein und verwenden es:

1. Kompatibles Tool verwenden

Öffnen Sie eine IDE oder einen Programmierassistenten, die das Model Context Protocol mit streamfähigem HTTP-Transport unterstützen.

2. Endpunkt konfigurieren

Wenn Sie Ihre IDE oder Ihren Codeassistenten mit dem 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 KI-Agenten hinzufügen (optional)

Damit Ihr Agent Code direkt über MCP übersetzen kann, müssen Sie ihm die Systemanweisungen: Merchant Integrator Agent Protocol zur Verfügung stellen. Diese Anweisungen leiten den Agenten an, wie er das MCP für die Codeübersetzung richtig verwendet. Je nach Tool können Sie diese Anweisungen entweder in der Konfiguration der Systemanweisungen oder als zusätzliche Kontextdatei für den KI-Agenten bereitstellen.

Beispiele für Nutzungsszenarien

MCP kann Ihren Workflow in den folgenden gängigen Anwendungsfällen beschleunigen:

Szenario 1: products.insert-Code migrieren

Sie können den KI-Agenten bitten, einen Integrationscode der Content API for Shopping (products.insert) direkt zur Merchant API zu migrieren.

Nutzer-Prompt:

„products.insert-Code zur Merchant API migrieren“

Wenn Sie Ihrem KI-Agenten Systemanweisungen und Zugriff auf das MCP geben, kann er Content API for Shopping-Code direkt in Ihrer IDE in Merchant API-Code übersetzen. In diesem Fall wird productInputs.insert als der entsprechende Aufruf erkannt und die Produktattribute werden vom alten Format dem neuen Format zugeordnet, das für die Merchant API erforderlich ist. Er kann auch erforderliche Importe und die Datei für die Abhängigkeitsverwaltung (z. B. requirements.txt, pom.xml oder package.json) aktualisieren. Sie können den Agent 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 relevantes 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 stellt Kontext aus den offiziellen Migrationsanleitungen und der Referenzdokumentation bereit, sodass Ihr Assistent eine detaillierte Antwort geben kann, einschließlich des neuen API-Namens accounts.issues.

Szenario 3: Codebeispiel finden

Sie implementieren eine neue Funktion und benötigen ein praktisches Beispiel, dem Sie folgen können.

Nutzer-Prompt:

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

Der MCP-Dienst ruft relevante Codebeispiele aus den offiziellen Google-GitHub-Repositories und Entwicklerleitfäden ab. Der Assistent kann dann einen vollständigen, anpassbaren 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 das Inventar für ein Produkt mit der Merchant API?“

Der MCP-Dienst gibt Kontext aus der Dokumentation zu Produktressourcen und relevanten Leitfäden zurück. Ihr Assistent kann dann erklären, wie die Methode accounts.productInputs.insert verwendet wird, und die partielle Produktressource bereitstellen, die nur die productId und die inventarbezogenen Felder enthält, 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, die verschiedene Autorisierungsmethoden abdecken. 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 im Namen eines Nutzers gehandelt wird.

Szenario 5: Anpassung an API-Änderungen

Die Merchant API führt neue Muster ein, z. B. Batchanfragen, die sich von der Content API for Shopping unterscheiden. Die Content API for Shopping verwendet bestimmte custombatch-Methoden, während die Merchant API eine integrierte, allgemeine HTTP-Batchfunktion verwendet.

Nutzer-Prompt:

„Wie kann ich in der Merchant API einen products.custombatch ausführen?“

Der MCP-Dienst ruft Kontext aus Code für gleichzeitige Anfragen refaktorieren ab, in dem erklärt wird, dass es in der Merchant API keine dedizierten custombatch-Methoden gibt. 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 Endpunkt https://merchantapi.googleapis.com/batch/{sub-api}/v1 gesendet wird, und ein Beispiel für die Strukturierung der mehrteiligen Anfrage geben. Dadurch wird eine potenziell verwirrende Migrationsaufgabe in einen geführten Prozess umgewandelt.

Szenario 6: Berichtsabfrage übersetzen

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

Nutzer-Prompt:

„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'“

Der MCP-Dienst ruft die neuesten Referenzdokumente, Entwicklerleitfäden und Migrationsanleitungen für die Berichterstellung ab. Anhand dieser Informationen wird die Abfrage in die neue Struktur umgewandelt und die Felder werden mit den neuen Namen und Werten aktualisiert.

Merchant API-Agenten-Skills

Die Agent Skills-Spezifikation ist ein offener Standard, der in KI-Entwicklungstools verwendet wird. Mit Agent Skills können Sie die Entwicklererfahrung verbessern und sowohl die Migration von der Content API for Shopping als auch die Erstellung neuer Integrationen optimieren. Merchant API Agent Skills-Pakete enthalten domänenspezifisches Wissen und Tools, um die Funktionen von KI-Agenten zu erweitern. Sie bieten On-Demand-Unterstützung durch Experten für Dokumentationsabfragen, Codegenerierung und Fehlerbehebung.

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

Funktionsweise

Merchant API-Agent-Skills bieten ein spezialisiertes Fachwissenpaket, das auf dem offenen Agent Skills-Standard basiert. Der Agent-Skill mapi-developer-assistant fungiert als intelligente Ebene zwischen Ihren KI-Entwicklungstools und dem zugrunde liegenden Merchant API Dev Doc MCP-Server. Es enthält Fachwissen und Verfahrensanleitungen und hat die folgenden Eigenschaften:

  • Keine Konfiguration erforderlich: MCP-Serververbindungen werden automatisch verwaltet, sodass keine manuelle Endpunkteinrichtung erforderlich ist.
  • Experten-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 erhalten.
  • Verbesserte Ausgabeformatierung: Enthält Anweisungen zum Formatieren und Strukturieren der Ausgabe für umsetzbare, 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 Absicht, formuliert eine präzise Abfrage und wendet sein prozedurales Wissen auf die Anfrage an.
  3. Der Agent Skill sendet eine Anfrage für Kontext an den MCP-Server für die Merchant API-Entwicklerdokumentation unter merchantapi.googleapis.com/devdocs/mcp/.
  4. Der MCP-Dienst durchsucht seine indexierte Sammlung offizieller Merchant API-Dokumentationen, ‑Leitfäden und ‑Codebeispiele.
  5. Ihr KI-Agent nutzt diese Informationen, um eine zusammengefasste und umsetzbare Antwort zu liefern.

Erste Schritte

Die README-Datei zu den Merchant API-Agent-Skills enthält eine detaillierte Anleitung zu folgenden Themen:

  • Voraussetzungen für Tools wie das Antigravity-Befehlszeilentool.
  • Unterstützung für Agent Skills im ausgewählten Tool aktivieren.
  • Installieren des mapi-developer-assistant-Skills aus dem GitHub-Repository gemäß der Anleitung in der README-Datei.
  • Installation wird überprüft.
  • Grundlegende Befehle zur Skill-Verwaltung.

Eine detaillierte Anleitung zur Installation und Einrichtung verschiedener KI-Tools, einschließlich des Antigravity-Befehlszeilentools, Claude Code und anderer, 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?“

„Was ist das Merchant API-Äquivalent für die Content API-Methode accountstatuses.get?“

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

„Ich erhalte beim Aufruf von productInputs.insert einen Fehler vom Typ ‚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: