Listings APIListings API
Entrar
POST/api/v4/locations/photos/star

Marcar fotos do local como favoritas

Marca uma ou mais fotos adicionais de um local como favoritas para dar a elas posicionamento prioritário nas plataformas de publicação compatíveis.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
input.locationIdstringobrigatórioThe location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of stringsobrigatórioMedia file IDs to star (as returned by the get-photos or upload endpoints).
input.starredbooleanobrigatório`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.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

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

Respostas

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.

Marca as fotos especificadas de um local como favoritas. As fotos favoritas recebem posicionamento prioritário nos diretórios das plataformas de publicação que oferecem suporte a imagens em destaque, permitindo que você promova suas melhores fotos para o topo de uma listagem.

Caso de uso: destacar uma imagem principal sazonal. Depois de enviar uma nova foto da fachada, marque-a como favorita para que ela apareça primeiro na galeria do Google e de outros sites compatíveis. Passe o ID da mídia retornado na resposta do upload em photoIds.

Caso de uso: selecionar um conjunto consistente de imagens da marca. Ao gerenciar muitos locais, marque como favorita a mesma categoria de foto adicional (por exemplo, a foto da área externa) em cada local para manter a consistência da galeria exibida ao público.

Pontos de atenção.

  • A resposta usa a chave starUnstarLocationPhotos, e não o nome da rota, e a chave é a mesma em /locations/photos/star e /locations/photos/unstar.
  • Seu payload contém um único objeto error, e não um array errors, e não há clientMutationId. Também não há um campo caption nas fotos.
  • Somente fotos da categoria ADDITIONAL podem ser marcadas como favoritas. As imagens LOGO e COVER já são principais e não podem ser marcadas como favoritas.
  • Um local pode ter no máximo 4 fotos favoritas; ultrapassar esse limite causa uma falha com SY15012. A verificação conta as fotos já marcadas como favoritas mais as fotos desta requisição e só se aplica quando starred é true.
  • Para reverter a ação, use POST /api/v4/locations/photos/unstar com starred: false. O valor de starred determina o que acontece, e não o caminho: enviar starred: true via POST para /unstar marca as fotos como favoritas.
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