Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.
See: Street View Publish API Reference for streetviewpublish.photos.batchGet
.
Synopsis
- type PhotosBatchGetResource = "v1" :> ("photos:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "languageCode" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "photoIds" Text :> (QueryParam "view" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] BatchGetPhotosResponse))))))))))
- photosBatchGet :: PhotosBatchGet
- data PhotosBatchGet
- pbgXgafv :: Lens' PhotosBatchGet (Maybe Xgafv)
- pbgLanguageCode :: Lens' PhotosBatchGet (Maybe Text)
- pbgUploadProtocol :: Lens' PhotosBatchGet (Maybe Text)
- pbgAccessToken :: Lens' PhotosBatchGet (Maybe Text)
- pbgUploadType :: Lens' PhotosBatchGet (Maybe Text)
- pbgPhotoIds :: Lens' PhotosBatchGet [Text]
- pbgView :: Lens' PhotosBatchGet (Maybe Text)
- pbgCallback :: Lens' PhotosBatchGet (Maybe Text)
REST Resource
type PhotosBatchGetResource = "v1" :> ("photos:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "languageCode" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "photoIds" Text :> (QueryParam "view" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] BatchGetPhotosResponse)))))))))) Source #
A resource alias for streetviewpublish.photos.batchGet
method which the
PhotosBatchGet
request conforms to.
Creating a Request
photosBatchGet :: PhotosBatchGet Source #
Creates a value of PhotosBatchGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PhotosBatchGet Source #
Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.
See: photosBatchGet
smart constructor.
Instances
Request Lenses
pbgLanguageCode :: Lens' PhotosBatchGet (Maybe Text) Source #
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.
pbgUploadProtocol :: Lens' PhotosBatchGet (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
pbgAccessToken :: Lens' PhotosBatchGet (Maybe Text) Source #
OAuth access token.
pbgUploadType :: Lens' PhotosBatchGet (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
pbgPhotoIds :: Lens' PhotosBatchGet [Text] Source #
Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`.
pbgView :: Lens' PhotosBatchGet (Maybe Text) Source #
Specifies if a download URL for the photo bytes should be returned in the Photo response.
pbgCallback :: Lens' PhotosBatchGet (Maybe Text) Source #
JSONP