Synup
Schlüssel erstellen
v1Ressourcen/Locations/getStandort abrufen

Standort abrufen

Liefert das vollständige Unternehmensprofil für einen Standort: Adresse, Öffnungszeiten, Kategorien, Attribute, Dienstleistungen, Medien und Verifizierungsstatus.

get/api/v1/locations/{id}
locations:read
Query-Parameter
idstringerforderlich
Der abzurufende Standort.
Antwort
dataobjectoptional
Das vollständige Unternehmensprofil für einen Standort: Adresse, Öffnungszeiten, Kategorien, Attribute, Dienstleistungen, Medien und Status — alles, was update_location ändern kann, plus das, was create zurückgegeben hat.
idstringoptional
Eindeutige Kennung des Standorts.
namestringoptional
Der Firmenname des Standorts.
descriptionstringoptional
Eine Beschreibung des Unternehmens, oder null.
taglinestringoptional
Ein kurzer Slogan für das Unternehmen, oder null.
storeCodestringoptional
Ihr interner Filialcode / Referenz für diesen Standort, oder null.
logoUrlstringoptional
URL des Logobilds des Standorts, oder null.
streetstringoptional
Straßenadresse, Zeile 1, oder null.
street1stringoptional
Straßenadresse, Zeile 2, oder null.
citystringoptional
Stadt.
statestringoptional
Bundesland oder Region.
postalCodestringoptional
Postleitzahl, oder null.
countrystringoptional
Land, als ISO-3166-1-Alpha-2-Code, oder null.
latitudenumberoptional
Breitengrad, oder null.
longitudenumberoptional
Längengrad, oder null.
phonestringoptional
Primäre Telefonnummer, oder null.
additionalPhonesarray of stringoptional
Weitere Telefonnummern zusätzlich zur primären.
websitestringoptional
Die Website-URL des Standorts, oder null.
businessEmailstringoptional
Eine öffentliche Kontakt-E-Mail für das Unternehmen, oder null.
categoryNamestringoptional
Der Anzeigename der allgemeinen Kategorie, oder null.
primaryCategoryDisplaystringoptional
Der Anzeigename der effektiven Primärkategorie — publisherspezifisch (Google), falls gesetzt, sonst allgemein — oder null.
primaryCategoryGooglestringoptional
Die primäre Google-Kategorie-ID des Standorts (gcid), oder null.
additionalCategoriesarray of objectoptional
Bis zu 9 zusätzliche Kategorien, jeweils mit einer id (wenn aufgelöst) und einem Anzeigenamen.
idstringoptional
namestringoptional
attributesarray of objectoptional
Google-Unternehmensprofil-Attribute, als gespeicherte { id, value }-Liste.
idstringoptional
valueobjectoptional
Der Wert des Attributs — ein Boolean für Ja/Nein-Attribute, ein String für Einzelauswahl-Attribute, oder ein Objekt mit setValues/unsetValues für Mehrfachauswahl.
servicesarray of objectoptional
Die Dienstleistungen oder Produkte, die dieser Standort anbietet.
namestringoptional
descriptionstringoptional
pricenumberoptional
currencystringoptional
googleServiceTypeIdstringoptional
ownerNamestringoptional
Der Name des Inhabers, oder null.
menuUrlstringoptional
URL der Speisekarte des Unternehmens, oder null.
socialLinksobjectoptional
URLs von Social-Media-Profilen nach Netzwerk oder null.
paymentMethodsarray of stringoptional
Akzeptierte Zahlungsarten als Anzeigenamen.
yearEstablishednumberoptional
Das Jahr, in dem das Unternehmen gegründet wurde, oder null.
tagsarray of stringoptional
Interne Tags für Ihre eigene Organisation — nicht öffentlich sichtbar.
labelsarray of stringoptional
Interne Labels für diesen Standort.
regularHoursarray of objectoptional
Der wöchentliche Standard-Öffnungszeitenplan, oder null.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)optional
closedbooleanoptional
periodsarray of objectoptional
openstringoptional
closestringoptional
moreHoursarray of objectoptional
Zusätzliche Öffnungszeitentypen über die regulären hinaus (Lieferung, Abholung usw.), oder null.
specialHoursarray of objectoptional
Einmalige Datumsüberschreibungen — Feiertagsschließungen oder Sonderöffnungszeiten für einen einzelnen Tag — oder null.
serviceAreaobjectoptional
Einstellungen für das Einzugsgebiet im Master oder null für ein reines Ladengeschäft.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)erforderlich
CUSTOMER_LOCATION_ONLY blendet die Adresse aus (nur Einzugsgebiet). CUSTOMER_AND_BUSINESS_LOCATION zeigt die Adresse und die bedienten Gebiete.
placesarray of objectoptional
Bediente Gebiete, höchstens 20. Jedes ist { name, placeId?, placeType? }. Google und Bing veröffentlichen sie. Facebook und Apple haben keine Liste von Einzugsgebieten, dort gilt nur die ausgeblendete Straße.
namestringerforderlich
placeIdstringoptional
Google-Place-ID des Gebiets. Google akzeptiert nur Orte mit einer solchen ID, daher wird ein Ort ohne sie gespeichert, aber nicht an Google gesendet.
placeTypestring (country | administrativeArea | locality | postalCode)optional
publisherOverridesobjectoptional
Publisher-spezifische Werte, die vom Master abweichen, geschlüsselt nach google, facebook, apple oder bing. Jeder Publisher veröffentlicht diese Werte; ein Publisher ohne Eintrag für ein Feld verwendet den Master-Wert. Bleiben erhalten, ob der Publisher verbunden ist oder nicht.
mediaByCategoryobjectoptional
Medienelemente gruppiert nach Kategorie (z. B. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Jedes Element hat eine url und optional ein label, ein kind (PHOTO oder VIDEO), eine source, ein starred-Flag und einen assetKey.
clientIdstringoptional
ID des Kunden, zu dem dieser Standort gehört, oder null.
archivedbooleanoptional
Ob der Standort archiviert ist.
scheduledArchiveAtstringoptional
Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Token, auf das cancel-archive abgleicht), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.
verificationStatusstring (verified | pending | unverified | unknown)optional
Google-Verifizierungsstatus: verified, pending, unverified oder unknown, oder null.
Fehler
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/locations/{id}
Ihr API-Schlüssel
id *
{
  "data": {
    "id": "loc_456",
    "name": "Acme Dental — Downtown",
    "description": null,
    "tagline": null,
    "storeCode": null,
    "logoUrl": null,
    "street": "123 Main St",
    "street1": null,
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "latitude": 30.2672,
    "longitude": -97.7431,
    "phone": "+15125551234",
    "additionalPhones": [],
    "website": "https://acmedental.com",
    "businessEmail": null,
    "categoryName": "Dentist",
    "primaryCategoryDisplay": "Dentist",
    "primaryCategoryGoogle": "gcid:dentist",
    "additionalCategories": [],
    "attributes": [
      {
        "id": "attributes/wi_fi",
        "value": true
      }
    ],
    "services": [
      {
        "name": "Teeth Whitening",
        "description": null,
        "price": 150,
        "currency": "USD",
        "googleServiceTypeId": null
      }
    ],
    "ownerName": null,
    "menuUrl": null,
    "yearEstablished": null,
    "tags": [
      "vip"
    ],
    "labels": [],
    "regularHours": [
      {
        "day": "MONDAY",
        "closed": false,
        "periods": [
          {
            "openTime": "09:00",
            "closeTime": "17:00"
          }
        ]
      }
    ],
    "moreHours": [],
    "specialHours": [],
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg"
        }
      ]
    },
    "clientId": "cli_123",
    "archived": false,
    "scheduledArchiveAt": null,
    "verificationStatus": "verified"
  }
}

Anleitungen, die diesen Endpunkt verwenden