Listings APIListings API
サインイン

写真

client.photosを使用して、拠点の写真を追加、一覧表示、削除し、スターを付けます。

写真に関するすべてのメソッドは client.photos にあります。upload_status を除くすべてのメソッドは location_id を引数に取り、location_id は数値または base64 エンコードされた ID を受け付けます。拠点 ID を参照してください。

写真は multipart フォームデータとしてアップロードするのではなく、公開 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 が含まれます。remove と star に渡す値は id です。拠点の写真を取得する を参照してください。

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 を渡します。1 アカウントにつき最大 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())

写真の拒否理由を含む、写真ごとのステータスフィールドとエラーフィールドについては、写真の一括アップロードのステータスを確認する を参照してください。

関連項目