Synup
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. La synchronisation démarre environ 15 minutes après la dernière modification de l'établissement, de sorte que plusieurs modifications rapprochées sont envoyées ensemble en une seule mise à jour.

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 magasin ou référence interne pour cet établissement. Une chaîne vide le supprime, y compris sur Google.
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.
openStatusstring (OPEN | CLOSED_TEMPORARILY | CLOSED_PERMANENTLY)facultatif
Whether the business is open: OPEN, CLOSED_TEMPORARILY or CLOSED_PERMANENTLY. Send null to clear it.
openingDatestringfacultatif
When the business opened or will open, as YYYY-MM-DD. Send null to clear it.
googleAdsPhonestringfacultatif
The phone number Google Ads call extensions use for this location. Send null to clear it.
relationshipDataobjectfacultatif
Chain membership and parent or child links as Google models them: parentChain (chains/{id} or null), parentLocation (a placeId and relationType) and childrenLocations (a list of the same). It replaces the stored value; send null to clear it.
businessEmailstringfacultatif
Une adresse e-mail de contact publique pour l'entreprise.
categoryIdstringfacultatif
Id de la catégorie générale, issu de GET /api/v1/locations/categories. Un établissement a besoin d'une catégorie : envoyez ceci, categoryName ou publisherCategories.google.
categoryNamestringfacultatif
Nom affiché de la catégorie générale. Un établissement a besoin d'une catégorie : envoyez ceci, categoryId ou publisherCategories.google. Un nom absent du catalogue est conservé comme catégorie affichée.
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
serviceAreaobjectfacultatif
Paramètres de zone desservie dans Master, pour une entreprise qui se déplace chez ses clients. Définissez businessType sur CUSTOMER_LOCATION_ONLY pour masquer l'adresse : aucun publisher ne reçoit une rue qu'il afficherait, même si elle est enregistrée. Envoyez null pour la retirer. Pour la définir seulement pour certains publishers, utilisez publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obligatoire
CUSTOMER_LOCATION_ONLY masque l'adresse (zone desservie uniquement). CUSTOMER_AND_BUSINESS_LOCATION affiche l'adresse et les zones desservies.
placesarray of objectfacultatif
Zones desservies, 20 au maximum. Chacune est { name, placeId?, placeType? }. Google et Bing les publient. Facebook et Apple n'ont pas de liste de zones desservies : pour eux, seule la rue masquée s'applique.
namestringobligatoire
placeIdstringfacultatif
Identifiant de lieu Google de la zone. Google n'accepte que les lieux qui en ont un : un lieu sans identifiant est enregistré mais n'est pas envoyé à Google.
placeTypestring (country | administrativeArea | locality | postalCode)facultatif
publisherServiceAreasobjectfacultatif
Une zone desservie différente pour Google, Facebook, Apple ou Bing, chacune au même format que serviceArea, enregistrée comme valeur propre de ce publisher. Envoyez null pour un publisher afin de retirer sa valeur propre : il utilise alors de nouveau serviceArea. Envoyée avec serviceArea, elle définit Master et les publishers en un seul appel. Ne peut pas être combinée avec applyToPublishers.
googleobjectfacultatif
Paramètres de zone desservie dans Master, pour une entreprise qui se déplace chez ses clients. Définissez businessType sur CUSTOMER_LOCATION_ONLY pour masquer l'adresse : aucun publisher ne reçoit une rue qu'il afficherait, même si elle est enregistrée. Envoyez null pour la retirer. Pour la définir seulement pour certains publishers, utilisez publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obligatoire
CUSTOMER_LOCATION_ONLY masque l'adresse (zone desservie uniquement). CUSTOMER_AND_BUSINESS_LOCATION affiche l'adresse et les zones desservies.
placesarray of objectfacultatif
Zones desservies, 20 au maximum. Chacune est { name, placeId?, placeType? }. Google et Bing les publient. Facebook et Apple n'ont pas de liste de zones desservies : pour eux, seule la rue masquée s'applique.
namestringobligatoire
placeIdstringfacultatif
Identifiant de lieu Google de la zone. Google n'accepte que les lieux qui en ont un : un lieu sans identifiant est enregistré mais n'est pas envoyé à Google.
placeTypestring (country | administrativeArea | locality | postalCode)facultatif
facebookobjectfacultatif
Paramètres de zone desservie dans Master, pour une entreprise qui se déplace chez ses clients. Définissez businessType sur CUSTOMER_LOCATION_ONLY pour masquer l'adresse : aucun publisher ne reçoit une rue qu'il afficherait, même si elle est enregistrée. Envoyez null pour la retirer. Pour la définir seulement pour certains publishers, utilisez publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obligatoire
CUSTOMER_LOCATION_ONLY masque l'adresse (zone desservie uniquement). CUSTOMER_AND_BUSINESS_LOCATION affiche l'adresse et les zones desservies.
placesarray of objectfacultatif
Zones desservies, 20 au maximum. Chacune est { name, placeId?, placeType? }. Google et Bing les publient. Facebook et Apple n'ont pas de liste de zones desservies : pour eux, seule la rue masquée s'applique.
namestringobligatoire
placeIdstringfacultatif
Identifiant de lieu Google de la zone. Google n'accepte que les lieux qui en ont un : un lieu sans identifiant est enregistré mais n'est pas envoyé à Google.
placeTypestring (country | administrativeArea | locality | postalCode)facultatif
appleobjectfacultatif
Paramètres de zone desservie dans Master, pour une entreprise qui se déplace chez ses clients. Définissez businessType sur CUSTOMER_LOCATION_ONLY pour masquer l'adresse : aucun publisher ne reçoit une rue qu'il afficherait, même si elle est enregistrée. Envoyez null pour la retirer. Pour la définir seulement pour certains publishers, utilisez publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obligatoire
CUSTOMER_LOCATION_ONLY masque l'adresse (zone desservie uniquement). CUSTOMER_AND_BUSINESS_LOCATION affiche l'adresse et les zones desservies.
placesarray of objectfacultatif
Zones desservies, 20 au maximum. Chacune est { name, placeId?, placeType? }. Google et Bing les publient. Facebook et Apple n'ont pas de liste de zones desservies : pour eux, seule la rue masquée s'applique.
namestringobligatoire
placeIdstringfacultatif
Identifiant de lieu Google de la zone. Google n'accepte que les lieux qui en ont un : un lieu sans identifiant est enregistré mais n'est pas envoyé à Google.
placeTypestring (country | administrativeArea | locality | postalCode)facultatif
bingobjectfacultatif
Paramètres de zone desservie dans Master, pour une entreprise qui se déplace chez ses clients. Définissez businessType sur CUSTOMER_LOCATION_ONLY pour masquer l'adresse : aucun publisher ne reçoit une rue qu'il afficherait, même si elle est enregistrée. Envoyez null pour la retirer. Pour la définir seulement pour certains publishers, utilisez publisherServiceAreas ou applyToPublishers.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obligatoire
CUSTOMER_LOCATION_ONLY masque l'adresse (zone desservie uniquement). CUSTOMER_AND_BUSINESS_LOCATION affiche l'adresse et les zones desservies.
placesarray of objectfacultatif
Zones desservies, 20 au maximum. Chacune est { name, placeId?, placeType? }. Google et Bing les publient. Facebook et Apple n'ont pas de liste de zones desservies : pour eux, seule la rue masquée s'applique.
namestringobligatoire
placeIdstringfacultatif
Identifiant de lieu Google de la zone. Google n'accepte que les lieux qui en ont un : un lieu sans identifiant est enregistré mais n'est pas envoyé à Google.
placeTypestring (country | administrativeArea | locality | postalCode)facultatif
socialLinksobjectfacultatif
URL des profils sociaux : facebook, instagram, twitter, linkedin, youtube, tiktok, pinterest. Lors d'une mise à jour, seules les clés envoyées changent ; null en supprime une. Publiées sur Google comme ses attributs url_*, ainsi que sur Bing et Apple.
facebookstringfacultatif
instagramstringfacultatif
twitterstringfacultatif
linkedinstringfacultatif
youtubestringfacultatif
tiktokstringfacultatif
pintereststringfacultatif
paymentMethodsarray of stringfacultatif
Moyens de paiement acceptés, par exemple « Visa », « American Express », « Cash only ». Remplace toute la liste ; une liste vide ou null la vide. Publiés sur Google comme ses attributs pay_*, ainsi que sur Apple et Bing.
attributesobjectfacultatif
Attributs de la fiche d'établissement Google, sous forme de map id d'attribut vers valeur (ex. { "attributes/wi_fi": "free" }). REMPLACE l'ensemble, y compris les liens url_* comme les liens de rendez-vous ou de concessionnaire : lisez les attributs actuels avec GET /api/v1/locations/{id} et renvoyez tout ce que vous voulez garder. Les ids que Google ne propose pas pour la catégorie de l'établissement ne sont pas enregistrés et sont renvoyés dans rejectedAttributes ; le reste de la mise à jour s'applique quand même. Les ids sociaux, de menu et de paiement (url_facebook, url_menu, pay_*, …) y sont aussi renvoyés : définissez-les avec socialLinks, menuUrl et paymentMethods.
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
Modifie ces valeurs pour certains publishers seulement, au lieu de la valeur commune dont héritent tous les publishers. Chaque publisher indiqué publie sa propre valeur ; les autres continuent d'utiliser la valeur principale. Enregistrée même si un publisher n'est pas connecté, et publiée dès qu'il l'est. Retirez-la avec clearPublisherOverrides.
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.
socialLinksobjectfacultatif
URL des profils sociaux par réseau, ou null.
paymentMethodsarray of stringfacultatif
Moyens de paiement acceptés, sous forme de libellés.
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.
serviceAreaobjectfacultatif
Paramètres de zone desservie dans Master, ou null pour un simple établissement physique.
businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obligatoire
CUSTOMER_LOCATION_ONLY masque l'adresse (zone desservie uniquement). CUSTOMER_AND_BUSINESS_LOCATION affiche l'adresse et les zones desservies.
placesarray of objectfacultatif
Zones desservies, 20 au maximum. Chacune est { name, placeId?, placeType? }. Google et Bing les publient. Facebook et Apple n'ont pas de liste de zones desservies : pour eux, seule la rue masquée s'applique.
publisherOverridesobjectfacultatif
Valeurs propres à chaque publisher qui diffèrent de Master, avec les clés google, facebook, apple ou bing. Chaque publisher publie ces valeurs ; un publisher sans entrée pour un champ utilise la valeur de Master. Conservées que le publisher soit connecté ou non.
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": []
  }
}

Guides qui utilisent cet endpoint