Listings APIListings API
サインイン
POST/api/v4/locations/photos/star

拠点の写真にスターを付ける

対応する掲載先で優先的に配置されるよう、拠点の追加写真を1枚以上お気に入りに設定します。

API キーが必要です。ヘッダーの形式とキーのローテーションについては認証を参照してください。

パラメーター

ボディ

名前型必須説明
input.locationIdstring必須The location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of strings必須Media file IDs to star (as returned by the get-photos or upload endpoints).
input.starredboolean必須`true` to star the given photos, `false` to unstar them. This flag, not the path, decides what happens: `/star` and `/unstar` behave the same way.

リクエストの例

そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "photoIds": [      "TWVkaWFGaWxlOjU4Nzg5MzI="    ],    "starred": true  }}

レスポンス

200Photos starred. Returns each affected photo with `starred` set to true; `error` is null on success.
Response
{  "data": {    "starUnstarLocationPhotos": {      "success": true,      "photos": [        {          "id": "TWVkaWFGaWxlOjU4Nzg5MzI=",          "databaseId": 5878932,          "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",          "type": "ADDITIONAL",          "starred": true        }      ],      "error": null    }  }}
401Unauthenticated, missing or invalid API key.

拠点の指定した写真にスターを付けます。スター付きの写真は、注目画像に対応する掲載先ディレクトリで優先的に配置されるため、この操作で特に見せたい写真を掲載情報の上部に表示できます。

ユースケース：季節に合ったメイン画像を目立たせる。 新しい店舗外観の写真をアップロードした後、スターを付けて、Google やその他の対応サイトのギャラリーの先頭に表示されるようにします。アップロードのレスポンスに含まれるメディア ID を photoIds に渡します。

ユースケース：ブランドとして統一感のある写真を揃える。 多数の拠点を管理する場合は、各拠点で同じカテゴリの追加写真（たとえば外観写真）にスターを付け、公開ギャラリーに統一感を持たせます。

注意点。

  • レスポンスのキーはルート名に由来するものではなく starUnstarLocationPhotos で、/locations/photos/star と /locations/photos/unstar の両方で同じキーが使われます。
  • そのペイロードには、errors 配列ではなく単一の error オブジェクトが含まれ、clientMutationId はありません。写真にも caption フィールドはありません。
  • スターを付けられるのは、ADDITIONAL カテゴリの写真のみです。LOGO と COVER の画像はすでにメイン画像であるため、スターを付けることはできません。
  • 1つの拠点でスターを付けられる写真は最大 4 枚で、この上限を超えると SY15012 で失敗します。このチェックでは、すでにスターが付いている写真と今回のリクエストに含まれる写真を合計して数え、starred が true の場合にのみ適用されます。
  • この操作を取り消すには、starred: false を指定して POST /api/v4/locations/photos/unstar を実行します。動作を決めるのはパスではなく starred の値です。/unstar に starred: true を POST すると、写真にスターが付きます。
Request
curl -X POST 'https://listingsapi.com/api/v4/locations/photos/star' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "photoIds": [        "TWVkaWFGaWxlOjU4Nzg5MzI="      ],      "starred": true    }  }'
Run in playground