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 |
Synopsis
- playMoviesPartnerService :: ServiceConfig
- playmoviesPartnerReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/playmovies_partner.readonly"]
- data AvailWorkType
- data OrderStatus
- data AvailFormatProFile
- = FormatProFileUnspecified
- | SD
- | HD
- | Uhd
- data Avail
- avail :: Avail
- aAltId :: Lens' Avail (Maybe Text)
- aPphNames :: Lens' Avail [Text]
- aCaptionExemption :: Lens' Avail (Maybe Text)
- aRatingSystem :: Lens' Avail (Maybe Text)
- aSuppressionLiftDate :: Lens' Avail (Maybe Text)
- aEpisodeNumber :: Lens' Avail (Maybe Text)
- aPriceType :: Lens' Avail (Maybe Text)
- aStoreLanguage :: Lens' Avail (Maybe Text)
- aEpisodeAltId :: Lens' Avail (Maybe Text)
- aStart :: Lens' Avail (Maybe Text)
- aTerritory :: Lens' Avail (Maybe Text)
- aEpisodeTitleInternalAlias :: Lens' Avail (Maybe Text)
- aLicenseType :: Lens' Avail (Maybe AvailLicenseType)
- aAvailId :: Lens' Avail (Maybe Text)
- aSeasonNumber :: Lens' Avail (Maybe Text)
- aWorkType :: Lens' Avail (Maybe AvailWorkType)
- aRatingValue :: Lens' Avail (Maybe Text)
- aSeasonTitleInternalAlias :: Lens' Avail (Maybe Text)
- aContentId :: Lens' Avail (Maybe Text)
- aVideoId :: Lens' Avail (Maybe Text)
- aSeriesAltId :: Lens' Avail (Maybe Text)
- aEnd :: Lens' Avail (Maybe Text)
- aSeriesTitleInternalAlias :: Lens' Avail (Maybe Text)
- aDisplayName :: Lens' Avail (Maybe Text)
- aReleaseDate :: Lens' Avail (Maybe Text)
- aFormatProFile :: Lens' Avail (Maybe AvailFormatProFile)
- aRatingReason :: Lens' Avail (Maybe Text)
- aEncodeId :: Lens' Avail (Maybe Text)
- aPriceValue :: Lens' Avail (Maybe Text)
- aCaptionIncluded :: Lens' Avail (Maybe Bool)
- aProductId :: Lens' Avail (Maybe Text)
- aSeasonAltId :: Lens' Avail (Maybe Text)
- aTitleInternalAlias :: Lens' Avail (Maybe Text)
- data OrderType
- data ListAvailsResponse
- listAvailsResponse :: ListAvailsResponse
- larNextPageToken :: Lens' ListAvailsResponse (Maybe Text)
- larAvails :: Lens' ListAvailsResponse [Avail]
- larTotalSize :: Lens' ListAvailsResponse (Maybe Int32)
- data StoreInfoType
- data ListOrdersResponse
- listOrdersResponse :: ListOrdersResponse
- lorNextPageToken :: Lens' ListOrdersResponse (Maybe Text)
- lorTotalSize :: Lens' ListOrdersResponse (Maybe Int32)
- lorOrders :: Lens' ListOrdersResponse [Order]
- data Xgafv
- data OrderNormalizedPriority
- data AvailLicenseType
- = LicenseTypeUnspecified
- | Est
- | Vod
- | Svod
- | Poest
- data OrderStatusDetail
- data ListStoreInfosResponse
- listStoreInfosResponse :: ListStoreInfosResponse
- lsirNextPageToken :: Lens' ListStoreInfosResponse (Maybe Text)
- lsirTotalSize :: Lens' ListStoreInfosResponse (Maybe Int32)
- lsirStoreInfos :: Lens' ListStoreInfosResponse [StoreInfo]
- data Order
- order :: Order
- oStatus :: Lens' Order (Maybe OrderStatus)
- oShowName :: Lens' Order (Maybe Text)
- oPphName :: Lens' Order (Maybe Text)
- oEarliestAvailStartTime :: Lens' Order (Maybe UTCTime)
- oStudioName :: Lens' Order (Maybe Text)
- oReceivedTime :: Lens' Order (Maybe UTCTime)
- oPriority :: Lens' Order (Maybe Double)
- oChannelId :: Lens' Order (Maybe Text)
- oCustomId :: Lens' Order (Maybe Text)
- oApprovedTime :: Lens' Order (Maybe UTCTime)
- oCountries :: Lens' Order [Text]
- oChannelName :: Lens' Order (Maybe Text)
- oVideoId :: Lens' Order (Maybe Text)
- oLegacyPriority :: Lens' Order (Maybe Text)
- oName :: Lens' Order (Maybe Text)
- oRejectionNote :: Lens' Order (Maybe Text)
- oOrderedTime :: Lens' Order (Maybe UTCTime)
- oSeasonName :: Lens' Order (Maybe Text)
- oStatusDetail :: Lens' Order (Maybe OrderStatusDetail)
- oType :: Lens' Order (Maybe OrderType)
- oNormalizedPriority :: Lens' Order (Maybe OrderNormalizedPriority)
- oOrderId :: Lens' Order (Maybe Text)
- oEpisodeName :: Lens' Order (Maybe Text)
- data StoreInfo
- storeInfo :: StoreInfo
- siTitleLevelEidr :: Lens' StoreInfo (Maybe Text)
- siPphNames :: Lens' StoreInfo [Text]
- siShowName :: Lens' StoreInfo (Maybe Text)
- siSubtitles :: Lens' StoreInfo [Text]
- siStudioName :: Lens' StoreInfo (Maybe Text)
- siAudioTracks :: Lens' StoreInfo [Text]
- siEpisodeNumber :: Lens' StoreInfo (Maybe Text)
- siCountry :: Lens' StoreInfo (Maybe Text)
- siTrailerId :: Lens' StoreInfo (Maybe Text)
- siHasInfoCards :: Lens' StoreInfo (Maybe Bool)
- siLiveTime :: Lens' StoreInfo (Maybe UTCTime)
- siSeasonNumber :: Lens' StoreInfo (Maybe Text)
- siHasHdOffer :: Lens' StoreInfo (Maybe Bool)
- siVideoId :: Lens' StoreInfo (Maybe Text)
- siName :: Lens' StoreInfo (Maybe Text)
- siHasVodOffer :: Lens' StoreInfo (Maybe Bool)
- siSeasonName :: Lens' StoreInfo (Maybe Text)
- siHasSdOffer :: Lens' StoreInfo (Maybe Bool)
- siMid :: Lens' StoreInfo (Maybe Text)
- siEditLevelEidr :: Lens' StoreInfo (Maybe Text)
- siType :: Lens' StoreInfo (Maybe StoreInfoType)
- siHasEstOffer :: Lens' StoreInfo (Maybe Bool)
- siHasAudio51 :: Lens' StoreInfo (Maybe Bool)
- siSeasonId :: Lens' StoreInfo (Maybe Text)
- siShowId :: Lens' StoreInfo (Maybe Text)
Service Configuration
playMoviesPartnerService :: ServiceConfig Source #
Default request referring to version v1
of the Google Play Movies Partner API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
playmoviesPartnerReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/playmovies_partner.readonly"] Source #
View the digital assets you publish on Google Play Movies and TV
AvailWorkType
data AvailWorkType Source #
Work type as enumerated in EMA.
TitleTypeUnspecified |
|
Movie |
|
Season |
|
Episode |
|
Bundle |
|
Instances
OrderStatus
data OrderStatus Source #
High-level status of the order.
StatusUnspecified |
|
StatusApproved |
|
StatusFailed |
|
StatusProcessing |
|
StatusUnfulfilled |
|
StatusNotAvailable |
|
Instances
AvailFormatProFile
data AvailFormatProFile Source #
Indicates the format profile covered by the transaction.
FormatProFileUnspecified |
|
SD |
|
HD |
|
Uhd |
|
Instances
Avail
An Avail describes the Availability Window of a specific Edit in a given country, which means the period Google is allowed to sell or rent the Edit. Avails are exposed in EMA format Version 1.6b (available at http://www.movielabs.com/md/avails/) Studios can see the Avails for the Titles they own. Post-production houses cannot see any Avails.
See: avail
smart constructor.
Instances
Creates a value of Avail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aAltId
aPphNames
aCaptionExemption
aRatingSystem
aSuppressionLiftDate
aEpisodeNumber
aPriceType
aStoreLanguage
aEpisodeAltId
aStart
aTerritory
aEpisodeTitleInternalAlias
aLicenseType
aAvailId
aSeasonNumber
aWorkType
aRatingValue
aSeasonTitleInternalAlias
aContentId
aVideoId
aSeriesAltId
aEnd
aSeriesTitleInternalAlias
aDisplayName
aReleaseDate
aFormatProFile
aRatingReason
aEncodeId
aPriceValue
aCaptionIncluded
aProductId
aSeasonAltId
aTitleInternalAlias
aAltId :: Lens' Avail (Maybe Text) Source #
Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006"
aPphNames :: Lens' Avail [Text] Source #
Name of the post-production houses that manage the Avail. Not part of EMA Specs.
aCaptionExemption :: Lens' Avail (Maybe Text) Source #
Communicating an exempt category as defined by FCC regulations. It is not required for non-US Avails. Example: "1"
aRatingSystem :: Lens' Avail (Maybe Text) Source #
Rating system applied to the version of title within territory of Avail. Rating systems should be formatted as per EMA ratings spec Example: "MPAA"
aSuppressionLiftDate :: Lens' Avail (Maybe Text) Source #
First date an Edit could be publically announced as becoming available at a specific future date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY-MM-DD. Only available for pre-orders. Example: "2012-12-10"
aEpisodeNumber :: Lens' Avail (Maybe Text) Source #
The number assigned to the episode within a season. Only available on TV Avails. Example: "3".
aPriceType :: Lens' Avail (Maybe Text) Source #
Type of pricing that should be applied to this Avail based on how the partner classify them. Example: "Tier", "WSP", "SRP", or "Category".
aStoreLanguage :: Lens' Avail (Maybe Text) Source #
Spoken language of the intended audience. Language shall be encoded in accordance with RFC 5646. Example: "fr".
aEpisodeAltId :: Lens' Avail (Maybe Text) Source #
Other identifier referring to the episode, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1_3".
aStart :: Lens' Avail (Maybe Text) Source #
Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: "2013-05-14".
aTerritory :: Lens' Avail (Maybe Text) Source #
ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use Territory in lieu of Country to comply with EMA specifications. But please note that Territory and Country identify the same thing. Example: "US".
aEpisodeTitleInternalAlias :: Lens' Avail (Maybe Text) Source #
OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV Avails. Example: "Coding at Google".
aLicenseType :: Lens' Avail (Maybe AvailLicenseType) Source #
Type of transaction.
aAvailId :: Lens' Avail (Maybe Text) Source #
ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs.
aSeasonNumber :: Lens' Avail (Maybe Text) Source #
The number assigned to the season within a series. Only available on TV Avails. Example: "1".
aRatingValue :: Lens' Avail (Maybe Text) Source #
Value representing the rating. Ratings should be formatted as per http://www.movielabs.com/md/ratings/ Example: "PG"
aSeasonTitleInternalAlias :: Lens' Avail (Maybe Text) Source #
Title used by involved parties to refer to this season. Only available on TV Avails. Example: "Googlers, The".
aContentId :: Lens' Avail (Maybe Text) Source #
Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
aVideoId :: Lens' Avail (Maybe Text) Source #
Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA Specs. Example: 'gtry456_xc'
aSeriesAltId :: Lens' Avail (Maybe Text) Source #
Other identifier referring to the series, as defined by partner. Only available on TV avails. Example: "rs_googlers".
aEnd :: Lens' Avail (Maybe Text) Source #
End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end date is available. Example: "2019-02-17"
aSeriesTitleInternalAlias :: Lens' Avail (Maybe Text) Source #
Title used by involved parties to refer to this series. Only available on TV Avails. Example: "Googlers, The".
aDisplayName :: Lens' Avail (Maybe Text) Source #
The name of the studio that owns the Edit referred in the Avail. This is the equivalent of `studio_name` in other resources, but it follows the EMA nomenclature. Example: "Google Films".
aReleaseDate :: Lens' Avail (Maybe Text) Source #
Release date of the Title in earliest released territory. Typically it is just the year, but it is free-form as per EMA spec. Examples: "1979", "Oct 2014"
aFormatProFile :: Lens' Avail (Maybe AvailFormatProFile) Source #
Indicates the format profile covered by the transaction.
aRatingReason :: Lens' Avail (Maybe Text) Source #
Value representing the rating reason. Rating reasons should be formatted as per EMA ratings spec and comma-separated for inclusion of multiple reasons. Example: "L, S, V"
aEncodeId :: Lens' Avail (Maybe Text) Source #
Manifestation Identifier. This should be the Manifestation Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-7"
aPriceValue :: Lens' Avail (Maybe Text) Source #
Value to be applied to the pricing type. Example: "4" or "2.99"
aCaptionIncluded :: Lens' Avail (Maybe Bool) Source #
Communicating if caption file will be delivered.
aProductId :: Lens' Avail (Maybe Text) Source #
Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-6"
aSeasonAltId :: Lens' Avail (Maybe Text) Source #
Other identifier referring to the season, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1".
aTitleInternalAlias :: Lens' Avail (Maybe Text) Source #
Title used by involved parties to refer to this content. Example: "Googlers, The". Only available on Movie Avails.
OrderType
Type of the Edit linked to the Order.
OTTitleTypeUnspecified |
|
OTMovie |
|
OTSeason |
|
OTEpisode |
|
OTBundle |
|
Instances
ListAvailsResponse
data ListAvailsResponse Source #
Response to the 'ListAvails' method.
See: listAvailsResponse
smart constructor.
Instances
listAvailsResponse :: ListAvailsResponse Source #
Creates a value of ListAvailsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
larNextPageToken :: Lens' ListAvailsResponse (Maybe Text) Source #
See _List methods rules_ for info about this field.
larAvails :: Lens' ListAvailsResponse [Avail] Source #
List of Avails that match the request criteria.
larTotalSize :: Lens' ListAvailsResponse (Maybe Int32) Source #
See _List methods rules_ for more information about this field.
StoreInfoType
data StoreInfoType Source #
Edit type, like Movie, Episode or Season.
SITTitleTypeUnspecified |
|
SITMovie |
|
SITSeason |
|
SITEpisode |
|
SITBundle |
|
Instances
ListOrdersResponse
data ListOrdersResponse Source #
Response to the 'ListOrders' method.
See: listOrdersResponse
smart constructor.
Instances
listOrdersResponse :: ListOrdersResponse Source #
Creates a value of ListOrdersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lorNextPageToken :: Lens' ListOrdersResponse (Maybe Text) Source #
See _List methods rules_ for info about this field.
lorTotalSize :: Lens' ListOrdersResponse (Maybe Int32) Source #
See _List methods rules_ for more information about this field.
lorOrders :: Lens' ListOrdersResponse [Order] Source #
List of Orders that match the request criteria.
Xgafv
V1 error format.
Instances
OrderNormalizedPriority
data OrderNormalizedPriority Source #
A simpler representation of the priority.
NormalizedPriorityUnspecified |
|
LowPriority |
|
HighPriority |
|
Instances
AvailLicenseType
data AvailLicenseType Source #
Type of transaction.
LicenseTypeUnspecified |
|
Est |
|
Vod |
|
Svod |
|
Poest |
|
Instances
OrderStatusDetail
data OrderStatusDetail Source #
Detailed status of the order
OrderStatusUnspecified |
|
OrderStatusQcApproved |
|
OrderStatusQcRejection |
|
OrderStatusInternalFix |
|
OrderStatusOpenOrder |
|
OrderStatusNotAvailable |
|
OrderStatusAwaitingRedelivery |
|
OrderStatusReadyForQc |
|
OrderStatusFileProcessing |
|
Instances
ListStoreInfosResponse
data ListStoreInfosResponse Source #
Response to the 'ListStoreInfos' method.
See: listStoreInfosResponse
smart constructor.
Instances
listStoreInfosResponse :: ListStoreInfosResponse Source #
Creates a value of ListStoreInfosResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsirNextPageToken :: Lens' ListStoreInfosResponse (Maybe Text) Source #
See 'List methods rules' for info about this field.
lsirTotalSize :: Lens' ListStoreInfosResponse (Maybe Int32) Source #
See _List methods rules_ for more information about this field.
lsirStoreInfos :: Lens' ListStoreInfosResponse [StoreInfo] Source #
List of StoreInfos that match the request criteria.
Order
An Order tracks the fulfillment of an Edit when delivered using the legacy, non-component-based delivery. Each Order is uniquely identified by an `order_id`, which is generated by Google. Externally, Orders can also be identified by partners using its `custom_id` (when provided).
See: order
smart constructor.
Instances
Creates a value of Order
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oShowName :: Lens' Order (Maybe Text) Source #
Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".
oPphName :: Lens' Order (Maybe Text) Source #
Name of the post-production house that manages the Edit ordered.
oEarliestAvailStartTime :: Lens' Order (Maybe UTCTime) Source #
Timestamp of the earliest start date of the Avails linked to this Order.
oPriority :: Lens' Order (Maybe Double) Source #
Order priority, as defined by Google. The higher the value, the higher the priority. Example: 90
oChannelId :: Lens' Order (Maybe Text) Source #
YouTube Channel ID that should be used to fulfill the Order. Example: "UCRG64darCZhb".
oCustomId :: Lens' Order (Maybe Text) Source #
ID that can be used to externally identify an Order. This ID is provided by partners when submitting the Avails. Example: 'GOOGLER_2006'
oCountries :: Lens' Order [Text] Source #
Countries where the Order is available, using the "ISO 3166-1 alpha-2" format (example: "US").
oChannelName :: Lens' Order (Maybe Text) Source #
YouTube Channel Name that should be used to fulfill the Order. Example: "Google_channel".
oVideoId :: Lens' Order (Maybe Text) Source #
Google-generated ID identifying the video linked to this Order, once delivered. Example: 'gtry456_xc'.
oLegacyPriority :: Lens' Order (Maybe Text) Source #
Legacy Order priority, as defined by Google. Example: 'P0'
oName :: Lens' Order (Maybe Text) Source #
Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
oRejectionNote :: Lens' Order (Maybe Text) Source #
Field explaining why an Order has been rejected. Example: "Trailer audio is 2ch mono, please re-deliver in stereo".
oSeasonName :: Lens' Order (Maybe Text) Source #
Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".
oStatusDetail :: Lens' Order (Maybe OrderStatusDetail) Source #
Detailed status of the order
oNormalizedPriority :: Lens' Order (Maybe OrderNormalizedPriority) Source #
A simpler representation of the priority.
oOrderId :: Lens' Order (Maybe Text) Source #
ID internally generated by Google to uniquely identify an Order. Example: 'abcde12_x'
oEpisodeName :: Lens' Order (Maybe Text) Source #
Default Episode name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - Pilot".
StoreInfo
Information about a playable sequence (video) associated with an Edit and available at the Google Play Store. Internally, each StoreInfo is uniquely identified by a `video_id` and `country`. Externally, Title-level EIDR or Edit-level EIDR, if provided, can also be used to identify a specific title or edit in a country.
See: storeInfo
smart constructor.
Instances
storeInfo :: StoreInfo Source #
Creates a value of StoreInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siTitleLevelEidr :: Lens' StoreInfo (Maybe Text) Source #
Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
siPphNames :: Lens' StoreInfo [Text] Source #
Name of the post-production houses that manage the Edit.
siShowName :: Lens' StoreInfo (Maybe Text) Source #
Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".
siEpisodeNumber :: Lens' StoreInfo (Maybe Text) Source #
The number assigned to the episode within a season. Only available on TV Edits. Example: "1".
siCountry :: Lens' StoreInfo (Maybe Text) Source #
Country where Edit is available in ISO 3166-1 alpha-2 country code. Example: "US".
siTrailerId :: Lens' StoreInfo (Maybe Text) Source #
Google-generated ID identifying the trailer linked to the Edit. Example: 'bhd_4e_cx'
siLiveTime :: Lens' StoreInfo (Maybe UTCTime) Source #
Timestamp when the Edit went live on the Store.
siSeasonNumber :: Lens' StoreInfo (Maybe Text) Source #
The number assigned to the season within a show. Only available on TV Edits. Example: "1".
siVideoId :: Lens' StoreInfo (Maybe Text) Source #
Google-generated ID identifying the video linked to the Edit. Example: 'gtry456_xc'
siName :: Lens' StoreInfo (Maybe Text) Source #
Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
siSeasonName :: Lens' StoreInfo (Maybe Text) Source #
Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".
siMid :: Lens' StoreInfo (Maybe Text) Source #
Knowledge Graph ID associated to this Edit, if available. This ID links the Edit to its knowledge entity, externally accessible at http://freebase.com. In the absense of Title EIDR or Edit EIDR, this ID helps link together multiple Edits across countries. Example: '/m/0ffx29'
siEditLevelEidr :: Lens' StoreInfo (Maybe Text) Source #
Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
siHasAudio51 :: Lens' StoreInfo (Maybe Bool) Source #
Whether the Edit has a 5.1 channel audio track.