Listings APIListings API
Se connecter
POST/api/v4/locations/photos/star

Marquer des photos d’un établissement comme favorites

Met une ou plusieurs photos supplémentaires d’un établissement en favoris pour un affichage prioritaire sur les plateformes de publication compatibles.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Corps

NomTypeObligatoireDescription
input.locationIdstringobligatoireThe location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of stringsobligatoireMedia file IDs to star (as returned by the get-photos or upload endpoints).
input.starredbooleanobligatoire`true` to star the given photos, `false` to unstar them. This flag, not the path, decides what happens: `/star` and `/unstar` behave the same way.

Exemple de requête

Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "photoIds": [      "TWVkaWFGaWxlOjU4Nzg5MzI="    ],    "starred": true  }}

Réponses

200Photos starred. Returns each affected photo with `starred` set to true; `error` is null on success.
Response
{  "data": {    "starUnstarLocationPhotos": {      "success": true,      "photos": [        {          "id": "TWVkaWFGaWxlOjU4Nzg5MzI=",          "databaseId": 5878932,          "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/ef4ffb12.jpg",          "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_ef4ffb12.jpg",          "type": "ADDITIONAL",          "starred": true        }      ],      "error": null    }  }}
401Unauthenticated, missing or invalid API key.

Marque les photos spécifiées d’un établissement comme favorites. Les photos favorites bénéficient d’un placement prioritaire dans les annuaires des plateformes de publication qui prennent en charge les images mises en avant, ce qui vous permet de placer vos meilleurs clichés en tête d’une fiche.

Cas d’utilisation : mettre en avant une image principale saisonnière. Après avoir téléversé une nouvelle photo de la devanture, marquez-la comme favorite pour qu’elle apparaisse en tête de la galerie sur Google et les autres sites compatibles. Transmettez l’ID du média issu de la réponse au téléversement dans photoIds.

Cas d’utilisation : sélectionner un ensemble de photos cohérent pour la marque. Lorsque vous gérez de nombreux établissements, marquez comme favorite la même catégorie de photo supplémentaire (par exemple, la photo de l’extérieur) pour chaque établissement afin de maintenir la cohérence des galeries visibles par le public.

Points de vigilance.

  • La réponse utilise la clé starUnstarLocationPhotos, qui ne reprend pas le nom de la route, et cette clé est identique pour /locations/photos/star et /locations/photos/unstar.
  • Sa charge utile contient un objet error unique, et non un tableau errors, et ne comporte pas de clientMutationId. Les photos ne comportent pas non plus de champ caption.
  • Seules les photos de la catégorie ADDITIONAL peuvent être marquées comme favorites. Les images LOGO et COVER sont déjà principales et ne peuvent pas être marquées comme favorites.
  • Un établissement peut avoir au maximum 4 photos favorites ; tout dépassement de cette limite entraîne un échec avec SY15012. La vérification comptabilise les photos déjà favorites ainsi que celles de cette requête, et ne s’applique que lorsque starred vaut true.
  • Pour annuler l’action, utilisez POST /api/v4/locations/photos/unstar avec starred: false. C’est la valeur de starred qui détermine l’action effectuée, et non le chemin : l’envoi de starred: true à /unstar marque les photos comme favorites.
Request
curl -X POST 'https://listingsapi.com/api/v4/locations/photos/star' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "photoIds": [        "TWVkaWFGaWxlOjU4Nzg5MzI="      ],      "starred": true    }  }'
Run in playground