GET/api/v4/locations/{locationId}/photos

Ambil foto untuk suatu lokasi

Mengembalikan semua file media yang dilampirkan ke satu lokasi, termasuk foto yang diberi bintang maupun yang tidak.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Path

NamaTipeWajibDeskripsi
locationIdstringwajibThe 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`.

Respons

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.

Mengembalikan setiap file media yang dilampirkan ke suatu lokasi: logo, sampul, dan gambar tambahan, beserta url publik, thumbnailUrl, kategori, apakah file tersebut starred, dan viewsCount sepanjang masa untuk setiap file.

Kasus penggunaan: tampilkan galeri foto suatu lokasi. Ambil daftar media untuk menampilkan gambar bisnis yang sudah dipublikasikan, menggunakan thumbnailUrl untuk tampilan kisi dan url untuk tampilan ukuran penuh. starred memberi tahu Anda foto tambahan mana yang disematkan agar mendapat prioritas penempatan di platform publikasi yang didukung.

Kasus penggunaan: audit kelengkapan media sebelum mengunggah. Panggil endpoint ini terlebih dahulu untuk melihat apakah suatu lokasi belum memiliki gambar dalam kategori Logo atau Cover, lalu unggah hanya yang belum ada. Nilai id yang dikembalikan adalah nilai persis yang Anda teruskan ke endpoint untuk memberi bintang dan menghapus.

Hal-hal yang perlu diperhatikan.

  • Kedua bentuk id dapat digunakan dalam path: 1800289, TG9jYXRpb246MTgwMDI4OQ==, dan TG9jYXRpb246MTgwMDI4OQ%3D%3D semuanya mengarah ke lokasi yang sama. Nilai yang tidak sesuai dengan kedua bentuk tersebut menghasilkan HTTP 200 dengan array errors yang berisi SY90002: Invalid Id dan payload null.
  • Lokasi tanpa media mengembalikan { "data": { "mediaFilesOfLocation": [] } }; ini adalah respons aktual untuk lokasi yang baru dibuat seperti "Jenny Home", bukan kesalahan.
Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/photos' \  -H "Authorization: API $LISTINGSAPI_KEY"