Synup
Schlüssel erstellen
v1Ressourcen/Veröffentlichte Einträge/getEintrag eines Standorts abrufen

Eintrag eines Standorts abrufen

Liefert den Synchronisierungsstatus über Publisher hinweg, den Google-Unternehmensprofil-Status und Verbesserungsvorschläge für einen Standort.

get/api/v1/listings
listings:read
Query-Parameter
locationIdstringerforderlich
Der abzurufende Standort. Erforderlich. Nachschlagen mit GET /api/v1/locations.
clientIdstringoptional
Der Kunde des Standorts. Nur zur Eindeutigkeit nötig, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
Antwort
dataobjectoptional
statsobjectoptional
Zusammenfassende Zahlen über alle Publisher dieses Standorts.
publishersnumberoptional
Gesamtzahl der erfassten Publisher.
syncednumberoptional
Anzahl der aktuell synchronisierten Publisher.
notConnectednumberoptional
Anzahl der noch nicht verbundenen Publisher.
googleVerifiedLocationsnumberoptional
Anzahl der Google-verifizierten Standorte.
duplicatesnumberoptional
Anzahl der erkannten doppelten Listings.
connectionIssuesnumberoptional
Anzahl der Publisher mit einem Verbindungsproblem.
requiresActionnumberoptional
Anzahl der Publisher, die eine Aktion erfordern.
publishersarray of objectoptional
Synchronisierungsstatus je Publisher.
publisherIdstringoptional
Kennung des Verzeichnisses/Publishers.
publisherNamestringoptional
Anzeigename des Publishers.
statusstring (synced | in_progress | failed | requires_action | not_connected | expired | suspended | pending_approval | inaccessible | credentials_invalidated | not_available)optional
Einer von: synced, in_progress, failed, requires_action, not_connected, expired, suspended, pending_approval, inaccessible, credentials_invalidated, not_available.
liveLinksnumberoptional
Anzahl der für diesen Publisher gefundenen Live-Links, oder null.
gbpobjectoptional
Zusammenfassung des Google-Unternehmensprofils, sofern verbunden.
connectedbooleanoptional
Ob ein Google-Unternehmensprofil verbunden ist.
scorenumberoptional
Vollständigkeitswert des Profils, 0–100, oder null.
donearray of stringoptional
Abgeschlossene Profilverbesserungen.
todoarray of stringoptional
Ausstehende Profilverbesserungen.
opportunitiesarray of objectoptional
Vorgeschlagene Verbesserungen, jeweils mit kurzer Meldung und Ton.
textstringoptional
tonestring (amber | rose | blue | zinc)optional
aiobjectoptional
Eine kurze, KI-generierte Überschrift und bis zu 3 priorisierte Korrekturen für diesen Standort, oder null.
headlinestringoptional
Ein-Satz-Zusammenfassung des Listing-Zustands dieses Standorts.
fixFirstarray of objectoptional
Bis zu 3 vorgeschlagene nächste Schritte, nach Wirkung geordnet.
textstringoptional
impactstring (High | Med | Low)optional
noticestringoptional
Ein für Menschen lesbarer Hinweis zu den Listing-Daten dieses Standorts, oder null.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/listings
Ihr API-Schlüssel
locationId *
clientId
{
  "data": {
    "stats": {
      "publishers": 42,
      "synced": 38,
      "notConnected": 2,
      "googleVerifiedLocations": 1,
      "duplicates": 0,
      "connectionIssues": 1,
      "requiresAction": 1
    },
    "publishers": [
      {
        "publisherId": "google",
        "publisherName": "Google",
        "status": "synced",
        "liveLinks": 1
      }
    ],
    "gbp": {
      "connected": true,
      "score": 82,
      "done": [
        "Business name",
        "Address"
      ],
      "todo": [
        "Add photos"
      ]
    },
    "opportunities": [
      {
        "text": "Add more photos to your Google profile",
        "tone": "amber"
      }
    ],
    "ai": {
      "headline": "90% synced — 1 listing needs action.",
      "fixFirst": [
        {
          "text": "Reconnect 1 listing needing action.",
          "impact": "High"
        }
      ]
    },
    "notice": null
  }
}

Anleitungen, die diesen Endpunkt verwenden