Obter fotos de um local

Nome	Tipo	Obrigatório	Descrição
locationId	string	obrigatório	The location's Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). The raw numeric database ID (`1800289`) is also accepted, and so is a percent-encoded value such as `...%3D%3D`.

Nome

Tipo

Obrigatório

Descrição

locationId

string

obrigatório

The location's Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). The raw numeric database ID (`1800289`) is also accepted, and so is a percent-encoded value such as `...%3D%3D`.

Respostas

200Array of media files for the location. Returns an empty array when the location has no photos.

Response

{  "data": {    "mediaFilesOfLocation": [      {        "id": "TWVkaWFGaWxlOjU4Nzg5MzE=",        "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/f47d62a6.jpg",        "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_f47d62a6.jpg",        "categoryName": "Logo",        "categoryId": "4",        "fileType": "image",        "starred": false,        "viewsCount": 0      },      {        "id": "TWVkaWFGaWxlOjU4Nzg5MzI=",        "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",        "categoryName": "Additional",        "categoryId": "12",        "fileType": "image",        "starred": true,        "viewsCount": 143      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Retorna todos os arquivos de mídia anexados a um local: logotipo, capa e imagens adicionais, com url público, thumbnailUrl, categoria, indicação de que o arquivo é starred e um viewsCount referente a todo o período de existência de cada arquivo.

Caso de uso: renderizar a galeria de fotos de um local. Busque a lista de mídias para exibir as imagens que uma empresa já tem publicadas, usando thumbnailUrl para a grade e url para a visualização em tamanho original. starred informa quais fotos adicionais estão fixadas para posicionamento prioritário nas plataformas de publicação compatíveis.

Caso de uso: auditar a cobertura de mídia antes de um upload. Chame este endpoint primeiro para verificar se falta uma imagem da categoria Logo ou Cover em um local e, em seguida, envie apenas o que estiver faltando. Os valores de id retornados são exatamente os que você passa para os endpoints star e remove.

Pontos de atenção.

Qualquer uma das formas de id funciona no caminho: 1800289, TG9jYXRpb246MTgwMDI4OQ== e TG9jYXRpb246MTgwMDI4OQ%3D%3D apontam para o mesmo local. Um valor que não corresponda a nenhuma delas retorna HTTP 200 com um array errors contendo SY90002: Invalid Id e um payload null.
Um local sem mídia retorna { "data": { "mediaFilesOfLocation": [] } }; essa é a resposta real para um local recém-criado, como "Jenny Home", e não um erro.

Obter fotos de um local

Parâmetros

Caminho

Respostas