Network.Google.PlayMoviesPartner.Types

Service Configuration

playMoviesPartnerService :: Service

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 :: OAuthScope

View the digital assets you publish on Google Play Movies and TV

Avail

data 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

Eq Avail

Data Avail

Show Avail

Generic Avail

ToJSON Avail

FromJSON Avail

type Rep Avail

avail :: Avail

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
• aSeasonNumber
• aWorkType
• aRatingValue
• aSeasonTitleInternalAlias
• aContentId
• aVideoId
• aSeriesAltId
• aEnd
• aSeriesTitleInternalAlias
• aDisplayName
• aReleaseDate
• aFormatProFile
• aRatingReason
• aEncodeId
• aPriceValue
• aCaptionIncluded
• aProductId
• aSeasonAltId
• aTitleInternalAlias

aAltId :: Lens' Avail (Maybe Text)

Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006"

aPphNames :: Lens' Avail [Text]

Name of the post-production houses that manage the Avail. Not part of EMA Specs.

aCaptionExemption :: Lens' Avail (Maybe Text)

Communicating an exempt category as defined by FCC regulations. It is not required for non-US Avails. Example: "1"

aRatingSystem :: Lens' Avail (Maybe Text)

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)

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)

The number assigned to the episode within a season. Only available on TV Avails. Example: "3".

aPriceType :: Lens' Avail (Maybe Text)

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)

Spoken language of the intended audience. Language shall be encoded in accordance with RFC 5646. Example: "fr".

aEpisodeAltId :: Lens' Avail (Maybe Text)

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)

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)

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)

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 Text)

Type of transaction.

aSeasonNumber :: Lens' Avail (Maybe Text)

The number assigned to the season within a series. Only available on TV Avails. Example: "1".

aWorkType :: Lens' Avail (Maybe Text)

Work type as enumerated in EMA.

aRatingValue :: Lens' Avail (Maybe Text)

Value representing the rating. Ratings should be formatted as per http://www.movielabs.com/md/ratings/ Example: "PG"

aSeasonTitleInternalAlias :: Lens' Avail (Maybe Text)

Title used by involved parties to refer to this season. Only available on TV Avails. Example: "Googlers, The".

aContentId :: Lens' Avail (Maybe Text)

Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".

aVideoId :: Lens' Avail (Maybe Text)

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)

Other identifier referring to the series, as defined by partner. Only available on TV avails. Example: "rs_googlers".

aEnd :: Lens' Avail (Maybe Text)

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)

Title used by involved parties to refer to this series. Only available on TV Avails. Example: "Googlers, The".

aDisplayName :: Lens' Avail (Maybe Text)

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)

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 Text)

Indicates the format profile covered by the transaction.

aRatingReason :: Lens' Avail (Maybe Text)

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)

Manifestation Identifier. This should be the Manifestation Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-7"

aPriceValue :: Lens' Avail (Maybe Text)

Value to be applied to the pricing type. Example: "4" or "2.99"

aCaptionIncluded :: Lens' Avail (Maybe Bool)

Communicating if caption file will be delivered.

aProductId :: Lens' Avail (Maybe Text)

Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-6"

aSeasonAltId :: Lens' Avail (Maybe Text)

Other identifier referring to the season, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1".

aTitleInternalAlias :: Lens' Avail (Maybe Text)

Title used by involved parties to refer to this content. Example: "Googlers, The". Only available on Movie Avails.

ListAvailsResponse

data ListAvailsResponse

Response to the 'ListAvails' method.

See: listAvailsResponse smart constructor.

Instances

Eq ListAvailsResponse

Data ListAvailsResponse

Show ListAvailsResponse

Generic ListAvailsResponse

ToJSON ListAvailsResponse

FromJSON ListAvailsResponse

type Rep ListAvailsResponse

listAvailsResponse :: ListAvailsResponse

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
• larAvails

larNextPageToken :: Lens' ListAvailsResponse (Maybe Text)

See _List methods rules_ for info about this field.

larAvails :: Lens' ListAvailsResponse [Avail]

List of Avails that match the request criteria.

ListExperienceLocalesResponse

data ListExperienceLocalesResponse

Response to the 'ListExperienceLocales' method.

See: listExperienceLocalesResponse smart constructor.

Instances

Eq ListExperienceLocalesResponse

Data ListExperienceLocalesResponse

Show ListExperienceLocalesResponse

Generic ListExperienceLocalesResponse

ToJSON ListExperienceLocalesResponse

FromJSON ListExperienceLocalesResponse

type Rep ListExperienceLocalesResponse

listExperienceLocalesResponse :: ListExperienceLocalesResponse

Creates a value of ListExperienceLocalesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lelrNextPageToken
• lelrExperienceLocales

lelrNextPageToken :: Lens' ListExperienceLocalesResponse (Maybe Text)

See _List methods rules_ for info about this field.

lelrExperienceLocales :: Lens' ListExperienceLocalesResponse [ExperienceLocale]

List of ExperienceLocales that match the request criteria.

ListOrdersResponse

data ListOrdersResponse

Response to the 'ListOrders' method.

See: listOrdersResponse smart constructor.

Instances

Eq ListOrdersResponse

Data ListOrdersResponse

Show ListOrdersResponse

Generic ListOrdersResponse

ToJSON ListOrdersResponse

FromJSON ListOrdersResponse

type Rep ListOrdersResponse

listOrdersResponse :: ListOrdersResponse

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
• lorOrders

lorNextPageToken :: Lens' ListOrdersResponse (Maybe Text)

See _List methods rules_ for info about this field.

lorOrders :: Lens' ListOrdersResponse [Order]

List of Orders that match the request criteria.

ListStoreInfosResponse

data ListStoreInfosResponse

Response to the 'ListStoreInfos' method.

See: listStoreInfosResponse smart constructor.

Instances

Eq ListStoreInfosResponse

Data ListStoreInfosResponse

Show ListStoreInfosResponse

Generic ListStoreInfosResponse

ToJSON ListStoreInfosResponse

FromJSON ListStoreInfosResponse

type Rep ListStoreInfosResponse

listStoreInfosResponse :: ListStoreInfosResponse

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
• lsirStoreInfos

lsirNextPageToken :: Lens' ListStoreInfosResponse (Maybe Text)

See 'List methods rules' for info about this field.

lsirStoreInfos :: Lens' ListStoreInfosResponse [StoreInfo]

List of StoreInfos that match the request criteria.

Order

data 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

Eq Order

Data Order

Show Order

Generic Order

ToJSON Order

FromJSON Order

type Rep Order

order :: Order

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:

• oStatus
• oShowName
• oPphName
• oEarliestAvailStartTime
• oStudioName
• oReceivedTime
• oPriority
• oChannelId
• oCustomId
• oApprovedTime
• oCountries
• oChannelName
• oVideoId
• oLegacyPriority
• oName
• oRejectionNote
• oOrderedTime
• oSeasonName
• oStatusDetail
• oType
• oNormalizedPriority
• oOrderId
• oEpisodeName

oStatus :: Lens' Order (Maybe Text)

High-level status of the order.

oShowName :: Lens' Order (Maybe Text)

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)

Name of the post-production house that manages the Edit ordered.

oEarliestAvailStartTime :: Lens' Order (Maybe Text)

Timestamp of the earliest start date of the Avails linked to this Order.

oStudioName :: Lens' Order (Maybe Text)

Name of the studio that owns the Edit ordered.

oReceivedTime :: Lens' Order (Maybe Text)

Timestamp when the Order was fulfilled.

oPriority :: Lens' Order (Maybe Double)

Order priority, as defined by Google. The higher the value, the higher the priority. Example: 90

oChannelId :: Lens' Order (Maybe Text)

YouTube Channel ID that should be used to fulfill the Order. Example: "UCRG64darCZhb".

oCustomId :: Lens' Order (Maybe Text)

ID that can be used to externally identify an Order. This ID is provided by partners when submitting the Avails. Example: 'GOOGLER_2006'

oApprovedTime :: Lens' Order (Maybe Text)

Timestamp when the Order was approved.

oCountries :: Lens' Order [Text]

Countries where the Order is available, using the "ISO 3166-1 alpha-2" format (example: "US").

oChannelName :: Lens' Order (Maybe Text)

YouTube Channel Name that should be used to fulfill the Order. Example: "Google_channel".

oVideoId :: Lens' Order (Maybe Text)

Google-generated ID identifying the video linked to this Order, once delivered. Example: 'gtry456_xc'.

oLegacyPriority :: Lens' Order (Maybe Text)

Legacy Order priority, as defined by Google. Example: 'P0'

oName :: Lens' Order (Maybe Text)

Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".

oRejectionNote :: Lens' Order (Maybe Text)

Field explaining why an Order has been rejected. Example: "Trailer audio is 2ch mono, please re-deliver in stereo".

oOrderedTime :: Lens' Order (Maybe Text)

Timestamp when the Order was created.

oSeasonName :: Lens' Order (Maybe Text)

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 Text)

Detailed status of the order

oType :: Lens' Order (Maybe Text)

Type of the Edit linked to the Order.

oNormalizedPriority :: Lens' Order (Maybe Text)

A simpler representation of the priority.

oOrderId :: Lens' Order (Maybe Text)

ID internally generated by Google to uniquely identify an Order. Example: 'abcde12_x'

oEpisodeName :: Lens' Order (Maybe Text)

Default Episode name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - Pilot".

ExperienceLocale

data ExperienceLocale

An ExperienceLocale tracks the fulfillment of a Title in a country using a specific language, when delivered using component-based delivery. For example, a Title in Switzerland might have 3 ExperienceLocales: they both share the same country ("CH"), but each has different languages ("de", "fr", and "it"). Each ExperienceLocale is uniquely identified by an `el_id`, which is generated by Google. Externally, an ExperienceLocale can also be identified by partners using its EIDR IDs, AltCutID or `custom_id` (when provided).

See: experienceLocale smart constructor.

Instances

Eq ExperienceLocale

Data ExperienceLocale

Show ExperienceLocale

Generic ExperienceLocale

ToJSON ExperienceLocale

FromJSON ExperienceLocale

type Rep ExperienceLocale

experienceLocale :: ExperienceLocale

Creates a value of ExperienceLocale with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• elTitleLevelEidr
• elStatus
• elPphNames
• elInventoryId
• elEarliestAvailStartTime
• elStudioName
• elPriority
• elCustomIds
• elCreatedTime
• elCountry
• elTrailerId
• elPresentationId
• elAltCutId
• elChannelId
• elApprovedTime
• elPlayableSequenceId
• elElId
• elVideoId
• elName
• elLanguage
• elEditLevelEidr
• elType
• elNormalizedPriority

elTitleLevelEidr :: Lens' ExperienceLocale (Maybe Text)

Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".

elStatus :: Lens' ExperienceLocale (Maybe Text)

High-level status of the ExperienceLocale.

elPphNames :: Lens' ExperienceLocale [Text]

Name of the post-production houses that manage the ExperienceLocale.

elInventoryId :: Lens' ExperienceLocale (Maybe Text)

InventoryID as defined in the EMA specs.

elEarliestAvailStartTime :: Lens' ExperienceLocale (Maybe Text)

Timestamp of the earliest start date of the Avails linked to this ExperienceLocale.

elStudioName :: Lens' ExperienceLocale (Maybe Text)

Name of the studio that owns the ExperienceLocale.

elPriority :: Lens' ExperienceLocale (Maybe Double)

ExperienceLocale priority, as defined by Google. The higher the value, the higher the priority. Example: 90

elCustomIds :: Lens' ExperienceLocale [Text]

List of custom IDs (defined by the partner) linked to this ExperienceLocale. Example: "R86241"

elCreatedTime :: Lens' ExperienceLocale (Maybe Text)

Timestamp when the ExperienceLocale was created.

elCountry :: Lens' ExperienceLocale (Maybe Text)

Country where the ExperienceLocale is available, using the "ISO 3166-1 alpha-2" format. Example: "US".

elTrailerId :: Lens' ExperienceLocale (Maybe Text)

Trailer ID, as defined by Google, linked to the trailer video in the ExperienceLocale. Example: 'gtry457_tr'.

elPresentationId :: Lens' ExperienceLocale (Maybe Text)

PresentationID as defined in the EMA specs.

elAltCutId :: Lens' ExperienceLocale (Maybe Text)

Alternative Cut ID, sometimes available in lieu of the main Edit-level EIDR ID. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".

elChannelId :: Lens' ExperienceLocale (Maybe Text)

YouTube Channel ID linked to the ExperienceLocale. Example: "UCRG64darCZhb".

elApprovedTime :: Lens' ExperienceLocale (Maybe Text)

Timestamp when the ExperienceLocale was approved.

elPlayableSequenceId :: Lens' ExperienceLocale (Maybe Text)

PlayableSequenceID as defined in the EMA specs.

elElId :: Lens' ExperienceLocale (Maybe Text)

ID internally generated by Google to uniquely identify a ExperienceLocale. Example: 'KRZiVjY9h7t'

elVideoId :: Lens' ExperienceLocale (Maybe Text)

Video ID, as defined by Google, linked to the feature video in the ExperienceLocale. Example: 'gtry456_xc'.

elName :: Lens' ExperienceLocale (Maybe Text)

Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".

elLanguage :: Lens' ExperienceLocale (Maybe Text)

Language of the ExperienceLocale, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".

elEditLevelEidr :: Lens' ExperienceLocale (Maybe Text)

Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".

elType :: Lens' ExperienceLocale (Maybe Text)

Type of the Edit linked to the ExperienceLocale.

elNormalizedPriority :: Lens' ExperienceLocale (Maybe Text)

A simpler representation of the priority.

StoreInfo

data 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

Eq StoreInfo

Data StoreInfo

Show StoreInfo

Generic StoreInfo

ToJSON StoreInfo

FromJSON StoreInfo

type Rep StoreInfo

storeInfo :: StoreInfo

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
• siPphNames
• siShowName
• siSubtitles
• siStudioName
• siAudioTracks
• siEpisodeNumber
• siCountry
• siTrailerId
• siHasInfoCards
• siLiveTime
• siSeasonNumber
• siHasHdOffer
• siVideoId
• siName
• siHasVodOffer
• siSeasonName
• siHasSdOffer
• siMid
• siEditLevelEidr
• siType
• siHasEstOffer
• siHasAudio51
• siSeasonId
• siShowId

siTitleLevelEidr :: Lens' StoreInfo (Maybe Text)

Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".

siPphNames :: Lens' StoreInfo [Text]

Name of the post-production houses that manage the Edit.

siShowName :: Lens' StoreInfo (Maybe Text)

Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The".

siSubtitles :: Lens' StoreInfo [Text]

Subtitles available for this Edit.

siStudioName :: Lens' StoreInfo (Maybe Text)

Name of the studio that owns the Edit ordered.

siAudioTracks :: Lens' StoreInfo [Text]

Audio tracks available for this Edit.

siEpisodeNumber :: Lens' StoreInfo (Maybe Text)

The number assigned to the episode within a season. Only available on TV Edits. Example: "1".

siCountry :: Lens' StoreInfo (Maybe Text)

Country where Edit is available in ISO 3166-1 alpha-2 country code. Example: "US".

siTrailerId :: Lens' StoreInfo (Maybe Text)

Google-generated ID identifying the trailer linked to the Edit. Example: 'bhd_4e_cx'

siHasInfoCards :: Lens' StoreInfo (Maybe Bool)

Whether the Edit has info cards.

siLiveTime :: Lens' StoreInfo (Maybe Text)

Timestamp when the Edit went live on the Store.

siSeasonNumber :: Lens' StoreInfo (Maybe Text)

The number assigned to the season within a show. Only available on TV Edits. Example: "1".

siHasHdOffer :: Lens' StoreInfo (Maybe Bool)

Whether the Edit has a HD offer.

siVideoId :: Lens' StoreInfo (Maybe Text)

Google-generated ID identifying the video linked to the Edit. Example: 'gtry456_xc'

siName :: Lens' StoreInfo (Maybe Text)

Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".

siHasVodOffer :: Lens' StoreInfo (Maybe Bool)

Whether the Edit has a VOD offer.

siSeasonName :: Lens' StoreInfo (Maybe Text)

Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World".

siHasSdOffer :: Lens' StoreInfo (Maybe Bool)

Whether the Edit has a SD offer.

siMid :: Lens' StoreInfo (Maybe Text)

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)

Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".

siType :: Lens' StoreInfo (Maybe Text)

Edit type, like Movie, Episode or Season.

siHasEstOffer :: Lens' StoreInfo (Maybe Bool)

Whether the Edit has a EST offer.

siHasAudio51 :: Lens' StoreInfo (Maybe Bool)

Whether the Edit has a 5.1 channel audio track.

siSeasonId :: Lens' StoreInfo (Maybe Text)

Google-generated ID identifying the season linked to the Edit. Only available for TV Edits. Example: 'ster23ex'

siShowId :: Lens' StoreInfo (Maybe Text)

Google-generated ID identifying the show linked to the Edit. Only available for TV Edits. Example: 'et2hsue_x'