Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Spezifikation für Angebotsanfragen für lokale Dienstleistungen

Technische Anforderungen für die Integration eines Plugins, mit dem sich Angebote für lokale Dienstleistungen direkt in ChatGPT anfragen lassen.

Die Plugins für Angebotsanfragen für lokale Dienstleistungen in ChatGPT sind derzeit in der Betaphase und werden gemeinsam mit zugelassenen Partnerunternehmen getestet. Um Zugang zu beantragen, fülle das ChatGPT-Formular für Handelsunternehmen aus.

Zweck

Wenn jemand gezielt eine lokale Dienstleistung in Anspruch nehmen möchte, kann ChatGPT direkt ein Partner-Plugin aufrufen, etwa um ein Angebot anzufragen.

Stelle dafür Daten zu lokalen Unternehmen bereit, anhand derer ChatGPT deinen Dienst erkennt. Stelle außerdem ein MCP-Tool bereit, das dein Widget für Angebotsanfragen öffnet.

Wenn du ein Plugin nach dieser Spezifikation entwickeln möchtest, beantrage den Zugang über das ChatGPT-Formular für Handelsunternehmen.

Ablauf in ChatGPT

Wenn jemand nach einem lokalen Unternehmen sucht, das die Voraussetzungen erfüllt, kann die Schaltfläche „Get Quote“ auf der Unternehmenskarte oder in der Seitenleiste erscheinen. Wer die Schaltfläche auswählt, öffnet das Widget des Anbieters für Angebotsanfragen in einem modalen Dialog in ChatGPT.

ChatGPT zeigt die Schaltfläche nur an, wenn dem Unternehmen ein geeigneter Dienstanbieter zugeordnet ist und für diesen ein Partner-Plugin konfiguriert ist.

Anforderungen an die Schnittstelle

Registriere ein MCP-Tool namens request_service mit ui://widget/request-service.html als Widget-Ressource. ChatGPT öffnet das Widget im Anzeigemodus modal und übergibt die vom Anbieter vergebene Unternehmens-ID, wenn jemand „Get Quote“ auswählt.

const launcherTool = {
  name: "request_service",
  _meta: {
    ui: {
      resourceUri: "ui://widget/request-service.html",
    },
  },
};

const launcherInput = {
  business_id: "biz_123",
};

Setze _meta["openai/widgetAccessible"] = true für jedes Hilfstool, das das Widget direkt aufruft. Diese Metadaten gelten für Hilfstools, auf die das Widget zugreifen kann. Allein das Öffnen des Widgets macht diese Einstellung für das Starttool nicht erforderlich.

Als Eingabe business_id muss das Starttool den Wert von provider_business_id aus dem zugehörigen Anbieterdatensatz erhalten. Dieser Wert kann von der ID des übergeordneten Datensatzes für das lokale Unternehmen abweichen.

Anforderungen an den Unternehmensfeed

Über den Unternehmensfeed stellst du ChatGPT Datensätze zu lokalen Unternehmen seitenweise bereit. ChatGPT indexiert die Datensätze für die Suche und ermittelt anhand der darin enthaltenen Anbieterdaten, ob ein Unternehmen „Get Quote“ unterstützt.

Pflichtfelder für Unternehmen

Jeder Unternehmensdatensatz muss folgende Felder enthalten:

  • id: Eine stabile Unternehmens-ID, die innerhalb deines Feeds eindeutig ist.
  • name: Der Name des Unternehmens.
  • address: Eine strukturierte Adresse oder eine gut lesbar formatierte Adresse.
  • location: Ein Objekt mit latitude und longitude.
  • phone_number: Eine Telefonnummer des Unternehmens, vorzugsweise im E.164-Format.
  • website_url: Die Website des Unternehmens.
  • platform_url: Die kanonische URL des Unternehmenseintrags auf deiner Plattform.

Aktion für Angebotsanfragen

Füge für jedes Unternehmen, das Angebotsanfragen annimmt, ein Array namens service_providers hinzu. Es muss einen Datensatz mit folgenden Feldern enthalten:

  • provider: Dein Anbietername. Er muss mit dem Anbieternamen im konfigurierten Partner-Plugin übereinstimmen.
  • provider_business_id: Deine Kennung für das Unternehmen. Sie darf nicht leer sein. ChatGPT übergibt diesen Wert als business_id an request_service.
  • action_type: Setze den Wert für eine Angebotsanfrage auf request_a_quote.
  • provider_action_url: Eine gültige absolute HTTP- oder HTTPS-URL für deine Aktion für Angebotsanfragen.
  • display_name: Ein optionaler Anzeigename, den du als Anbieter festlegst.

Endpunkt für den seitenweisen Abruf

Stelle einen Endpunkt wie GET /v1/businesses bereit, über den sich die Unternehmenseinträge abrufen lassen. Unterstütze eine der folgenden Paginierungsmethoden:

  • page und page_size.
  • offset und limit.
  • Ein opakes next_page_token.

Akzeptiere optional ein changes_token, das den letzten Synchronisationsstand kennzeichnet. Gib mit checksum an, ob sich der Feed geändert hat. Gib außerdem businesses mit den Einträgen der aktuellen Seite und die Metadaten für deine Paginierungsmethode zurück.

Die folgende Anfrage ruft beispielsweise ein Unternehmen aus einem Feed mit Seitennummerierung ab:

GET /v1/businesses?page=1&page_size=1&changes_token=sync_001

Gib den vollständigen Unternehmensdatensatz einschließlich der Aktion für Angebotsanfragen zurück:

{
  "checksum": true,
  "page": 1,
  "page_size": 1,
  "total_pages": 1,
  "businesses": [
    {
      "id": "local_biz_456",
      "name": "Acme Plumbing",
      "address": {
        "line1": "123 Market St",
        "locality": "San Francisco",
        "region": "CA",
        "postal_code": "94105",
        "country": "US",
        "formatted": "123 Market St, San Francisco, CA 94105, US"
      },
      "location": {
        "latitude": 37.793,
        "longitude": -122.396
      },
      "phone_number": "+14155551234",
      "website_url": "https://acmeplumbing.example",
      "platform_url": "https://provider.example/businesses/local_biz_456",
      "service_providers": [
        {
          "provider": "example_provider",
          "provider_business_id": "biz_123",
          "action_type": "request_a_quote",
          "provider_action_url": "https://provider.example/request-quote/biz_123",
          "display_name": "Get Quote"
        }
      ]
    }
  ]
}

Voraussetzungen für Angebotsanfragen im Chat

ChatGPT stellt die Schaltfläche im Chat nur bereit, wenn alle folgenden Bedingungen erfüllt sind. Die ID des übergeordneten Unternehmensdatensatzes darf nicht leer sein. Der Anbieterdatensatz muss eine nicht leere provider_business_id und eine gültige provider_action_url enthalten. Außerdem muss für den Anbieter ein Partner-Plugin konfiguriert sein. Die Schaltfläche für Angebotsanfragen trägt in ChatGPT die Beschriftung „Get Quote“. Der vom Anbieter angegebene display_name überschreibt diese Beschriftung bei Aktionen vom Typ request_a_quote nicht.

Künftige Erweiterungen

Diese Spezifikation deckt Angebotsanfragen ab. Weitere Aktionen wie die Terminbuchung sind für Angebotsanfragen nicht erforderlich.