Listings APIListings API
Oturum aç
POST/api/v4/locations/photos/star

Konum fotoğraflarını yıldızla işaretleme

Desteklenen yayın platformlarında öncelikli yerleşim için bir konumun ek fotoğraflarından birini veya birkaçını favori olarak işaretler.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Gövde

AdTürZorunluAçıklama
input.locationIdstringzorunluThe location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of stringszorunluMedia file IDs to star (as returned by the get-photos or upload endpoints).
input.starredbooleanzorunlu`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.

Örnek istek

Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.

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

Yanıtlar

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.

Bir konum için belirtilen fotoğrafları yıldızla işaretler. Yıldızlı fotoğraflara, öne çıkan görselleri destekleyen yayın platformu dizinlerinde öncelikli yerleşim verilir; böylece en iyi fotoğraflarınızı işletme kaydının en üstüne taşıyabilirsiniz.

Kullanım senaryosu: mevsime uygun bir ana görseli öne çıkarma. Yeni bir mağaza cephesi fotoğrafı yükledikten sonra, Google'da ve desteklenen diğer sitelerde galerinin başında yer alması için fotoğrafı yıldızla işaretleyin. Yükleme yanıtındaki medya kimliğini photoIds içinde iletin.

Kullanım senaryosu: tutarlı bir marka görsel seti oluşturma. Birçok konumu yönetirken, herkese açık galerinin tutarlı olması için her konumda aynı kategorideki ek fotoğrafı (örneğin dış cephe fotoğrafını) yıldızla işaretleyin.

Dikkat edilmesi gerekenler.

  • Yanıtın anahtarı rotanın adını almaz, starUnstarLocationPhotos olarak adlandırılır ve bu anahtar hem /locations/photos/star hem de /locations/photos/unstar için aynıdır.
  • Yanıtın veri yükü, bir errors dizisi yerine tek bir error nesnesi içerir ve clientMutationId içermez. Fotoğrafta da caption alanı bulunmaz.
  • Yalnızca ADDITIONAL kategorisindeki fotoğraflar yıldızla işaretlenebilir. LOGO ve COVER görselleri zaten birincil görsellerdir ve yıldızla işaretlenemez.
  • Bir konumda en fazla 4 yıldızlı fotoğraf olabilir; bu sınır aşıldığında işlem SY15012 ile başarısız olur. Denetim, zaten yıldızlı olan fotoğraflarla bu istekteki fotoğrafların toplamını sayar ve yalnızca starred değeri true olduğunda uygulanır.
  • İşlemi geri almak için POST /api/v4/locations/photos/unstar işlemini starred: false ile gerçekleştirin. Ne yapılacağını yol değil, starred değeri belirler: /unstar yoluna starred: true değerini POST ile göndermek fotoğrafları yıldızla işaretler.
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