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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- Types
- LatLng
- LocationEnrichment
- DateFilter
- Photo
- TextEnrichment
- Status
- AddEnrichmentToAlbumResponse
- SearchMediaItemsResponse
- JoinSharedAlbumResponse
- CreateAlbumRequest
- Location
- VideoStatus
- NewEnrichmentItem
- ShareInfo
- BatchCreateMediaItemsRequest
- Filters
- StatusDetailsItem
- DateRange
- SharedAlbumOptions
- MediaMetadata
- ShareAlbumResponse
- Video
- MediaItem
- Date
- EnrichmentItem
- ListSharedAlbumsResponse
- MediaTypeFilter
- NewMediaItemResult
- Album
- SimpleMediaItem
- AlbumPositionPosition
- Xgafv
- ContributorInfo
- ListAlbumsResponse
- MapEnrichment
- SearchMediaItemsRequest
- NewMediaItem
- AddEnrichmentToAlbumRequest
- JoinSharedAlbumRequest
- ShareAlbumRequest
- AlbumPosition
- ContentFilter
- BatchCreateMediaItemsResponse
Manage photos, videos, and albums in Google Photos
Synopsis
- photosLibraryService :: ServiceConfig
- photosLibraryReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.readonly"]
- photosLibraryScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary"]
- drivePhotosReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/drive.photos.readonly"]
- photosLibrarySharingScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.sharing"]
- photosLibraryAppendOnlyScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.appendonly"]
- photosLibraryReadOnlyAppcreatedDataScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"]
- type PhotosLibraryAPI = MediaItemsGetResource :<|> (MediaItemsBatchCreateResource :<|> (MediaItemsSearchResource :<|> (AlbumsListResource :<|> (AlbumsShareResource :<|> (AlbumsAddEnrichmentResource :<|> (AlbumsGetResource :<|> (AlbumsCreateResource :<|> (SharedAlbumsListResource :<|> SharedAlbumsJoinResource))))))))
- module Network.Google.Resource.PhotosLibrary.Albums.AddEnrichment
- module Network.Google.Resource.PhotosLibrary.Albums.Create
- module Network.Google.Resource.PhotosLibrary.Albums.Get
- module Network.Google.Resource.PhotosLibrary.Albums.List
- module Network.Google.Resource.PhotosLibrary.Albums.Share
- module Network.Google.Resource.PhotosLibrary.MediaItems.BatchCreate
- module Network.Google.Resource.PhotosLibrary.MediaItems.Get
- module Network.Google.Resource.PhotosLibrary.MediaItems.Search
- module Network.Google.Resource.PhotosLibrary.SharedAlbums.Join
- module Network.Google.Resource.PhotosLibrary.SharedAlbums.List
- data LatLng
- latLng :: LatLng
- llLatitude :: Lens' LatLng (Maybe Double)
- llLongitude :: Lens' LatLng (Maybe Double)
- data LocationEnrichment
- locationEnrichment :: LocationEnrichment
- leLocation :: Lens' LocationEnrichment (Maybe Location)
- data DateFilter
- dateFilter :: DateFilter
- dfDates :: Lens' DateFilter [Date]
- dfRanges :: Lens' DateFilter [DateRange]
- data Photo
- photo :: Photo
- pFocalLength :: Lens' Photo (Maybe Double)
- pCameraMake :: Lens' Photo (Maybe Text)
- pExposureTime :: Lens' Photo (Maybe Scientific)
- pCameraModel :: Lens' Photo (Maybe Text)
- pIsoEquivalent :: Lens' Photo (Maybe Int32)
- pApertureFNumber :: Lens' Photo (Maybe Double)
- data TextEnrichment
- textEnrichment :: TextEnrichment
- teText :: Lens' TextEnrichment (Maybe Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data AddEnrichmentToAlbumResponse
- addEnrichmentToAlbumResponse :: AddEnrichmentToAlbumResponse
- aetarEnrichmentItem :: Lens' AddEnrichmentToAlbumResponse (Maybe EnrichmentItem)
- data SearchMediaItemsResponse
- searchMediaItemsResponse :: SearchMediaItemsResponse
- smirNextPageToken :: Lens' SearchMediaItemsResponse (Maybe Text)
- smirMediaItems :: Lens' SearchMediaItemsResponse [MediaItem]
- data JoinSharedAlbumResponse
- joinSharedAlbumResponse :: JoinSharedAlbumResponse
- data CreateAlbumRequest
- createAlbumRequest :: CreateAlbumRequest
- carAlbum :: Lens' CreateAlbumRequest (Maybe Album)
- data Location
- location :: Location
- lLatlng :: Lens' Location (Maybe LatLng)
- lLocationName :: Lens' Location (Maybe Text)
- data VideoStatus
- = Unspecified
- | Processing
- | Ready
- | Failed
- data NewEnrichmentItem
- newEnrichmentItem :: NewEnrichmentItem
- neiLocationEnrichment :: Lens' NewEnrichmentItem (Maybe LocationEnrichment)
- neiTextEnrichment :: Lens' NewEnrichmentItem (Maybe TextEnrichment)
- neiMapEnrichment :: Lens' NewEnrichmentItem (Maybe MapEnrichment)
- data ShareInfo
- shareInfo :: ShareInfo
- siShareableURL :: Lens' ShareInfo (Maybe Text)
- siShareToken :: Lens' ShareInfo (Maybe Text)
- siSharedAlbumOptions :: Lens' ShareInfo (Maybe SharedAlbumOptions)
- data BatchCreateMediaItemsRequest
- batchCreateMediaItemsRequest :: BatchCreateMediaItemsRequest
- bcmirAlbumId :: Lens' BatchCreateMediaItemsRequest (Maybe Text)
- bcmirNewMediaItems :: Lens' BatchCreateMediaItemsRequest [NewMediaItem]
- bcmirAlbumPosition :: Lens' BatchCreateMediaItemsRequest (Maybe AlbumPosition)
- data Filters
- filters :: Filters
- fDateFilter :: Lens' Filters (Maybe DateFilter)
- fIncludeArchivedMedia :: Lens' Filters (Maybe Bool)
- fMediaTypeFilter :: Lens' Filters (Maybe MediaTypeFilter)
- fContentFilter :: Lens' Filters (Maybe ContentFilter)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data DateRange
- dateRange :: DateRange
- drEndDate :: Lens' DateRange (Maybe Date)
- drStartDate :: Lens' DateRange (Maybe Date)
- data SharedAlbumOptions
- sharedAlbumOptions :: SharedAlbumOptions
- saoIsCollaborative :: Lens' SharedAlbumOptions (Maybe Bool)
- saoIsCommentable :: Lens' SharedAlbumOptions (Maybe Bool)
- data MediaMetadata
- mediaMetadata :: MediaMetadata
- mmCreationTime :: Lens' MediaMetadata (Maybe UTCTime)
- mmPhoto :: Lens' MediaMetadata (Maybe Photo)
- mmHeight :: Lens' MediaMetadata (Maybe Int64)
- mmWidth :: Lens' MediaMetadata (Maybe Int64)
- mmVideo :: Lens' MediaMetadata (Maybe Video)
- data ShareAlbumResponse
- shareAlbumResponse :: ShareAlbumResponse
- sarShareInfo :: Lens' ShareAlbumResponse (Maybe ShareInfo)
- data Video
- video :: Video
- vStatus :: Lens' Video (Maybe VideoStatus)
- vCameraMake :: Lens' Video (Maybe Text)
- vCameraModel :: Lens' Video (Maybe Text)
- vFps :: Lens' Video (Maybe Double)
- data MediaItem
- mediaItem :: MediaItem
- miProductURL :: Lens' MediaItem (Maybe Text)
- miBaseURL :: Lens' MediaItem (Maybe Text)
- miMediaMetadata :: Lens' MediaItem (Maybe MediaMetadata)
- miMimeType :: Lens' MediaItem (Maybe Text)
- miId :: Lens' MediaItem (Maybe Text)
- miContributorInfo :: Lens' MediaItem (Maybe ContributorInfo)
- miDescription :: Lens' MediaItem (Maybe Text)
- data Date
- date :: Date
- dDay :: Lens' Date (Maybe Int32)
- dYear :: Lens' Date (Maybe Int32)
- dMonth :: Lens' Date (Maybe Int32)
- data EnrichmentItem
- enrichmentItem :: EnrichmentItem
- eiId :: Lens' EnrichmentItem (Maybe Text)
- data ListSharedAlbumsResponse
- listSharedAlbumsResponse :: ListSharedAlbumsResponse
- lsarNextPageToken :: Lens' ListSharedAlbumsResponse (Maybe Text)
- lsarSharedAlbums :: Lens' ListSharedAlbumsResponse [Album]
- data MediaTypeFilter
- mediaTypeFilter :: MediaTypeFilter
- mtfMediaTypes :: Lens' MediaTypeFilter [Text]
- data NewMediaItemResult
- newMediaItemResult :: NewMediaItemResult
- nmirStatus :: Lens' NewMediaItemResult (Maybe Status)
- nmirUploadToken :: Lens' NewMediaItemResult (Maybe Text)
- nmirMediaItem :: Lens' NewMediaItemResult (Maybe MediaItem)
- data Album
- album :: Album
- aIsWriteable :: Lens' Album (Maybe Bool)
- aProductURL :: Lens' Album (Maybe Text)
- aShareInfo :: Lens' Album (Maybe ShareInfo)
- aCoverPhotoBaseURL :: Lens' Album (Maybe Text)
- aId :: Lens' Album (Maybe Text)
- aTotalMediaItems :: Lens' Album (Maybe Int64)
- aTitle :: Lens' Album (Maybe Text)
- data SimpleMediaItem
- simpleMediaItem :: SimpleMediaItem
- smiUploadToken :: Lens' SimpleMediaItem (Maybe Text)
- data AlbumPositionPosition
- data Xgafv
- data ContributorInfo
- contributorInfo :: ContributorInfo
- ciProFilePictureBaseURL :: Lens' ContributorInfo (Maybe Text)
- ciDisplayName :: Lens' ContributorInfo (Maybe Text)
- data ListAlbumsResponse
- listAlbumsResponse :: ListAlbumsResponse
- larNextPageToken :: Lens' ListAlbumsResponse (Maybe Text)
- larAlbums :: Lens' ListAlbumsResponse [Album]
- data MapEnrichment
- mapEnrichment :: MapEnrichment
- meDestination :: Lens' MapEnrichment (Maybe Location)
- meOrigin :: Lens' MapEnrichment (Maybe Location)
- data SearchMediaItemsRequest
- searchMediaItemsRequest :: SearchMediaItemsRequest
- smirAlbumId :: Lens' SearchMediaItemsRequest (Maybe Text)
- smirFilters :: Lens' SearchMediaItemsRequest (Maybe Filters)
- smirPageToken :: Lens' SearchMediaItemsRequest (Maybe Text)
- smirPageSize :: Lens' SearchMediaItemsRequest (Maybe Int32)
- data NewMediaItem
- newMediaItem :: NewMediaItem
- nmiSimpleMediaItem :: Lens' NewMediaItem (Maybe SimpleMediaItem)
- nmiDescription :: Lens' NewMediaItem (Maybe Text)
- data AddEnrichmentToAlbumRequest
- addEnrichmentToAlbumRequest :: AddEnrichmentToAlbumRequest
- aetarNewEnrichmentItem :: Lens' AddEnrichmentToAlbumRequest (Maybe NewEnrichmentItem)
- aetarAlbumPosition :: Lens' AddEnrichmentToAlbumRequest (Maybe AlbumPosition)
- data JoinSharedAlbumRequest
- joinSharedAlbumRequest :: JoinSharedAlbumRequest
- jsarShareToken :: Lens' JoinSharedAlbumRequest (Maybe Text)
- data ShareAlbumRequest
- shareAlbumRequest :: ShareAlbumRequest
- sarSharedAlbumOptions :: Lens' ShareAlbumRequest (Maybe SharedAlbumOptions)
- data AlbumPosition
- albumPosition :: AlbumPosition
- apRelativeMediaItemId :: Lens' AlbumPosition (Maybe Text)
- apRelativeEnrichmentItemId :: Lens' AlbumPosition (Maybe Text)
- apPosition :: Lens' AlbumPosition (Maybe AlbumPositionPosition)
- data ContentFilter
- contentFilter :: ContentFilter
- cfIncludedContentCategories :: Lens' ContentFilter [Text]
- cfExcludedContentCategories :: Lens' ContentFilter [Text]
- data BatchCreateMediaItemsResponse
- batchCreateMediaItemsResponse :: BatchCreateMediaItemsResponse
- bcmirNewMediaItemResults :: Lens' BatchCreateMediaItemsResponse [NewMediaItemResult]
Service Configuration
photosLibraryService :: ServiceConfig Source #
Default request referring to version v1
of the Photos Library API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
photosLibraryReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.readonly"] Source #
View your Google Photos library
photosLibraryScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary"] Source #
View and manage your Google Photos library
drivePhotosReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/drive.photos.readonly"] Source #
View the photos, videos and albums in your Google Photos
photosLibrarySharingScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.sharing"] Source #
Manage and add to shared albums on your behalf
photosLibraryAppendOnlyScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.appendonly"] Source #
Add to your Google Photos library
photosLibraryReadOnlyAppcreatedDataScope :: Proxy '["https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata"] Source #
Manage photos added by this app
API Declaration
type PhotosLibraryAPI = MediaItemsGetResource :<|> (MediaItemsBatchCreateResource :<|> (MediaItemsSearchResource :<|> (AlbumsListResource :<|> (AlbumsShareResource :<|> (AlbumsAddEnrichmentResource :<|> (AlbumsGetResource :<|> (AlbumsCreateResource :<|> (SharedAlbumsListResource :<|> SharedAlbumsJoinResource)))))))) Source #
Represents the entirety of the methods and resources available for the Photos Library API service.
Resources
photoslibrary.albums.addEnrichment
photoslibrary.albums.create
photoslibrary.albums.get
photoslibrary.albums.list
photoslibrary.albums.share
photoslibrary.mediaItems.batchCreate
photoslibrary.mediaItems.get
photoslibrary.mediaItems.search
photoslibrary.sharedAlbums.join
photoslibrary.sharedAlbums.list
Types
LatLng
An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
See: latLng
smart constructor.
Instances
Eq LatLng Source # | |
Data LatLng Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LatLng -> c LatLng # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LatLng # toConstr :: LatLng -> Constr # dataTypeOf :: LatLng -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LatLng) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LatLng) # gmapT :: (forall b. Data b => b -> b) -> LatLng -> LatLng # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LatLng -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LatLng -> r # gmapQ :: (forall d. Data d => d -> u) -> LatLng -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LatLng -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # | |
Show LatLng Source # | |
Generic LatLng Source # | |
ToJSON LatLng Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON LatLng Source # | |
type Rep LatLng Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep LatLng = D1 (MetaData "LatLng" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "LatLng'" PrefixI True) (S1 (MetaSel (Just "_llLatitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))) :*: S1 (MetaSel (Just "_llLongitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) |
Creates a value of LatLng
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llLatitude :: Lens' LatLng (Maybe Double) Source #
The latitude in degrees. It must be in the range [-90.0, +90.0].
llLongitude :: Lens' LatLng (Maybe Double) Source #
The longitude in degrees. It must be in the range [-180.0, +180.0].
LocationEnrichment
data LocationEnrichment Source #
An enrichment containing a single location.
See: locationEnrichment
smart constructor.
Instances
locationEnrichment :: LocationEnrichment Source #
Creates a value of LocationEnrichment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leLocation :: Lens' LocationEnrichment (Maybe Location) Source #
Location for this enrichment item.
DateFilter
data DateFilter Source #
This filter defines the allowed dates or date ranges for the media returned. It is possible to pick a set of specific dates and a set of date ranges.
See: dateFilter
smart constructor.
Instances
dateFilter :: DateFilter Source #
Creates a value of DateFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfDates :: Lens' DateFilter [Date] Source #
List of dates that the media items must have been created on. There is a maximum of 5 dates that can be included per request.
dfRanges :: Lens' DateFilter [DateRange] Source #
List of dates ranges that the media items must have been created in. There is a maximum of 5 dates ranges that can be included per request.
Photo
Metadata that is specific to a photo, for example, ISO, focal length and exposure time. Some of these fields may be null or not included.
See: photo
smart constructor.
Instances
Eq Photo Source # | |
Data Photo Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Photo -> c Photo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Photo # dataTypeOf :: Photo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Photo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Photo) # gmapT :: (forall b. Data b => b -> b) -> Photo -> Photo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Photo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Photo -> r # gmapQ :: (forall d. Data d => d -> u) -> Photo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Photo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Photo -> m Photo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Photo -> m Photo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Photo -> m Photo # | |
Show Photo Source # | |
Generic Photo Source # | |
ToJSON Photo Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON Photo Source # | |
type Rep Photo Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep Photo = D1 (MetaData "Photo" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "Photo'" PrefixI True) ((S1 (MetaSel (Just "_pFocalLength") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))) :*: (S1 (MetaSel (Just "_pCameraMake") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pExposureTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GDuration)))) :*: (S1 (MetaSel (Just "_pCameraModel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pIsoEquivalent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pApertureFNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))))) |
Creates a value of Photo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pExposureTime :: Lens' Photo (Maybe Scientific) Source #
Exposure time of the photo.
TextEnrichment
data TextEnrichment Source #
An enrichment containing text.
See: textEnrichment
smart constructor.
Instances
textEnrichment :: TextEnrichment Source #
Creates a value of TextEnrichment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
AddEnrichmentToAlbumResponse
data AddEnrichmentToAlbumResponse Source #
Instances
addEnrichmentToAlbumResponse :: AddEnrichmentToAlbumResponse Source #
Creates a value of AddEnrichmentToAlbumResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aetarEnrichmentItem :: Lens' AddEnrichmentToAlbumResponse (Maybe EnrichmentItem) Source #
- Output only
- Enrichment which was added.
SearchMediaItemsResponse
data SearchMediaItemsResponse Source #
Instances
searchMediaItemsResponse :: SearchMediaItemsResponse Source #
Creates a value of SearchMediaItemsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smirNextPageToken :: Lens' SearchMediaItemsResponse (Maybe Text) Source #
- Output only
- Token to use to get the next set of media items. Its presence is the only reliable indicator of more media items being available in the next request.
smirMediaItems :: Lens' SearchMediaItemsResponse [MediaItem] Source #
- Output only
- List of media items that match the search parameters.
JoinSharedAlbumResponse
data JoinSharedAlbumResponse Source #
Response to successfully joining the shared album on behalf of the user.
See: joinSharedAlbumResponse
smart constructor.
joinSharedAlbumResponse :: JoinSharedAlbumResponse Source #
Creates a value of JoinSharedAlbumResponse
with the minimum fields required to make a request.
CreateAlbumRequest
data CreateAlbumRequest Source #
Request to create an album in Google Photos.
See: createAlbumRequest
smart constructor.
Instances
createAlbumRequest :: CreateAlbumRequest Source #
Creates a value of CreateAlbumRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Location
Represents a physical location.
See: location
smart constructor.
Instances
Eq Location Source # | |
Data Location Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Location -> c Location # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Location # toConstr :: Location -> Constr # dataTypeOf :: Location -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Location) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Location) # gmapT :: (forall b. Data b => b -> b) -> Location -> Location # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Location -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Location -> r # gmapQ :: (forall d. Data d => d -> u) -> Location -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Location -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Location -> m Location # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Location -> m Location # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Location -> m Location # | |
Show Location Source # | |
Generic Location Source # | |
ToJSON Location Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON Location Source # | |
type Rep Location Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep Location = D1 (MetaData "Location" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "Location'" PrefixI True) (S1 (MetaSel (Just "_lLatlng") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LatLng)) :*: S1 (MetaSel (Just "_lLocationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
Creates a value of Location
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
VideoStatus
data VideoStatus Source #
Processing status of the video.
Unspecified |
|
Processing |
|
Ready |
|
Failed |
|
Instances
NewEnrichmentItem
data NewEnrichmentItem Source #
A new enrichment item to be added to an album, used by the AddEnrichmentToAlbum call.
See: newEnrichmentItem
smart constructor.
Instances
newEnrichmentItem :: NewEnrichmentItem Source #
Creates a value of NewEnrichmentItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
neiLocationEnrichment :: Lens' NewEnrichmentItem (Maybe LocationEnrichment) Source #
Location to be added to the album.
neiTextEnrichment :: Lens' NewEnrichmentItem (Maybe TextEnrichment) Source #
Text to be added to the album.
neiMapEnrichment :: Lens' NewEnrichmentItem (Maybe MapEnrichment) Source #
Map to be added to the album.
ShareInfo
Information about albums that are shared. Note that this information is only included if the album was created by you and you have the sharing scope.
See: shareInfo
smart constructor.
shareInfo :: ShareInfo Source #
Creates a value of ShareInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siShareableURL :: Lens' ShareInfo (Maybe Text) Source #
A link to the album that's now shared on the Google Photos website and app. Anyone with the link can access this shared album and see all of the items present in the album.
siShareToken :: Lens' ShareInfo (Maybe Text) Source #
A token which can be used to join this shared album on behalf of other users via the API.
siSharedAlbumOptions :: Lens' ShareInfo (Maybe SharedAlbumOptions) Source #
Options set for the shared album.
BatchCreateMediaItemsRequest
data BatchCreateMediaItemsRequest Source #
Request to create one or more media items in a user's Google Photos
library. If an albumid
is specified, the media items are also added to
that album. albumPosition
is optional and can only be specified if an
albumId
is set.
See: batchCreateMediaItemsRequest
smart constructor.
Instances
batchCreateMediaItemsRequest :: BatchCreateMediaItemsRequest Source #
Creates a value of BatchCreateMediaItemsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcmirAlbumId :: Lens' BatchCreateMediaItemsRequest (Maybe Text) Source #
Identifier of the album where the media item(s) will be added. They will also be added to the user's library. This is an optional field.
bcmirNewMediaItems :: Lens' BatchCreateMediaItemsRequest [NewMediaItem] Source #
List of media items to be created.
bcmirAlbumPosition :: Lens' BatchCreateMediaItemsRequest (Maybe AlbumPosition) Source #
Position in the album where the media item(s) will be added. If not specified, the media item(s) will be added to the end of the album (as per the default value which is LAST_IN_ALBUM). The request will fail if this field is present but no album_id is specified.
Filters
Filters that can be applied to a media item search. If multiple filter options are specified, they are treated as AND with each other.
See: filters
smart constructor.
Instances
Eq Filters Source # | |
Data Filters Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Filters -> c Filters # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Filters # toConstr :: Filters -> Constr # dataTypeOf :: Filters -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Filters) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Filters) # gmapT :: (forall b. Data b => b -> b) -> Filters -> Filters # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Filters -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Filters -> r # gmapQ :: (forall d. Data d => d -> u) -> Filters -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Filters -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Filters -> m Filters # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Filters -> m Filters # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Filters -> m Filters # | |
Show Filters Source # | |
Generic Filters Source # | |
ToJSON Filters Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON Filters Source # | |
type Rep Filters Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep Filters = D1 (MetaData "Filters" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "Filters'" PrefixI True) ((S1 (MetaSel (Just "_fDateFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateFilter)) :*: S1 (MetaSel (Just "_fIncludeArchivedMedia") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_fMediaTypeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MediaTypeFilter)) :*: S1 (MetaSel (Just "_fContentFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentFilter))))) |
Creates a value of Filters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fDateFilter :: Lens' Filters (Maybe DateFilter) Source #
Filters the media items based on their creation date.
fIncludeArchivedMedia :: Lens' Filters (Maybe Bool) Source #
If set, the results will include media items that the user has archived. Defaults to false (archived media items are not included).
fMediaTypeFilter :: Lens' Filters (Maybe MediaTypeFilter) Source #
Filters the media items based on the type of media.
fContentFilter :: Lens' Filters (Maybe ContentFilter) Source #
Filters the media items based on their content.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
DateRange
Defines a range of dates. Both dates must be of the same format (see Date definition for more).
See: dateRange
smart constructor.
Instances
Eq DateRange Source # | |
Data DateRange Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateRange -> c DateRange # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateRange # toConstr :: DateRange -> Constr # dataTypeOf :: DateRange -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateRange) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateRange) # gmapT :: (forall b. Data b => b -> b) -> DateRange -> DateRange # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateRange -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateRange -> r # gmapQ :: (forall d. Data d => d -> u) -> DateRange -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DateRange -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateRange -> m DateRange # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateRange -> m DateRange # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateRange -> m DateRange # | |
Show DateRange Source # | |
Generic DateRange Source # | |
ToJSON DateRange Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON DateRange Source # | |
type Rep DateRange Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep DateRange = D1 (MetaData "DateRange" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "DateRange'" PrefixI True) (S1 (MetaSel (Just "_drEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Date)) :*: S1 (MetaSel (Just "_drStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Date)))) |
dateRange :: DateRange Source #
Creates a value of DateRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drEndDate :: Lens' DateRange (Maybe Date) Source #
The end date (included as part of the range) in the same format as the start date.
drStartDate :: Lens' DateRange (Maybe Date) Source #
The start date (included as part of the range) in one of the formats described.
SharedAlbumOptions
data SharedAlbumOptions Source #
Options that control the sharing of an album.
See: sharedAlbumOptions
smart constructor.
sharedAlbumOptions :: SharedAlbumOptions Source #
Creates a value of SharedAlbumOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saoIsCollaborative :: Lens' SharedAlbumOptions (Maybe Bool) Source #
True if the shared album allows collaborators (users who have joined the album) to add media items to it. Defaults to false.
saoIsCommentable :: Lens' SharedAlbumOptions (Maybe Bool) Source #
True if the shared album allows the owner and the collaborators (users who have joined the album) to add comments to the album. Defaults to false.
MediaMetadata
data MediaMetadata Source #
Metadata for a media item.
See: mediaMetadata
smart constructor.
Instances
mediaMetadata :: MediaMetadata Source #
Creates a value of MediaMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mmCreationTime :: Lens' MediaMetadata (Maybe UTCTime) Source #
Time when the media item was first created (not when it was uploaded to Google Photos).
mmHeight :: Lens' MediaMetadata (Maybe Int64) Source #
Original height (in pixels) of the media item.
ShareAlbumResponse
data ShareAlbumResponse Source #
shareAlbumResponse :: ShareAlbumResponse Source #
Creates a value of ShareAlbumResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sarShareInfo :: Lens' ShareAlbumResponse (Maybe ShareInfo) Source #
- Output only
- Information about the shared album.
Video
Metadata that is specific to a video, for example, fps and processing status. Some of these fields may be null or not included.
See: video
smart constructor.
Instances
Eq Video Source # | |
Data Video Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Video -> c Video # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Video # dataTypeOf :: Video -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Video) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Video) # gmapT :: (forall b. Data b => b -> b) -> Video -> Video # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Video -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Video -> r # gmapQ :: (forall d. Data d => d -> u) -> Video -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Video -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Video -> m Video # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Video -> m Video # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Video -> m Video # | |
Show Video Source # | |
Generic Video Source # | |
ToJSON Video Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON Video Source # | |
type Rep Video Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep Video = D1 (MetaData "Video" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "Video'" PrefixI True) ((S1 (MetaSel (Just "_vStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VideoStatus)) :*: S1 (MetaSel (Just "_vCameraMake") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_vCameraModel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_vFps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double)))))) |
Creates a value of Video
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
MediaItem
Representation of a media item (e.g. photo, video etc.) in Google Photos.
See: mediaItem
smart constructor.
Instances
mediaItem :: MediaItem Source #
Creates a value of MediaItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
miProductURL :: Lens' MediaItem (Maybe Text) Source #
Google Photos URL for the media item. This link will only be available to the user if they're signed in.
miBaseURL :: Lens' MediaItem (Maybe Text) Source #
A URL to the media item's bytes. This should not be used as is. For example, '=w2048-h1024' will set the dimensions of a media item of type photo to have a width of 2048 px and height of 1024 px.
miMediaMetadata :: Lens' MediaItem (Maybe MediaMetadata) Source #
Metadata related to the media item, for example the height, width or creation time.
miId :: Lens' MediaItem (Maybe Text) Source #
Identifier for the media item. This is a persistent identifier that can be used between sessions to identify this media item.
miContributorInfo :: Lens' MediaItem (Maybe ContributorInfo) Source #
Information about the user who created this media item.
miDescription :: Lens' MediaItem (Maybe Text) Source #
Description of the media item. This is shown to the user in the item's info section in the Google Photos app.
Date
Represents a whole calendar date. The day may be 0 to represent a year and month where the day is not significant, e.g. a whole calendar month. The month may be 0 to represent a a day and a year where the month is not signficant, e.g. when you want to specify the same day in every month of a year or a specific year. The year may be 0 to represent a month and day independent of year, e.g. anniversary date.
See: date
smart constructor.
Instances
Eq Date Source # | |
Data Date Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # | |
Show Date Source # | |
Generic Date Source # | |
ToJSON Date Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product | |
FromJSON Date Source # | |
type Rep Date Source # | |
Defined in Network.Google.PhotosLibrary.Types.Product type Rep Date = D1 (MetaData "Date" "Network.Google.PhotosLibrary.Types.Product" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "Date'" PrefixI True) (S1 (MetaSel (Just "_dDay") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_dYear") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_dMonth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) |
dDay :: Lens' Date (Maybe Int32) Source #
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
dYear :: Lens' Date (Maybe Int32) Source #
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
dMonth :: Lens' Date (Maybe Int32) Source #
Month of year. Must be from 1 to 12, or 0 if specifying a date without a month.
EnrichmentItem
data EnrichmentItem Source #
An enrichment item.
See: enrichmentItem
smart constructor.
Instances
enrichmentItem :: EnrichmentItem Source #
Creates a value of EnrichmentItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListSharedAlbumsResponse
listSharedAlbumsResponse :: ListSharedAlbumsResponse Source #
Creates a value of ListSharedAlbumsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsarNextPageToken :: Lens' ListSharedAlbumsResponse (Maybe Text) Source #
- Output only
- Token to use to get the next set of shared albums. Populated if there are more shared albums to retrieve for this request.
lsarSharedAlbums :: Lens' ListSharedAlbumsResponse [Album] Source #
- Output only
- List of shared albums that were requested.
MediaTypeFilter
data MediaTypeFilter Source #
This filter defines the type of media items to be returned, for example videos or photos. All the specified media types are treated as an OR with each other.
See: mediaTypeFilter
smart constructor.
Instances
mediaTypeFilter :: MediaTypeFilter Source #
Creates a value of MediaTypeFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mtfMediaTypes :: Lens' MediaTypeFilter [Text] Source #
The types of media items to be included. This field should only be populated with one media type, multiple media types will result in an error response.
NewMediaItemResult
data NewMediaItemResult Source #
Result of creating a new media item.
See: newMediaItemResult
smart constructor.
Instances
newMediaItemResult :: NewMediaItemResult Source #
Creates a value of NewMediaItemResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nmirStatus :: Lens' NewMediaItemResult (Maybe Status) Source #
If an error occurred during the creation of this media item, this field will be populated with information related to the error. Details of this status can be found down below.
nmirUploadToken :: Lens' NewMediaItemResult (Maybe Text) Source #
The upload token used to create this new media item.
nmirMediaItem :: Lens' NewMediaItemResult (Maybe MediaItem) Source #
Media item created with the upload token. It is populated if no errors occurred and the media item was created successfully.
Album
Representation of an album in Google Photos. Albums are a container for media items. They contain an additional shareInfo property if they have been shared by the application.
See: album
smart constructor.
Instances
Creates a value of Album
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aIsWriteable :: Lens' Album (Maybe Bool) Source #
- Output only
- True if media items can be created in the album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field will be updated.
aProductURL :: Lens' Album (Maybe Text) Source #
- Output only
- Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.
aShareInfo :: Lens' Album (Maybe ShareInfo) Source #
- Output only
- Information related to shared albums. This field is only populated if the album is a shared album, the developer created the album and the user has granted photoslibrary.sharing scope.
aCoverPhotoBaseURL :: Lens' Album (Maybe Text) Source #
- Output only
- A URL to the cover photo's bytes. This should not be used as is. Parameters should be appended to this URL before use. For example, '=w2048-h1024' will set the dimensions of the cover photo to have a width of 2048 px and height of 1024 px.
aId :: Lens' Album (Maybe Text) Source #
- Ouput only
- Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.
aTotalMediaItems :: Lens' Album (Maybe Int64) Source #
- Output only
- The number of media items in the album
aTitle :: Lens' Album (Maybe Text) Source #
Name of the album displayed to the user in their Google Photos account. This string should not be more than 500 characters.
SimpleMediaItem
data SimpleMediaItem Source #
A simple media item to be created in Google Photos via an upload token.
See: simpleMediaItem
smart constructor.
Instances
simpleMediaItem :: SimpleMediaItem Source #
Creates a value of SimpleMediaItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smiUploadToken :: Lens' SimpleMediaItem (Maybe Text) Source #
Token identifying the media bytes which have been uploaded to Google.
AlbumPositionPosition
data AlbumPositionPosition Source #
Type of position, for a media or enrichment item.
PositionTypeUnspecified |
|
FirstInAlbum |
|
LastInAlbum |
|
AfterMediaItem |
|
AfterEnrichmentItem |
|
Instances
Xgafv
V1 error format.
Instances
ContributorInfo
data ContributorInfo Source #
Information about a user who contributed the media item. Note that this information is only included if the album containing the media item is shared, was created by you and you have the sharing scope.
See: contributorInfo
smart constructor.
Instances
contributorInfo :: ContributorInfo Source #
Creates a value of ContributorInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciProFilePictureBaseURL :: Lens' ContributorInfo (Maybe Text) Source #
URL to the profile picture of the contributor.
ciDisplayName :: Lens' ContributorInfo (Maybe Text) Source #
Display name of the contributor.
ListAlbumsResponse
data ListAlbumsResponse Source #
Instances
listAlbumsResponse :: ListAlbumsResponse Source #
Creates a value of ListAlbumsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
larNextPageToken :: Lens' ListAlbumsResponse (Maybe Text) Source #
- Output only
- Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request.
larAlbums :: Lens' ListAlbumsResponse [Album] Source #
- Output only
- List of albums that were created by the user.
MapEnrichment
data MapEnrichment Source #
An enrichment containing a map, showing origin and destination locations.
See: mapEnrichment
smart constructor.
Instances
mapEnrichment :: MapEnrichment Source #
Creates a value of MapEnrichment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
meDestination :: Lens' MapEnrichment (Maybe Location) Source #
Destination location for this enrichemt item.
SearchMediaItemsRequest
data SearchMediaItemsRequest Source #
Request to search for media items in a user's library. If the album id is specified, this call will return the list of media items in the album. If neither filters nor album id are specified, this call will return all media items in a user's Google Photos library. If filters are specified, this call will return all media items in the user's library which fulfills the criteria based upon the filters. Filters and album id must not both be set, as this will result in an invalid request.
See: searchMediaItemsRequest
smart constructor.
Instances
searchMediaItemsRequest :: SearchMediaItemsRequest Source #
Creates a value of SearchMediaItemsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smirAlbumId :: Lens' SearchMediaItemsRequest (Maybe Text) Source #
Identifier of an album. If populated will list all media items in specified album. Cannot be set in conjunction with any filters.
smirFilters :: Lens' SearchMediaItemsRequest (Maybe Filters) Source #
Filters to apply to the request. Cannot be set in conjuction with an albumId.
smirPageToken :: Lens' SearchMediaItemsRequest (Maybe Text) Source #
A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the searchMediaItems request.
smirPageSize :: Lens' SearchMediaItemsRequest (Maybe Int32) Source #
Maximum number of media items to return in the response. The default number of media items to return at a time is 100. The maximum page size is 500.
NewMediaItem
data NewMediaItem Source #
New media item that will be created in a user's Google Photos account.
See: newMediaItem
smart constructor.
Instances
newMediaItem :: NewMediaItem Source #
Creates a value of NewMediaItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nmiSimpleMediaItem :: Lens' NewMediaItem (Maybe SimpleMediaItem) Source #
A new media item that has been uploaded via the included uploadToken.
nmiDescription :: Lens' NewMediaItem (Maybe Text) Source #
Description of the media item. This will be shown to the user in the item's info section in the Google Photos app. This string should not be more than 1000 characters.
AddEnrichmentToAlbumRequest
data AddEnrichmentToAlbumRequest Source #
Request to add an enrichment to a specific album at a specific position.
See: addEnrichmentToAlbumRequest
smart constructor.
Instances
addEnrichmentToAlbumRequest :: AddEnrichmentToAlbumRequest Source #
Creates a value of AddEnrichmentToAlbumRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aetarNewEnrichmentItem :: Lens' AddEnrichmentToAlbumRequest (Maybe NewEnrichmentItem) Source #
The enrichment to be added.
aetarAlbumPosition :: Lens' AddEnrichmentToAlbumRequest (Maybe AlbumPosition) Source #
The position where the enrichment will be inserted.
JoinSharedAlbumRequest
data JoinSharedAlbumRequest Source #
Request to join a shared album on behalf of the user. This uses a shareToken which can be acquired via the shareAlbum or listSharedAlbums calls.
See: joinSharedAlbumRequest
smart constructor.
joinSharedAlbumRequest :: JoinSharedAlbumRequest Source #
Creates a value of JoinSharedAlbumRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsarShareToken :: Lens' JoinSharedAlbumRequest (Maybe Text) Source #
Token indicating the shared album to join on behalf of the user.
ShareAlbumRequest
data ShareAlbumRequest Source #
Request to make an album shared in Google Photos.
See: shareAlbumRequest
smart constructor.
shareAlbumRequest :: ShareAlbumRequest Source #
Creates a value of ShareAlbumRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sarSharedAlbumOptions :: Lens' ShareAlbumRequest (Maybe SharedAlbumOptions) Source #
Options to be set when converting the album to a shared album.
AlbumPosition
data AlbumPosition Source #
Specifies a position in an album.
See: albumPosition
smart constructor.
Instances
albumPosition :: AlbumPosition Source #
Creates a value of AlbumPosition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apRelativeMediaItemId :: Lens' AlbumPosition (Maybe Text) Source #
The media item to which the position is relative to. Only used when position type is AFTER_MEDIA_ITEM.
apRelativeEnrichmentItemId :: Lens' AlbumPosition (Maybe Text) Source #
The enrichment item to which the position is relative to. Only used when position type is AFTER_ENRICHMENT_ITEM.
apPosition :: Lens' AlbumPosition (Maybe AlbumPositionPosition) Source #
Type of position, for a media or enrichment item.
ContentFilter
data ContentFilter Source #
This filter is used to define which results to return based on the
contents of the media item. It is possible to specify a list of
categories to include, and/or a list of categories to exclude. Within
each list, the categories are combined with an OR. For example, if the
content filter looks like: included_content_categories: [c1, c2, c3] It
would get media items that contain (c1 OR c2 OR c3). And if the content
filter looks like: excluded_content_categories: [c1, c2, c3] It would
get media items that contain NOT (c1 OR c2 OR c3). You can also include
some categories while excluding others, as in this proto:
included_content_categories: [c1, c2], excluded_content_category: [c3,
c4] It would get media items that contain (c1 OR c2) AND NOT (c3 OR c4).
A category that appears in includedContentategories
must not appear in
excludedContentCategories
.
See: contentFilter
smart constructor.
Instances
contentFilter :: ContentFilter Source #
Creates a value of ContentFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfIncludedContentCategories :: Lens' ContentFilter [Text] Source #
The set of categories that must be present in the media items in the result. The items in the set are ORed. There is a maximum of 10 includedContentCategories per request.
cfExcludedContentCategories :: Lens' ContentFilter [Text] Source #
The set of categories that must NOT be present in the media items in the result. The items in the set are ORed. There is a maximum of 10 excludedContentCategories per request.
BatchCreateMediaItemsResponse
data BatchCreateMediaItemsResponse Source #
Instances
batchCreateMediaItemsResponse :: BatchCreateMediaItemsResponse Source #
Creates a value of BatchCreateMediaItemsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcmirNewMediaItemResults :: Lens' BatchCreateMediaItemsResponse [NewMediaItemResult] Source #
- Output only
- List of media items which were created.