Esta seção fornece exemplos de solicitações e respostas para operações comuns da API Avails. Cada exemplo demonstra a estrutura JSON correta e os campos obrigatórios, ajudando você a criar e testar sua integração com o Prime Video. Use esses exemplos como modelos ao enviar e atualizar seus arquivos disponíveis — você pode copiá-los diretamente em seu console para verificar sua implementação antes de entregar conteúdo ao Prime Video.
Criar/atualizar amostras de carga útil da API Avails
A API Avails permite que você crie e atualize janelas de disponibilidade para seu conteúdo no sistema do Prime Video. Esta seção fornece exemplos de solicitações e respostas, demonstrando como estruturar suas chamadas de API para diferentes cenários.
Exemplo 1: Episódio do Canal com vários Avails
Solicitação 1: Disponibilidade em nível de episódio com 2 janelas - Essa solicitação cria disponibilidade para um episódio em um canal de assinatura com dois níveis de formato de vídeo UHD e HD:
{
"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": "adKey",
"Text": "Break776353"
},
{
"_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
}
]
}
]
}
}
Solicitação 2: Disponibilidade em nível de temporada para janela de vídeo
única Essa solicitação cria disponibilidade para toda a Temporada 1 em um canal de assinatura diferente em formato SD:
{
"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
}
]
}
]
}
}
Validar amostras da API Avails
A API Avails permite que você teste suas janelas de disponibilidade em busca de erros antes de enviá-las aos sistemas ao vivo do Prime Video. Esta seção fornece exemplos de solicitações e respostas, demonstrando como estruturar suas chamadas de API para detectar erros logo no início do fluxo de trabalho de integração.
Referências úteis
Você pode se integrar facilmente às nossas APIs do Prime Video. Informações detalhadas sobre como se integrar a cada pacote de API estão disponíveis no guia de integração. Observe que o processo de integração do pacote de API de conteúdo e do pacote de API de análise é separado.
