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

Standortfotos als Favoriten markieren

Markiert eines oder mehrere der zusätzlichen Fotos eines Standorts als Favoriten, damit sie auf unterstützten Plattformen bevorzugt platziert werden.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Body

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

Beispielanfrage

Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.

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

Antworten

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.

Markiert die angegebenen Fotos eines Standorts als Favoriten. Als Favoriten markierte Fotos werden in Plattformverzeichnissen, die hervorgehobene Bilder unterstützen, bevorzugt platziert. So bringen Sie Ihre besten Aufnahmen an den Anfang eines Eintrags.

Anwendungsfall: ein saisonales Titelbild hervorheben. Nachdem Sie ein neues Foto der Ladenfront hochgeladen haben, markieren Sie es als Favoriten, damit es die Galerie auf Google und anderen unterstützten Websites anführt. Übergeben Sie die Medien-ID aus der Upload-Antwort in photoIds.

Anwendungsfall: eine einheitliche Bildauswahl für Ihre Marke zusammenstellen. Wenn Sie viele Standorte verwalten, markieren Sie an jedem Standort dieselbe Kategorie zusätzlicher Fotos (zum Beispiel die Außenaufnahme) als Favoriten, um die öffentlich sichtbare Galerie einheitlich zu halten.

Fallstricke.

  • Die Antwort verwendet den Schlüssel starUnstarLocationPhotos, der nicht nach der Route benannt ist, und dieser Schlüssel ist bei /locations/photos/star und /locations/photos/unstar identisch.
  • Die Nutzdaten enthalten ein einzelnes error-Objekt, kein errors-Array, und es gibt kein clientMutationId. Ein Foto hat auch kein caption-Feld.
  • Nur Fotos der Kategorie ADDITIONAL können als Favoriten markiert werden. Bilder der Kategorien LOGO und COVER sind bereits primär und können nicht als Favoriten markiert werden.
  • Ein Standort kann höchstens 4 als Favoriten markierte Fotos haben; wird diese Grenze überschritten, schlägt die Anfrage mit SY15012 fehl. Die Prüfung zählt die bereits als Favoriten markierten Fotos zusammen mit den Fotos in dieser Anfrage und wird nur angewendet, wenn starred den Wert true hat.
  • Um die Aktion rückgängig zu machen, verwenden Sie POST /api/v4/locations/photos/unstar mit starred: false. Der Wert von starred entscheidet, was geschieht, nicht der Pfad: Wenn Sie starred: true per POST an /unstar senden, werden die Fotos als Favoriten markiert.
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