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

Bir konumun fotoğraflarını alın

Yıldızlı ve yıldızsız fotoğraflar dahil, tek bir konuma eklenmiş tüm medya dosyalarını döndürür.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Yol

AdTürZorunluAçıklama
locationIdstringzorunluThe 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`.

Yanıtlar

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.

Bir konuma eklenmiş tüm medya dosyalarını (logo, kapak ve ek görseller), her dosyanın herkese açık url değeri, thumbnailUrl değeri, kategorisi, starred olup olmadığı ve tüm zamanları kapsayan viewsCount değeriyle birlikte döndürür.

Kullanım senaryosu: bir konumun fotoğraf galerisini görüntüleyin. Bir işletmenin hâlihazırda yayında olan görsellerini görüntülemek için medya listesini alın; ızgara görünümünde thumbnailUrl, tam boyutlu görünümde ise url kullanın. starred, desteklenen yayın platformlarında öncelikli yerleşim için hangi ek fotoğrafların sabitlendiğini belirtir.

Kullanım senaryosu: yükleme öncesinde medya kapsamını denetleyin. Bir konumda Logo veya Cover kategorisinde bir görselin eksik olup olmadığını görmek için önce bu uç noktayı çağırın, ardından yalnızca eksik olanları yükleyin. Döndürülen id değerleri, yıldız ekleme ve kaldırma uç noktalarına ileteceğiniz değerlerle birebir aynıdır.

Dikkat edilmesi gerekenler.

  • Yolda her iki id biçimi de kullanılabilir: 1800289, TG9jYXRpb246MTgwMDI4OQ== ve TG9jYXRpb246MTgwMDI4OQ%3D%3D aynı konuma karşılık gelir. Bu iki biçimden hiçbirine uymayan bir değer için, SY90002: Invalid Id içeren bir errors dizisi ve null yüküyle birlikte HTTP 200 döndürülür.
  • Medya içermeyen bir konum için { "data": { "mediaFilesOfLocation": [] } } döndürülür; bu, "Jenny Home" gibi yeni oluşturulmuş bir konum için alınan gerçek yanıttır ve bir hata değildir.
Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/photos' \  -H "Authorization: API $LISTINGSAPI_KEY"