このトピックの各セクションでは、さまざまな利用状況APIペイロードのリクエストと応答の複数の例を紹介します。
利用状況の配置APIの例
チャンネルのSVODエピソードに対して、利用状況の配置の完全回収をリクエストする例
この例は、2つの個別のサブスクリプションチャンネルで、タイトル、事業分野、および地域の組み合わせに対して、利用状況の配置の完全回収を実行する方法を示しています。最初のチャンネルには2つの配信期間があり、2番目のチャンネルには1つの配信期間があります。
1番目のリクエストペイロード：
{
"avail": {
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"ALID": "demoALID",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Episode",
"EpisodeMetadata": {
"TitleInternalAlias": [
"Avail Strikes Back: Season 1, Episode 2"
],
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Avail Strikes Back: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77
},
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Avail Strikes Back"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "availId123",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "mgm_plus_subscription"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "mgm_plus_subscription"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
2番目のリクエストペイロード：
{
"avail": {
"ALID": "demoALID_For_Season_01",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID_For_Season_01",
"WorkType": "Season",
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Avail Strikes Back: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77,
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Avail Strikes Back"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "availId789season",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "A4K"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
FVOD映画の利用状況の配置の完全回収リクエストの例
この例は、無料視聴映画で、タイトル、事業分野、および地域の組み合わせに対して、利用状況の配置の完全回収を実行する方法を示しています。
リクエストペイロード：
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456movie",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
TVOD映画の利用状況の配置の完全回収リクエストの例
この例は、TVOD映画で、タイトル、事業分野、および地域の組み合わせに対して、利用状況の配置の完全回収を実行する方法を示しています。この例には、EST、VOD、およびPOESTのライセンスタイプが含まれています。
リクエストペイロード：
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456movie",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 19.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 18.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "AnnounceDate",
"Event": "2022-05-22T10:00:00Z"
}
]
},
{
"_TransactionID": "availId789movie",
"LicenseType": "POEST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 18.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 17.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "AnnounceDate",
"Event": "2022-05-22T10:00:00Z"
},
{
"_termName": "SuppressionLiftDate",
"Event": "2022-07-24T10:00:00Z"
}
]
}
]
}
}
TVOD映画の利用状況の配置の部分回収リクエストの例
この例は、TransactionIdを配信期間の識別子として使用して、タイトルと地域の組合せに対して利用状況の配置の部分回収を実行する方法を示しています。
リクエストペイロード：
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "prodtest"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
利用状況の配置の部分回収の例
REQUEST
Method: PUT
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId
Body:
{
"avail": {
"Transaction": [
{
"Territory": [
{
"country": "US"
}
],
"Start": "2023-03-14T09:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
],
"End": "2029-05-22T10:00:00Z",
"ContractID": "CPH",
"_TransactionID": "demoTransactionId",
"LicenseRightsDescription": "DAB",
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseType": "SVOD",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
]
}
],
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Asset": [
{
"EpisodeMetadata": {
"TitleInternalAlias": [
"Test Title Name"
],
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesTitleInternalAlias": [
"Test Series Title Name"
],
"SeriesContentID": "demoALID_For_Series"
},
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Test Season Title Name"
],
"SeasonNumber": {
"Number": 1
}
}
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
}
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
利用状況の配置の部分回収バッチの例
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/put
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1",
"body": {
"avail": { ... }
}
},
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2",
"body": {
"avail": { ... }
}
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"requestItemId": "TestRequest1",
"success": true
},
{
"requestItemId": "TestRequest2",
"success": true
}
]
}
利用状況の取得APIの例
利用状況の取得の完全回収の例
REQUEST
Method: GET
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid?territory=US&businessLine=PRIME_SUBSCRIPTION
RESPONSE
StatusCode: 200
Body:
{
"avail": {
"ALID": "demoAlid",
"Asset": [
{
"EpisodeMetadata": {
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonNumber": {
"Number": 1
},
"SeasonTitleInternalAlias": [
"AvailStrikesBack:Season1"
]
},
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"AvailStrikesBack"
]
},
"TitleInternalAlias": [
"TestTitleName"
]
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
},
"Transaction": [
{
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"ContractID": "CPH",
"End": "2029-05-22T10:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseRightsDescription": "DAB",
"LicenseType": "SVOD",
"Start": "2023-03-14T09:00:00Z",
"Terms": [
{
"Text": "prime",
"_termName": "ChannelIdentity"
},
{
"Text": "Yes",
"_termName": "Download"
},
{
"Duration": "PT720H",
"_termName": "RentalDuration"
},
{
"Duration": "PT48H",
"_termName": "WatchDuration"
},
{
"Money": {
"_currency": "USD",
"value": 15.99
},
"_termName": "SRP"
},
{
"Boolean": true,
"_termName": "Exclusive"
},
{
"_termName": "ExclusiveAttributes"
}
],
"Territory": [
{
"country": "US"
}
]
}
]
},
"success": true
}
利用状況の取得の部分回収の例
REQUEST
Method: GET
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId
RESPONSE
StatusCode: 200
Body:
{
"avail": {
"Transaction": [
{
"Territory": [
{
"country": "US"
}
],
"Start": "2023-03-14T09:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
],
"End": "2029-05-22T10:00:00Z",
"ContractID": "CPH",
"_TransactionID": "demoTransactionId",
"LicenseRightsDescription": "DAB",
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseType": "SVOD",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
]
}
],
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Asset": [
{
"EpisodeMetadata": {
"TitleInternalAlias": [
"Test Title Name"
],
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesTitleInternalAlias": [
"Test Series Title Name"
],
"SeriesContentID": "demoALID_For_Series"
},
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Test Season Title Name"
],
"SeasonNumber": {
"Number": 1
}
}
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
}
}
}
利用状況の取得の部分回収バッチの例
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/get
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1"
},
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2"
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"avail": { ... },
"requestItemId": "TestRequest1",
"success": true
},
{
"avail": { ... },
"requestItemId": "TestRequest2",
"success": true
}
]
}
利用状況の削除APIの例
利用状況の削除の完全回収の例
REQUEST
Method: Delete
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid?territory=US&businessLine=PRIME_SUBSCRIPTION&contractId=CPH
RESPONSE:
{
"success": true
}
利用状況の削除の部分回収の例
REQUEST
Method: Delete
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId
RESPONSE:
{
"success": true
}
利用状況の削除の部分回収バッチの例
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/delete
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1"
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2"
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"requestItemId": "TestRequest1",
"success": true
},
{
"requestItemId": "TestRequest2",
"success": true
}
]
}
利用状況の検証APIの例
利用状況の検証の完全回収の例
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid/validate
Body:
{
"avail": {
"ALID": "demoAlid",
"Asset": [
{
"EpisodeMetadata": {
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonNumber": {
"Number": 1
},
"SeasonTitleInternalAlias": [
"AvailStrikesBack:Season1"
]
},
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"AvailStrikesBack"
]
},
"TitleInternalAlias": [
"TestTitleName"
]
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
},
"Transaction": [
{
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"ContractID": "CPH",
"End": "2029-05-22T10:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseRightsDescription": "DAB",
"LicenseType": "SVOD",
"Start": "2023-03-14T09:00:00Z",
"Terms": [
{
"Text": "prime",
"_termName": "ChannelIdentity"
},
{
"Text": "Yes",
"_termName": "Download"
},
{
"Duration": "PT720H",
"_termName": "RentalDuration"
},
{
"Duration": "PT48H",
"_termName": "WatchDuration"
},
{
"Money": {
"_currency": "USD",
"value": 15.99
},
"_termName": "SRP"
},
{
"Boolean": true,
"_termName": "Exclusive"
},
{
"_termName": "ExclusiveAttributes"
}
],
"Territory": [
{
"country": "US"
}
]
}
]
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
利用状況の検証の部分回収の例
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/transactions/demoTransactionId/validate
Body:
{
"avail": {
"Transaction": [
{
"Territory": [
{
"country": "US"
}
],
"Start": "2023-03-14T09:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
],
"End": "2029-05-22T10:00:00Z",
"ContractID": "CPH",
"_TransactionID": "demoTransactionId",
"LicenseRightsDescription": "DAB",
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseType": "SVOD",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
]
}
],
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Asset": [
{
"EpisodeMetadata": {
"TitleInternalAlias": [
"Test Title Name"
],
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesTitleInternalAlias": [
"Test Series Title Name"
],
"SeriesContentID": "demoALID_For_Series"
},
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Test Season Title Name"
],
"SeasonNumber": {
"Number": 1
}
}
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
}
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
利用状況の検証の部分回収バッチの例
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/partial-extract/batch/validate
Body:
{
"requestItems": [
{
"requestItemId": "TestRequest1",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId1/validate",
"body": {
"avail": { ... }
}
{
"requestItemId": "TestRequest2",
"path": "/avails/testlicensor/partial-extract/transactions/demoTransactionId2/validate",
"body": {
"avail": { ... }
}
}
]
}
RESPONSE
StatusCode: 200
Body:
{
"responseItems": [
{
"requestItemId": "TestRequest1",
"success": true
},
{
"requestItemId": "TestRequest2",
"success": true
}
]
}
利用状況の例
Primeサブスクリプションのシーズン利用状況の例
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Season",
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Example: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77,
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Example"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "demoTransactionId",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "prime"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
チャンネルSVODの利用状況の例
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Episode",
"EpisodeMetadata": {
"TitleInternalAlias": [
"Example: Season 1, Episode 2"
],
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Example: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77
},
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Example"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "exampleTransactionId",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "exampleBenefitId"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
FVOD映画の利用状況の例
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Example Movie Title"
]
}
}
],
"Transaction": [
{
"_TransactionID": "exampleTransactionId",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "FIXED_FEE",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
TVOD映画の利用状況の例
{
"avail": {
"ALID": "demoAlid",
"Disposition": {
"EntryType": "PartialExtract"
},
"Licensor": {
"DisplayName": "testLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Asset": [
{
"_contentID": "demoAlid",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Example Movie Title"
]
}
}
],
"Transaction": [
{
"_TransactionID": "exampleTransactionId",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
}
]
}
}
