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 die neuen Dienststrukturen, Ressourcennamen und Methoden kennen. KI-gestützte Entwicklungstools eignen sich besonders gut für die folgenden Vorgänge:

  • Codeübersetzung und ‑migration: Sie helfen Ihnen, Legacy- Code der Content API for Shopping zu verstehen und in das neue Merchant API-Format zu konvertieren. Dazu gehört, Produktattribute der neuen Struktur zuzuordnen und Dateien zur Abhängigkeitsverwaltung zu aktualisieren.
  • API-Dokumentation: Bietet klare Erklärungen 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 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 Codemigration in den am häufigsten verwendeten integrierten Entwicklungsumgebungen (Integrated Development Environments, IDEs) wie Antigravity, Visual Studio Code, Cursor oder Copilot. Sie können Coding-Assistenten wie Gemini, Claude, ChatGPT oder Grok einrichten und sie mit dem MCP-Server für die Entwicklerdokumentation der Merchant API oder den Agent-Skills der Merchant API ausstatten, um die Integration zu beschleunigen und gleichzeitig die Genauigkeit zu erhöhen.

(Merchant API) AI Integration Code Assist diagram

MCP-Server für die Entwicklerdokumentation der Merchant API

Sie können sich von Ihrem Coding-Assistenten kontextbezogene Informationen zur Merchant API geben lassen. In Ihrer IDE können Sie jetzt über den MCP-Dienst (Model Context Protocol) auf die Entwicklerdokumentation zugreifen. Dieser Dienst liefert Ihrem Coding-Assistenten wichtige Informationen aus der offiziellen Google API-Dokumentation. Weitere Informationen zum Protokoll selbst finden Sie im MCP-Standard.

Funktionsweise

Wenn Sie Ihrem MCP-fähigen Coding-Assistenten in der IDE eine Frage zur Merchant API stellen, ruft der Dienst die relevantesten Text- und Code-Snippets aus offiziellen Ressourcen ab und gibt sie über ein spezielles RAG-Back-End (Retrieval-Augmented Generation) als Kontext an Ihren Coding-Assistenten zurück. 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 an Ihren MCP-kompatiblen Coding-Assistenten oder Agenten (z.B. eine Frage in natürlicher Sprache, eine Anfrage nach einem 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-Dokumentationen, ‑Anleitungen und ‑Codebeispiele.
  4. Der Dienst gibt maßgebliche Snippets als Kontext an Ihren Coding-Assistenten zurück.
  5. Ihr Coding-Assistent nutzt diesen Kontext, um eine fundierte Antwort zu generieren oder eine Codeübersetzungsaufgabe zu erstellen.

Erste Schritte

So binden Sie MCP ein und verwenden es:

1. Kompatibles Tool verwenden

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

2. Endpunkt konfigurieren

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

Konfigurationseinrichtungen:

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. Agent-Anweisungen hinzufügen (optional)

Wenn Ihr Agent Code direkt mit MCP übersetzen soll, geben Sie ihm die Systemanweisungen: Merchant Integrator Agent Protocol. Diese Anweisungen leiten den Agenten an, wie er 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 Agenten bereitstellen.

Beispiele für Anwendungsfälle

MCP kann Ihren Workflow in den folgenden häufigen Anwendungsfällen beschleunigen:

Szenario 1: products.insert-Code migrieren

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

Nutzer-Prompt :

„Migriere den products.insert-Code zur Merchant API.“

Wenn Sie Ihrem Agenten Systemanweisungen und Zugriff auf MCP geben, kann er den Code der Content API for Shopping 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 von der Merchant API benötigt wird. Außerdem können erforderliche Importe und die Datei zur Abhängigkeitsverwaltung aktualisiert werden (z. B. requirements.txt, pom.xml oder package.json). Sie können den Agenten anweisen, die Änderungen direkt vorzunehmen oder einen neuen Ordner zu erstellen.

Szenario 2: Entsprechende 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 die entsprechende Methode in der Merchant API für die Methode „accountstatuses.get“ in der Content API for Shopping?“

Der MCP-Dienst liefert Kontext aus den offiziellen Migrationsanleitungen und der Referenzdokumentation, 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.

Nutzer-Prompt :

„Zeige mir ein Python-Codebeispiel für das Hinzufügen eines neuen Versanddienstes 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 mit der Merchant API?“

Der MCP-Dienst gibt Kontext aus der Dokumentation zur Ressource „products“ und relevanten Anleitungen zurück. Ihr Assistent kann dann erklären, wie Sie die Methode accounts.productInputs.insert verwenden, und die teilweise Produktressource bereitstellen, die nur die productId und die lagerbezogenen 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 Authentifizierungsanleitungen ab, in denen verschiedene Autorisierungsmethoden behandelt 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 Sie im Namen eines Nutzers handeln.

Szenario 5: An API-Änderungen anpassen

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 spezifische custombatch-Methoden, während die Merchant API eine integrierte, generische HTTP-Batchfunktion verwendet.

Nutzer-Prompt :

„Wie führe ich in der Merchant API eine `products.custombatch`-Anfrage aus?“

Der MCP-Dienst ruft Kontext aus Code für gleichzeitige Anfragen umgestalten 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 dem Content-Type multipart dokumentiert. Ihr Assistent kann dann erklären, wie Sie eine einzelne HTTP-Anfrage erstellen, die mehrere API-Aufrufe enthält und an den Endpunkt https://merchantapi.googleapis.com/batch/{sub-api}/v1 gesendet wird. Außerdem kann er ein Beispiel für die Struktur der Multipart-Anfrage geben. So wird aus einer potenziell verwirrenden Migrationsaufgabe ein geführter Prozess.

Szenario 6: Berichtsanfrage übersetzen

Sie können den Agenten bitten, eine Berichtsanfrage von der Content API for Shopping zur 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 neueste Referenzdokumentation für Berichte, Entwicklerleitfäden und Migrationsanleitungen ab. Anhand dieser Informationen wird die Abfrage in die neue Struktur umgewandelt und die Felder werden auf die neuen Namen und Werte aktualisiert.

Agent-Skills der Merchant API

Die Agent-Skills-Spezifikation ist ein offener Standard, der in allen 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. Die Agent-Skills der Merchant API bündeln 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, Codegenerierung und Fehlerbehebung.

Die Agent-Skills der Merchant API sind mit verschiedenen KI-gestützten Befehlszeilentools und IDEs wie Gemini und Claude Code kompatibel.

Funktionsweise

Die Agent-Skills der Merchant API bieten ein spezielles Fachwissenpaket, 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 Entwicklerdokumentation der Merchant API. Er enthält domänenspezifisches Wissen und Verfahrensanleitungen und hat die folgenden Eigenschaften:

  • Keine Konfiguration erforderlich: Verwaltet automatisch MCP-Serververbindungen, sodass keine manuelle Endpunkteinrichtung erforderlich ist.
  • Expertenworkflows: Verfeinert Nutzer-Prompts zu optimierten 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 beizubehalten.
  • Verbesserte Ausgabeformatierung: Bietet 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 Agent-Skill der Merchant API analysiert Ihre Absicht, formuliert eine präzise Abfrage und wendet sein Verfahrenswissen auf die Anfrage an.
  3. Der Agent-Skill sendet eine Anfrage nach Kontext an den MCP-Server für die Entwicklerdokumentation der Merchant API unter merchantapi.googleapis.com/devdocs/mcp/.
  4. Der MCP-Dienst durchsucht seine indexierte Sammlung offizieller Merchant API-Dokumentationen, ‑Anleitungen und ‑Codebeispiele.
  5. Ihr KI-Agent nutzt diese Informationen, um eine zusammengefasste und umsetzbare Antwort zu geben.

Erste Schritte

Die README-Datei für die Agent-Skills der Merchant API enthält eine Schritt-für-Schritt-Anleitung zu folgenden Themen:

  • Voraussetzungen für Tools wie das Gemini-Befehlszeilentool.
  • Unterstützung für Agent-Skills in Ihrem ausgewählten Tool aktivieren.
  • Den Skill mapi-developer-assistant aus dem GitHub-Repository installieren, wie in der README-Datei beschrieben.
  • Installation überprüfen.
  • Grundlegende Befehle zur Skill-Verwaltung.

Eine detaillierte Anleitung zur Installation und Einrichtung verschiedener KI-Tools, einschließlich des Gemini-Befehlszeilentools und Claude Code, finden Sie in der README-Datei.

Beispiele für Prompts

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

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

„Was ist die entsprechende Methode in der Merchant API für die Methode in der Content API 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 genau und zuverlässig ist. Der Dienst indexiert den gesamten Inhalt der offiziellen Entwicklerwebsite und des Codebeispiel-Repositorys, einschließlich: