Synupv1
Créer une clé
v1Ressources/Locations/getObtenir un établissement

Obtenir un établissement

Renvoie le profil complet d'un établissement : adresse, horaires, catégories, attributs, services, médias et statut de vérification.

get/api/v1/locations/{id}
locations:read
Paramètres de requête
idstringobligatoire
L'établissement à consulter.
Réponse
dataobjectfacultatif
Le profil complet d'un établissement : adresse, horaires, catégories, attributs, services, médias et statut — tout ce que update_location peut modifier, plus ce que create a renvoyé.
idstringfacultatif
Identifiant unique de l'établissement.
namestringfacultatif
Le nom commercial de l'établissement.
descriptionstringfacultatif
Une description de l'entreprise, ou null.
taglinestringfacultatif
Un court slogan pour l'entreprise, ou null.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement, ou null.
logoUrlstringfacultatif
URL de l'image du logo de l'établissement, ou null.
streetstringfacultatif
Adresse postale, ligne 1, ou null.
street1stringfacultatif
Adresse postale, ligne 2, ou null.
citystringfacultatif
Ville.
statestringfacultatif
État ou région.
postalCodestringfacultatif
Code postal, ou null.
countrystringfacultatif
Pays, au format code ISO-3166-1 alpha-2, ou null.
latitudenumberfacultatif
Latitude, ou null.
longitudenumberfacultatif
Longitude, ou null.
phonestringfacultatif
Numéro de téléphone principal, ou null.
additionalPhonesarray of stringfacultatif
Tout numéro de téléphone supplémentaire en plus du principal.
websitestringfacultatif
L'URL du site web de l'établissement, ou null.
businessEmailstringfacultatif
Une adresse e-mail de contact publique pour l'entreprise, ou null.
categoryNamestringfacultatif
Le nom d'affichage de la catégorie générale, ou null.
primaryCategoryDisplaystringfacultatif
Le nom d'affichage de la catégorie principale effective — par publisher (Google) si définie, sinon générale — ou null.
primaryCategoryGooglestringfacultatif
L'id de catégorie Google principale de l'établissement (gcid), ou null.
additionalCategoriesarray of objectfacultatif
Jusqu'à 9 catégories supplémentaires, chacune avec un id (lorsqu'il est résolu) et un nom d'affichage.
idstringfacultatif
namestringfacultatif
attributesarray of objectfacultatif
Attributs du profil d'établissement Google, sous forme de liste stockée { id, value }.
idstringfacultatif
valueobjectfacultatif
La valeur de l'attribut — un booléen pour les attributs oui/non, une chaîne pour les attributs à choix unique, ou un objet avec setValues/unsetValues pour les choix multiples.
servicesarray of objectfacultatif
Les services ou produits proposés par cet établissement.
namestringfacultatif
descriptionstringfacultatif
pricenumberfacultatif
currencystringfacultatif
googleServiceTypeIdstringfacultatif
ownerNamestringfacultatif
Le nom du propriétaire, ou null.
menuUrlstringfacultatif
URL du menu de l'entreprise, ou null.
yearEstablishednumberfacultatif
L'année de création de l'entreprise, ou null.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
labelsarray of stringfacultatif
Libellés internes pour cet établissement.
regularHoursarray of objectfacultatif
Les horaires réguliers hebdomadaires, ou null.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)facultatif
closedbooleanfacultatif
periodsarray of objectfacultatif
openstringfacultatif
closestringfacultatif
moreHoursarray of objectfacultatif
Types d'horaires supplémentaires au-delà des horaires réguliers (livraison, à emporter, etc.), ou null.
specialHoursarray of objectfacultatif
Des exceptions ponctuelles par date — fermetures pour jours fériés ou horaires spéciaux d'un seul jour — ou null.
mediaByCategoryobjectfacultatif
Éléments multimédias regroupés par catégorie (par ex. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Chaque élément possède une url et, éventuellement, un label, un kind (PHOTO ou VIDEO), une source, un indicateur starred et un assetKey.
clientIdstringfacultatif
ID du client auquel appartient cet établissement, ou null.
archivedbooleanfacultatif
Si l'établissement est archivé.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (également le jeton sur lequel cancel-archive se base), au format horodatage ISO 8601, ou null si aucun n'est en attente.
verificationStatusstring (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown, ou null.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/{id}
Votre clé API
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"
  }
}