Skip to main content

PhotosRecommendation

Represents the response returned by a photos recommendation request.

Fields

PropertyRequiredTypeDescription
idTruestringUnique ID of the article from the photos recommendation request.
referenceKeyTruestringUnique ID of this recommendation.
photosIdsTrueList[string]IDs of the recommended photos.
altPhotoIdsFalseobjectIDs 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.
photosFalseList[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.
altPhotosFalseobjectAlternative 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.
tagsTrueList[PhotoTag]Tags associated with the recommended photos. Can be used to further refine recommendation results.
nextCursorFalsestringCursor for retrieving the next page. Available when pagination is enabled. For more details, see the cursor field in the recommendation request.