Synupv1
Créer une clé
v1Ressources/Locations/patchMettre à jour un établissement

Mettre à jour un établissement

Modifie les informations commerciales d'un établissement existant — adresse, catégories, attributs du profil d'établissement Google, services et horaires. Envoyez uniquement les champs que vous souhaitez changer ; un champ envoyé remplace entièrement sa valeur actuelle (une chaîne vide efface un champ texte, une nouvelle liste complète remplace la liste existante). Le pays ne peut pas être modifié après la création. Les modifications enregistrées sont automatiquement mises en file d'attente pour se synchroniser vers les annuaires et fiches connectés.

patch/api/v1/locations/{id}
locations:write
Paramètres de requête
idstringobligatoire
L'établissement à mettre à jour.
Corps de la requête
namestringfacultatif
Le nom commercial de l'établissement.
descriptionstringfacultatif
Une courte description de l'entreprise.
taglinestringfacultatif
Un court slogan pour l'entreprise.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement.
logoUrlstringfacultatif
URL de l'image du logo de l'établissement.
languageCodestringfacultatif
La langue principale de la fiche, sous forme de code (par ex. « en »).
streetstringfacultatif
Adresse postale.
street1stringfacultatif
Adresse postale, ligne 2.
citystringfacultatif
Ville.
stateIsostringfacultatif
État ou région, au format code ISO (par ex. « CA »).
postalCodestringfacultatif
Code postal.
latitudenumberfacultatif
Latitude. Si vous modifiez l'adresse sans définir également ce champ, elle est redérivée automatiquement.
longitudenumberfacultatif
Longitude. Si vous modifiez l'adresse sans définir également ce champ, elle est redérivée automatiquement.
phonestringfacultatif
Numéro de téléphone.
additionalPhonesarray of stringfacultatif
Tout numéro de téléphone supplémentaire en plus du principal.
websitestringfacultatif
URL du site web.
businessEmailstringfacultatif
Une adresse e-mail de contact publique pour l'entreprise.
categoryIdstringfacultatif
Id de catégorie générale — à rechercher avec GET /api/v1/locations/categories.
categoryNamestringfacultatif
Nom d'affichage de la catégorie générale.
publisherCategoriesobjectfacultatif
Catégorie PRINCIPALE par publisher — seul google est actuellement pris en charge ici (un id et un name sont tous deux obligatoires ; n'en transmettre qu'un seul effacerait la catégorie). Facebook/Apple/Bing ne peuvent être modifiés que dans l'éditeur d'établissement. Recherchez la paire id/name de google avec GET /api/v1/locations/publisher-categories.
googleobjectfacultatif
idstringfacultatif
namestringfacultatif
additionalCategoriesarray of objectfacultatif
Jusqu'à 9 catégories supplémentaires, chacune un { id?, name }. Un simple name est accepté et son id est résolu à partir du catalogue de catégories lorsqu'une correspondance existe. Recherchez les identifiants vous-même avec GET /api/v1/locations/categories.
idstringfacultatif
namestringfacultatif
attributesobjectfacultatif
Attributs du profil d'établissement Google, sous forme de correspondance entre id d'attribut et valeur (par ex. { "attributes/wi_fi": "free" }) — REMPLACE l'ensemble complet, donc lisez les valeurs actuelles via GET /api/v1/locations/{id} et renvoyez tout ce que vous souhaitez conserver. Un id sans représentation Google valide pour la catégorie de cet établissement est écarté et signalé dans rejectedAttributes plutôt que de faire échouer toute la requête. Il n'existe aucun endpoint listant les ids d'attributs valides pour une catégorie — il s'agit de la référence des attributs Business Profile propre à Google, pas de celle de Synup.
servicesarray of objectfacultatif
Les services ou produits proposés par cet établissement — remplace la liste existante.
namestringfacultatif
descriptionstringfacultatif
pricenumberfacultatif
currencystringfacultatif
googleServiceTypeIdstringfacultatif
ownerNamestringfacultatif
Le nom du propriétaire.
menuUrlstringfacultatif
URL du menu de l'entreprise.
yearEstablishednumberfacultatif
L'année de création de l'entreprise (par ex. 2012).
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement. Remplace la liste existante.
labelsarray of stringfacultatif
Libellés internes pour cet établissement. Remplace la liste existante.
regularHoursarray of objectfacultatif
Les horaires réguliers hebdomadaires — remplace entièrement l'horaire existant. Une entrée par jour de la semaine.
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, happy hour, etc.), remplace la liste existante.
specialHoursarray of objectfacultatif
Des exceptions ponctuelles par date — fermetures pour jours fériés ou horaires spéciaux d'un seul jour — remplace la liste existante. N'importe quelle date du calendrier fonctionne, pas seulement les jours fériés nommés.
applyToPublishersarray of string (google | facebook | apple | bing)facultatif
Change ces valeurs pour des publishers spécifiques uniquement, au lieu de la valeur partagée par défaut dont hérite chaque publisher.
Réponse
dataobjectfacultatif
locationobjectfacultatif
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
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.
rejectedAttributesarray of stringfacultatif
Les ids d'attributs de la requête qui n'ont PAS été écrits — soit ils disposent de leur propre champ dédié, soit leur valeur n'avait aucune représentation Google valide. Présent uniquement lorsqu'au moins un a été rejeté.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
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.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
patch/api/v1/locations/{id}
Votre clé API
id *
Corps de la requête
{
  "data": {
    "location": {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "tagline": "Gentle care, on time",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123"
    },
    "rejectedAttributes": []
  }
}