Synup
Créer une clé
v1Ressources/Locations/postCréer un établissement

Créer un établissement

Crée un établissement, sous l'un de vos clients (clientId) ou seul, et le soumet pour publication. Nécessite name, countryIso et une catégorie : categoryId, categoryName ou publisherCategories.google.

post/api/v1/locations
locations:write
Corps de la requête
clientIdstringfacultatif
ID du client sous lequel créer cet emplacement. Trouvez-le avec GET /api/v1/clients. Facultatif, comme « Sans client » dans l'application : s'il est omis, l'emplacement est créé seul. Une clé limitée à certains clients doit l'envoyer.
kindstring (location | website)facultatif
location (the default) is a physical business listing. website is a website entity — a brand's site tracked for reviews, SEO, AEO and social — created from a name and a website alone. It is not a billable location, and it needs website entities enabled for the workspace (403 otherwise).
namestringobligatoire
Le nom commercial de l'établissement.
countryIsostringfacultatif
Code pays ISO, par ex. US.
streetstringfacultatif
Adresse postale.
street1stringfacultatif
Adresse postale, ligne 2.
citystringfacultatif
Ville.
stateIsostringfacultatif
Code de l'état ou de la région.
postalCodestringfacultatif
Code postal.
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.
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égories par publisher, une par publisher, chacune un { id, name } obtenu via GET /api/v1/locations/publisher-categories. À la création, publisherCategories.google satisfait aussi l'exigence de catégorie.
googleobjectfacultatif
idstringfacultatif
namestringfacultatif
facebookobjectfacultatif
idstringfacultatif
namestringfacultatif
appleobjectfacultatif
idstringfacultatif
namestringfacultatif
bingobjectfacultatif
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
descriptionstringfacultatif
Une courte description de l'entreprise.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
latitudenumberfacultatif
Latitude, en degrés décimaux. Dérivée automatiquement de l'adresse si omise.
longitudenumberfacultatif
Longitude, en degrés décimaux. Dérivée automatiquement de l'adresse si omise.
customFieldsobjectfacultatif
Valeurs de champs personnalisés à définir sur cet établissement, indexées par id de champ.
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. Elle est enregistrée comme valeur propre de ce publisher et renvoyée dans publisherOverrides. Un publisher omis utilise serviceArea.
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.
Réponse
dataobjectfacultatif
locationIdstringfacultatif
ID de l'établissement nouvellement créé.
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.
post/api/v1/locations
Votre clé API
Corps de la requête*
{
  "data": {
    "locationId": "loc_456"
  }
}

Guides qui utilisent cet endpoint