Listings APIListings API
Masuk
POST/api/v4/locations/photos/star

Beri bintang pada foto lokasi

Menandai satu atau beberapa foto tambahan suatu lokasi sebagai favorit agar mendapat prioritas penempatan di platform publikasi yang mendukungnya.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Body

NamaTipeWajibDeskripsi
input.locationIdstringwajibThe location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of stringswajibMedia file IDs to star (as returned by the get-photos or upload endpoints).
input.starredbooleanwajib`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.

Contoh permintaan

Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.

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

Respons

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.

Memberi bintang pada foto yang ditentukan untuk suatu lokasi. Foto berbintang mendapat prioritas penempatan di direktori platform publikasi yang mendukung gambar unggulan, sehingga Anda dapat menampilkan foto terbaik di bagian teratas profil bisnis.

Kasus penggunaan: menampilkan gambar utama musiman. Setelah mengunggah foto baru tampak depan toko, beri bintang pada foto tersebut agar tampil pertama di galeri Google dan situs lain yang mendukungnya. Sertakan ID media dari respons unggahan dalam photoIds.

Kasus penggunaan: memilih kumpulan foto merek yang konsisten. Saat mengelola banyak lokasi, beri bintang pada foto tambahan dari kategori yang sama (misalnya, foto eksterior) di setiap lokasi agar galeri yang ditampilkan kepada publik tetap konsisten.

Hal-hal yang perlu diperhatikan.

  • Respons menggunakan kunci starUnstarLocationPhotos, bukan kunci yang dinamai sesuai rute, dan kunci tersebut sama pada /locations/photos/star maupun /locations/photos/unstar.
  • Payload-nya memuat satu objek error, bukan array errors, dan tidak ada clientMutationId. Foto juga tidak memiliki field caption.
  • Hanya foto dalam kategori ADDITIONAL yang dapat diberi bintang. Gambar LOGO dan COVER sudah merupakan gambar utama dan tidak dapat diberi bintang.
  • Satu lokasi dapat memiliki paling banyak 4 foto berbintang; jika batas ini terlampaui, permintaan gagal dengan SY15012. Pemeriksaan ini menghitung foto yang sudah berbintang ditambah foto dalam permintaan ini, dan hanya berlaku ketika starred bernilai true.
  • Untuk membatalkan tindakan ini, gunakan POST /api/v4/locations/photos/unstar dengan starred: false. Nilai starred menentukan tindakan yang dilakukan, bukan path: mengirim starred: true melalui POST ke /unstar akan memberi bintang pada foto.
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