PhotosRecommendation
Represents the response returned by a photos recommendation request.
Fields
| Property | Required | Type | Description |
|---|---|---|---|
| id | True | string | Unique ID of the article from the photos recommendation request. |
| referenceKey | True | string | Unique ID of this recommendation. |
| photosIds | True | List[string] | IDs of the recommended photos. |
| altPhotoIds | False | object | IDs of alternative photos for each recommended photo, keyed by the recommended photo's ID. Returned only if returnAltPhotos in the recommendation request is set to true. |
| photos | False | List[PhotoData] | Recommended photos as PhotoData objects. Returned only if returnObjects in the recommendation request is set to true. Use the request’s returnObjectFields to limit the fields returned and reduce payload size. |
| altPhotos | False | object | Alternative photos as PhotoData objects, keyed by the recommended photo’s ID. Returned only if both returnAltPhotos and returnObjects in the recommendation request are set to true. |
| tags | True | List[PhotoTag] | Tags associated with the recommended photos. Can be used to further refine recommendation results. |
| nextCursor | False | string | Cursor for retrieving the next page. Available when pagination is enabled. For more details, see the cursor field in the recommendation request. |