POST
/api/v4/locations/photos/remove拠点から写真を削除する
メディアIDを指定して、1つ以上のメディアファイルと拠点の関連付けを解除します。
パラメーター
ボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| input.locationId | string | 必須 | The location's Base64-encoded Relay ID the photos belong to. |
| input.photoIds | array of strings | 必須 | Media file IDs to detach from the location (as returned by the get-photos or upload endpoints). |
リクエストの例
そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "photoIds": [ "TWVkaWFGaWxlOjU4Nzg5MzI=" ] }}レスポンス
200Photos removed. `removedCount` reports how many media files were detached.
{ "data": { "removeLocationPhotos": { "clientMutationId": null, "removedCount": 1, "errors": null } }}401Unauthenticated, missing or invalid API key.
メディアと拠点の関連付けを解除します。削除するファイルは、photoIds(写真取得エンドポイントまたはアップロードエンドポイントが返すID)で指定します。レスポンスのremovedCountは、実際に関連付けが解除されたファイル数を示すため、すでに関連付けが解除されていたIDを検出できます。
ユースケース:古くなった店舗外観画像を削除する。 改装後に拠点の写真を一覧表示し、古くなった追加画像を選択して、そのIDをphotoIdsで渡すと、1回の呼び出しで各掲載先から削除できます。
ユースケース:誤った一括アップロードを取り消す。 自動インポートで誤ったアセットが関連付けられた場合は、アップロードのレスポンスから該当するメディアIDを収集して直ちに削除し、その後、正しいファイルを再アップロードします。
注意点。
- APIで削除できるのは、
ADDITIONALカテゴリの写真のみです。LOGOとCOVERの画像はここでは削除できないため、代わりにアップロードエンドポイントで置き換えてください。 - メディアを削除すると、拠点との関連付けが解除されますが、アカウントのメディアライブラリからファイルが完全に削除されるとは限りません。
removedCountが0で、かつerrors: nullの場合、指定したIDのいずれもその拠点に関連付けられていなかったことを意味します。
Request
curl -X POST 'https://listingsapi.com/api/v4/locations/photos/remove' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "photoIds": [ "TWVkaWFGaWxlOjU4Nzg5MzI=" ] } }'