拠点の写真を取得する

名前	型	必須	説明
locationId	string	必須	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`.

名前

型

必須

説明

locationId

string

必須

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

レスポンス

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.

拠点に添付されているすべてのメディアファイル（ロゴ、カバー、追加画像）を、各ファイルの公開url、thumbnailUrl、カテゴリ、starredかどうか、および全期間のviewsCountとともに返します。

ユースケース：拠点のフォトギャラリーを表示する。 メディア一覧を取得し、グリッドにはthumbnailUrl、フルサイズ表示にはurlを使用して、ビジネスがすでに公開している画像を表示します。starredは、対応する掲載先で優先的に配置されるよう固定されている追加写真を示します。

ユースケース：アップロード前にメディアの充足状況を確認する。 最初にこのエンドポイントを呼び出して、拠点にLogoまたはCoverカテゴリの画像が不足しているかどうかを確認し、不足しているものだけをアップロードします。返されるidの値は、スター付与および削除のエンドポイントにそのまま渡す値です。

注意点。

パスではどのID形式も使用できます。1800289、TG9jYXRpb246MTgwMDI4OQ==、TG9jYXRpb246MTgwMDI4OQ%3D%3Dはいずれも同じ拠点を指します。いずれにも該当しない値を指定すると、HTTP 200とともに、SY90002: Invalid Idを含むerrors配列とnullペイロードが返されます。
メディアがない拠点では{ "data": { "mediaFilesOfLocation": [] } }が返されますが、これは「Jenny Home」のような作成直後の拠点に対する実際のレスポンスであり、エラーではありません。

パラメーター

パス

レスポンス