Listings APIListings API
로그인

사진

client.photos를 통해 사업장 사진을 추가하고, 목록을 조회하고, 삭제하고, 별표를 표시합니다.

모든 사진 메서드는 client.photos에 있습니다. upload_status를 제외한 모든 메서드는 location_id을 받으며, location_id은 숫자 또는 base64로 인코딩된 ID를 허용하므로 사업장 ID를 참조하세요.

사진은 multipart form data로 업로드하는 대신 공개 URL로 첨부합니다. 이미지를 호스팅하면 플랫폼이 해당 이미지를 가져오고 백그라운드에서 처리를 계속합니다. 사진 유형은 LOGO, COVER, ADDITIONAL입니다.

photos.list

별표 표시 여부와 관계없이 사업장에 첨부된 미디어 파일을 가져옵니다.

Python
client.photos.list(location_id: str | int) -> list[APIObject]
Python
photos = client.photos.list(16808)for photo in photos:  print(photo.id, photo.categoryName, photo.starred)

mediaFilesOfLocation 목록을 반환합니다. 각 항목에는 id, url, thumbnailUrl, categoryName, categoryId, fileType, starred, viewsCount이 있습니다. id은 remove과 star에 전달하는 값입니다. 사업장 사진 가져오기를 참조하세요.

photos.add

사업장에 사진을 1개 이상 첨부합니다. photos의 각 항목에는 공개 이미지 URL을 값으로 갖는 photo 키와 type 키가 필요합니다.

Python
client.photos.add(    location_id: str | int,    photos: list[dict[str, Any]],) -> APIObject
키유형설명
photostr가져올 이미지의 공개 URL입니다.
typestrLOGO, COVER 또는 ADDITIONAL입니다.
Python
result = client.photos.add(16808, [  {"photo": "https://cdn.example.com/acme-logo.png", "type": "LOGO"},  {"photo": "https://cdn.example.com/acme-storefront.jpg", "type": "ADDITIONAL"},])for photo in result.photos:  print(photo.id, photo.type)

success, photos, request, errors가 포함된 addLocationPhotos 객체를 반환합니다. photos의 각 항목에는 id, databaseId, url, thumbnailUrl, type, starred이 포함됩니다. 사업장에 사진 업로드하기를 참조하세요.

photos.remove

미디어 ID로 사업장에 첨부된 사진을 분리합니다.

Python
client.photos.remove(    location_id: str | int,    photo_ids: list[str],) -> APIObject
Python
result = client.photos.remove(16808, ["TWVkaWFGaWxlOjU4Nzg5MzE="])print(result.removedCount)

removedCount과 errors가 포함된 removeLocationPhotos 객체를 반환합니다. 사업장에서 사진 제거하기를 참조하세요.

photos.star

이 기능을 지원하는 게시 플랫폼에서 사진을 먼저 표시하도록 별표를 표시하거나 해제합니다. 별표 표시를 해제하려면 starred=False을 전달합니다. 계정당 최대 4개의 사진에 별표를 표시할 수 있습니다.

Python
client.photos.star(    location_id: str | int,    media_ids: list[str],    *,    starred: bool = True,) -> APIObject

Python 매개변수의 이름은 media_ids이며, photos.list가 반환하는 것과 동일한 미디어 id 값을 담습니다. SDK가 이 값을 photoIds 필드로 전송하므로 해당 필드를 직접 구성할 필요가 없습니다.

Python
# Star two photosclient.photos.star(16808, ["TWVkaWFGaWxlOjU4Nzg5MzI=", "TWVkaWFGaWxlOjU4Nzg5MzM="]) # Unstar oneresult = client.photos.star(16808, ["TWVkaWFGaWxlOjU4Nzg5MzI="], starred=False)for photo in result.photos:  print(photo.id, photo.starred)

success, photos, error이 포함된 starUnstarLocationPhotos 객체를 반환합니다. 사업장 사진에 별표 표시하기를 참조하세요.

photos.upload_status

사진 일괄 업로드의 진행 상황을 확인합니다. 여러 사진을 한 번에 추가한 후 이미지별 결과가 필요할 때 이 메서드를 폴링합니다.

Python
client.photos.upload_status(request_id: str) -> APIObject
Python
status = client.photos.upload_status("e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a")print(status.to_dict())

사진별 상태 및 오류 필드와 사진에 대해 반환될 수 있는 거부 사유는 사진 일괄 업로드 상태 확인하기를 참조하세요.

관련 문서