Listings APIListings API
Se connecter

Photos

Ajoutez, listez, supprimez et marquez comme favorites les photos d’un établissement via client.photos.

Toutes les méthodes de gestion des photos se trouvent sous client.photos. Chaque méthode prend un location_id, sauf upload_status, et location_id accepte les identifiants numériques ou encodés en base64 ; voir Identifiants des établissements.

Les photos sont jointes via une URL publique plutôt qu’envoyées sous forme de données de formulaire multipart : vous hébergez l’image, la plateforme la récupère et le traitement se poursuit en arrière-plan. Les types de photos sont LOGO, COVER et ADDITIONAL.

photos.list

Récupérez les fichiers multimédias associés à un établissement, qu’ils soient marqués comme favoris ou non.

Python
client.photos.list(location_id: str | int) -> list[APIObject]
Python
photos = client.photos.list(16808)for photo in photos:  print(photo.id, photo.categoryName, photo.starred)

Renvoie la liste mediaFilesOfLocation. Chaque élément contient id, url, thumbnailUrl, categoryName, categoryId, fileType, starred et viewsCount. La valeur de id est celle que vous transmettez à remove et à star. Voir Récupérer les photos d’un établissement.

photos.add

Associez une ou plusieurs photos à un établissement. Chaque élément de photos doit comporter une clé photo contenant une URL d’image publique et une clé type.

Python
client.photos.add(    location_id: str | int,    photos: list[dict[str, Any]],) -> APIObject
CléTypeDescription
photostrURL publique de l’image à récupérer.
typestrLOGO, COVER ou ADDITIONAL.
Python
result = client.photos.add(16808, [  {"photo": "https://cdn.example.com/acme-logo.png", "type": "LOGO"},  {"photo": "https://cdn.example.com/acme-storefront.jpg", "type": "ADDITIONAL"},])for photo in result.photos:  print(photo.id, photo.type)

Renvoie l’objet addLocationPhotos contenant success, photos, request et errors. Chaque entrée de photos contient id, databaseId, url, thumbnailUrl, type et starred. Voir Ajouter des photos à un établissement.

photos.remove

Dissociez des photos d’un établissement à l’aide de leurs identifiants de média.

Python
client.photos.remove(    location_id: str | int,    photo_ids: list[str],) -> APIObject
Python
result = client.photos.remove(16808, ["TWVkaWFGaWxlOjU4Nzg5MzE="])print(result.removedCount)

Renvoie l’objet removeLocationPhotos contenant removedCount et errors. Voir Retirer des photos d’un établissement.

photos.star

Marquez des photos comme favorites ou retirez ce marquage pour que les plateformes de publication compatibles les affichent en premier. Transmettez starred=False pour retirer le marquage. Un maximum de 4 photos peuvent être marquées comme favorites par compte.

Python
client.photos.star(    location_id: str | int,    media_ids: list[str],    *,    starred: bool = True,) -> APIObject

Le paramètre Python se nomme media_ids et contient les mêmes valeurs id de média que celles renvoyées par photos.list. Le SDK les envoie dans le champ photoIds de la requête, vous n’avez donc jamais à construire ce champ vous-même.

Python
# Star two photosclient.photos.star(16808, ["TWVkaWFGaWxlOjU4Nzg5MzI=", "TWVkaWFGaWxlOjU4Nzg5MzM="]) # Unstar oneresult = client.photos.star(16808, ["TWVkaWFGaWxlOjU4Nzg5MzI="], starred=False)for photo in result.photos:  print(photo.id, photo.starred)

Renvoie l’objet starUnstarLocationPhotos contenant success, photos et error. Voir Marquer les photos d’un établissement comme favorites.

photos.upload_status

Vérifiez la progression d’un ajout de photos en masse. Appelez régulièrement cette méthode lorsque vous avez ajouté de nombreuses photos à la fois et avez besoin des résultats pour chaque image.

Python
client.photos.upload_status(request_id: str) -> APIObject
Python
status = client.photos.upload_status("e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a")print(status.to_dict())

Voir Vérifier l’état d’un ajout de photos en masse pour les champs d’état et d’erreur de chaque photo, y compris les motifs de rejet possibles.

Voir aussi