アベイルズAPI

HTTPコード

説明

再試行可能

200

API呼び出しが成功しました。呼び出し側はレスポンスオブジェクトで詳細を確認する必要があります。

該当なし

400

検証エラーを含む不正なリクエスト。

いいえ

401

許可されていません。

いいえ

404

見つかりません。

いいえ

500

内部エラー。

はい

503

依存関係エラー。

はい

タイプ

説明

Boolean
（ブーリアン）

ブーリアン型。指定できる値：真 (true)、偽 (false)

Integer
（整数）

32ビットの符号付き整数。

LongInteger
（長整数）

64ビットの符号付き整数。

Decimal
（10進）

浮動小数点数。

String
（文字列）

文字の配列。

Timestamp
（タイムスタンプ）

ISOタイムスタンプ。

Enum
（列挙）

あらかじめ定義された許容値のセットを含む列挙文字列。

Struct
（構造）

構造は他の属性を集約する役割を担います。

Array
（配列）

ASME規格品目のコレクション。[]による指定。

属性

タイプ

必須です

説明

avail

Avail

はい

利用可能状況データ - これは、putまたはvalidateリクエストの最上位属性です。

属性

タイプ

必須です

説明

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

requestItems

PutAvailsBatchAPIRequestItem[]

はい

個々のリクエスト一覧

属性

タイプ

必須です

説明

responseItems

PutAvailsBatchAPIResponseItem[]

はい

レスポンス項目の一覧

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子。これは、バッチ内の各項目を識別するために使用する一意の文字列であり、バッチレスポンスにリンクされます。

path

String
（文字列）

はい

このリクエスト項目のリソースへのパス。
完全回収モデルの場合の形式は次のとおりです。
/アベイルズ/{licensor}/完全回収/{ALID}

body

PutAvailsBatchAPIRequestItemBody

はい

利用可能状況データ

属性

タイプ

必須です

説明

avail

Avail

はい

利用可能状況データ

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

avail

Avail

はい

利用可能状況データ

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

requestItems

GetAvailsBatchAPIRequestItem[]

はい

個々のリクエスト一覧

属性

タイプ

必須です

説明

responseItems

GetAvailsBatchAPIResponseItem[]

はい

レスポンス項目の一覧

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子

path

String
（文字列）

はい

このリクエスト項目のリソースへのパス。
完全回収モデルの場合の形式は次のとおりです。
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

属性

タイプ

必須です

説明

requestItemId

文字列

はい

バッチリクエスト内の項目の一意の識別子

success

ブーリアン

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

avail

Avail

いいえ

利用状況オブジェクト

属性

タイプ

必須です

説明

avail

Avail

はい

利用可能状況データ

属性

タイプ

必須です

説明

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

requestItems

ValidateAvailsBatchAPIRequestItem[]

はい

個々のリクエスト一覧

属性

タイプ

必須です

説明

responseItems

ValidateAvailsBatchAPIResponseItem[]

はい

レスポンス項目の一覧

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子

path

String
（文字列）

はい

リクエストのリソースへのパス：
完全回収モデル: /avails/{licensor}/full-extract/{ALID}/validate

body

ValidateAvailsBatchAPIRequestItemBody

はい

リクエスト本文

属性

タイプ

必須です

説明

avail

Avail

はい

利用可能状況データ

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

requestItems

DeleteAvailsBatchAPIRequestItem[]

はい

個々のリクエスト一覧

属性

タイプ

必須です

説明

responseItems

DeleteAvailsBatchAPIResponseItem[]

はい

レスポンス項目の一覧。

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子

path

String
（文字列）

はい

このリクエスト項目のリソースへのパス。
完全回収モデルの場合の形式は次のとおりです。
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}

属性

タイプ

必須です

説明

requestItemId

String
（文字列）

はい

バッチリクエスト内の項目の一意の識別子

success

Boolean
（ブーリアン）

はい

操作ステータス

errors

Error[]

いいえ

障害発生時のエラー一覧

属性

タイプ

必須です

説明

code

String
（文字列）

はい

エラータイプを説明する文字列。
検証エラーコード： APIV{number}、CRMSV{number}
サービスエラーコード： APIE{number}、CRMSE{number}
例： APIV400、CRMSE500

message

String
（文字列）

はい

人間が理解できるエラーの説明

属性

タイプ

必須

注意

EMAファイルマッピング

ALID

String
（文字列）

はい

タイトル識別子を指定します。提出されたメタデータで指定されているALIDと一致する必要があります。

ALID

Disposition

AvailDisposition

はい

回収モデルの粒度を指定します。

該当なし

Licensor

Publisher
（公開者）

はい

Prime Videoにライセンスを付与する企業に関する情報を指定します。

該当なし

Asset

AvailAsset[]

はい

アセットに関する情報。リストには1つのアセットのみを指定する必要があります。

該当なし

Transaction

AvailTrans[]

はい

取引に関する情報。

該当なし

SharedEntitlement

AvailSharedEntitlement[]

いいえ

他のサービスの権限付与に関する情報。

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

EntryType

Enum
（列挙）

はい

指定できる値： 完全回収、完全削除

処分

属性

タイプ

必須

注意

EMAファイルマッピング

DisplayName

String
（文字列）

はい

Prime Videoパートナーの名前を指定します。この値はPrime Videoによってパートナーに提供されます。EMAファイルで使用されている値と同じである必要があります。

DisplayName

属性

タイプ

必須

注意

EMAファイルマッピング

_contentID

String
(文字列)

はい

このアセットのコンテンツIDを指定します。通常はALIDと同じです。

ContentID

WorkType

Enum
(列挙)

はい

指定できる値： 映画、ショート動画、エピソード、シーズン、補足

WorkType

Metadata

Enum

AvailUnitMetadata

条件付き

映画またはショート動画のメタデータを説明します。WorkTypeが映画またはショート動画の場合は必須です。

該当なし

EpisodeMetadata

AvailEpisodeMetadata

条件付き

エピソードのメタデータを説明します。WorkTypeがエピソードの場合は必須です。

該当なし

SeasonMetadata

AvailSeasonMetadata

条件付き

シーズンのメタデータを説明します。WorkTypeがシーズンの場合は必須です。

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

_ecosystem

Enum
（列挙）

はい

指定できる値： DMA
注意： UVVU - 紫外線はサポートされていません。

該当なし

EcosystemID

String
（文字列）

はい

エコシステム固有のタイトル識別子

DMA_ID

属性

タイプ

必須

注意

EMAファイルマッピング

TitleInternalAlias

String[]

はい

タイトル名。リストには1つのタイトル名のみを指定する必要があります。

TitleInternalAlias

属性

タイプ

必須

注意

EMAファイルマッピング

TitleInternalAlias

String[]

はい

エピソードのタイトル名。リストには1つのタイトル名のみを指定する必要があります。

EpisodeTitleInternalAlias

EpisodeNumber

ContentSequenceInfo

はい

シーズン内のこのエピソードの番号。

EpisodeNumber

SeasonMetadata

AvailSeasonMetadata

条件付き

シーズンのメタデータを説明します。WorkTypeがエピソードまたはシーズンの場合は必須。

該当なし

SeriesMetadata

AvailSeriesMetadata

条件付き

シリーズのメタデータを説明します。WorkTypeがエピソードまたはシーズンの場合は必須。

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

SeasonContentID

String
(文字列)

はい

シーズンのALID。

SeasonContentID

SeasonTitleInternalAlias

String[]

いいえ

シーズンのタイトル名。リストには1つのタイトル名のみを指定する必要があります。

SeasonTitleInternalAlias

SeasonNumber

ContentSequenceInfo

はい

シリーズ内のこのシーズンの番号。

SeasonNumber

NumberOfEpisodes

Integer
(整数)

はい

このシーズン内のエピソード数。

EpisodeCount

SeriesMetadata

AvailSeriesMetadata

条件付き

シリーズのメタデータを説明します。WorkTypeがシーズンの場合は必須です。

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

SeriesContentID

String
(文字列)

はい

シリーズのALID。

SeriesContentID

SeriesTitleInternalAlias

String[]

いいえ

シリーズのタイトル名。リストには1つのタイトル名のみを指定する必要があります。

SeriesTitleInternalAlias

NumberOfSeasons

Integer
(整数)

いいえ

このシリーズ内のシーズン数。

SeasonCount

属性

タイプ

必須

注意

EMAファイルマッピング

_TransactionID

String
(文字列)

いいえ

利用可能状況枠の一意の識別子。FullExtractを使用する場合はオプションです。

AvailID

LicenseType

Enum
(列挙)

はい

指定できる値： SVOD、FVOD、EST、POEST、VOD

LicenseType

Territory

Region[]

はい

配信が許可されている地域。1つの地域項目のみを提供する必要があります。1つの利用状況オブジェクト内のすべての取引は、同じ地域である必要があります。

地域

Start

DateTime

はい

ISO形式による配信の開始日時。

注意： タイムゾーンが指定されていない場合、当該地域で最も東側のタイムゾーンを使用します。ただし、特定のリリース時刻を希望する場合は、任意のタイムゾーンを指定できます。

開始

End

DateTime

いいえ

ISO形式による配信の終了日時。指定しない場合、配信期間は無制限です。

注意： タイムゾーンが指定されていない場合、当該地域で最も東側のタイムゾーンを使用します。ただし、特定の削除時間を指定する場合は、任意のタイムゾーンを含めることができます。

終了

AssetLanguage

AssetLanguage[]

いいえ

アセットの言語は、アセットタイプのISO言語コードとして表されます。許可されているアセットタイプ： 字幕、音声、サブ吹き替え、サブ、吹き替え、オリジナル版音声、マルチトラック音声、任意

AssetLanguage

AllowedLanguage

AssetLanguage[]

いいえ

ISO言語コードとアセットタイプ。許可されているアセットタイプ： 字幕、音声、サブ、吹き替え、サブ吹き替え、任意

AllowedLanguages

HoldbackLanguage

AssetLanguage[]

いいえ

ISO言語コードとアセットタイプ。許可されているアセットタイプ： 字幕、音声、サブ、吹き替え、サブ吹き替え、任意

HoldbackLanguage

LicenseRightsDescription

String
(文字列)

いいえ

公開の優先順位を指定するために使用します。

LicenseRightsDescription

FormatProfile

AvailFormatProfile

はい

利用可能なビデオの画質。指定できる値： SD、HD、UHD

FormatProfile

ContractID

String
(文字列)

いいえ

契約情報を指定します。指定できる値：
- CPH
- FIXED_FEE
- FIXED_FEE:{Deal ID}
アベイルズを送信する場合、FIXED_FEEオプションはライセンサーによって制限されます。

ContractID

Terms

AvailTerms[]

はい

利用可能状況枠の取引条件のリストを指定します。

OtherTerms

OtherInstructions

String
(文字列)

いいえ

利用可能状況枠に関する追加処理方法。

OtherInstructions

属性

タイプ

必須

注意

EMAファイルマッピング

country

String
(文字列)

はい

2文字のISO 3166-1国コード

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

value

String
(文字列)

はい

アセットの言語は、アセットタイプのRFC 5646言語コードとして表されます。

該当なし

_asset

String
(文字列)

いいえ

AvailTransタイプの言語属性に応じて、異なる値のセットを使用できます。
AvailTrans.AssetLanguageに指定できる値：
字幕、音声、サブ吹き替え、サブ、吹き替え、オリジナル版音声、マルチトラック音声、任意。
この属性には、すべての言語で同じアセットを提出する必要があります。
AvailTrans.AllowedLanguageおよびAvailTransに指定できる値。HoldbackLanguage：
字幕、音声、サブ、吹き替え、サブ吹き替え、任意。
アセットの値が「サブ吹き替え」、「任意」、または「値なし」の場合は、「字幕」と「音声」の2つのアセットに分散されます。
アセットの「サブ」と「吹き替え」は、MDDFの同等の「字幕」と「音声」に変換されます。

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

value

Enum
(列挙)

はい

利用可能なビデオの画質。指定できる値： SD、HD、UHD

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

_termName

String
(文字列)

はい

条件を識別します。値は大文字と小文字を区別しません。指定できる値のリストについては、以下を参照してください。

該当なし

Money

Money

いいえ

詳細については、以下を参照してください。

該当なし

Text

String
(文字列)

いいえ

詳細については、以下を参照してください。

該当なし

Event

DateTime

いいえ

詳細については、以下を参照してください。

該当なし

Boolean

Boolean
(ブーリアン)

いいえ

詳細については、以下を参照してください。

該当なし

Duration

String
(文字列)

いいえ

詳細については、以下を参照してください。

該当なし

Number

Integer
(整数)

いいえ

詳細については、以下を参照してください。

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

value

Decimal
(10進)

いいえ

金額の値、一部の価格タイプでは必須

該当なし

_currency

String
(文字列)

はい

ISO通貨コード

該当なし

属性

タイプ

必須

注意

EMAファイルマッピング

Number

Integer
(整数)

はい

エピソード番号やシーズン番号などの、コンテンツシークエンス番号

該当なし

条件名

属性

必須

注意

EMAファイルマッピング

ChannelIdentity

Text
(テキスト)

はい

チャンネルまたはチャンネル登録の識別子。

GroupIdentity

Tier

Text
(テキスト)

条件付き

価格階層。ライセンスタイプがPOESTの場合は必須。

PriceType

SRP

Money

条件付き

希望小売価格。ライセンスタイプがPOESTの場合は必須。

SRP

WSP

Money

条件付き

卸売価格。ライセンスタイプがPOESTの場合は必須。

PriceValue

Category

Text
(テキスト)

条件付き

価格カテゴリー。ライセンスタイプがPOESTの場合は必須。

PriceValue

AnnounceDate

Event
(イベント)

いいえ

利用可能状況対象地域におけるタイトルの利用開始日を小売業者が発表できる日付。

AnnounceDate

SuppressionLiftDate

Event
(イベント)

条件付き

あるタイトルが将来の特定の日付に、利用可能な地域で、利用可能になることを公表できる最初の日付。ライセンスタイプがPOESTの場合は必須。

SuppressionLiftDate

RentalDuration

Duration
(期間)

条件付き

時間単位のレンタル期間。ライセンスタイプがSVODの場合は必須。

RentalDuration

WatchDuration

Duration
(期間)

条件付き

開始後、ユーザーが視聴を完了するまでの時間 (時間単位)。ライセンスタイプがSVODの場合は必須。

WatchDuration

Download

Text
(テキスト)

いいえ

ライセンスにはダウンロードの許可が含まれています。有効な値は はいといいえです。ライセンスタイプがSVODの場合、レンタル期間と視聴期間の両方を指定する必要があります。

ダウンロード

Exclusive

Boolean
(ブーリアン)

いいえ

アセットは取引の範囲内でのみ独占可能です。

独占

ExclusiveAttributes

Text
(テキスト)

いいえ

独占のタイプを指定します。独占がtrueの場合にのみ考慮されます。独占がtrueの場合、指定しない場合はデフォルト値が使用されます。

ExclusiveAttributes

BrandingRights

Boolean
(ブーリアン)

いいえ

ブランディングを表示したいというパートナーの意図を示します。

BrandingRights

BrandingRightsAttributes

Text
(テキスト)

いいえ

ブランディングのテキストを指定します。BrandingRightsがtrueの場合にのみ考慮されます。BrandingRightsがtrueの場合、指定しない場合はデフォルト値が使用されます。

BrandingRightsAttributes

allowAds

Boolean
(ブーリアン)

いいえ

広告を許可するか禁止するかを決定します。この条件は1回しか使用できません。

EMAでは使用できません

allowedAdPlacement

Text
(テキスト)

条件付き

広告を挿入できるロール内の位置を指定します。指定できる値： PreRoll、MidRoll、PostRoll、Overlays、PauseAds、Squeezebacks。
指定できるのは、allowAdsがtrueに設定されている場合のみです。
この条件は複数回表示される可能性があります。allowedAdPlacementまたはprohibitedAdPlacementのいずれかを指定できますが、両方は指定できません。

EMAでは使用できません

prohibitedAdPlacement

Text
(テキスト)

条件付き

広告を挿入できないロール内の位置を指定します。指定できる値： PreRoll、MidRoll、PostRoll、Overlays、PauseAds、Squeezebacks。
この条件は複数回表示される可能性があります。
指定できるのは、allowAdsがtrueに設定されている場合のみです。
allowedAdPlacementまたはprohibitedAdPlacementのいずれかを指定できますが、両方は指定できません。

EMAでは使用できません

cuepointDeliveryAndUsage

Text
(テキスト)

いいえ

キューポイントの配信と使用義務を指定します。指定できる値： 指定できる値：PartnerWillDeliverAndPrimeVideoMustUse、PrimeVideoWillUseIfDelivered、NoDeliveryOrUsageObligations、TalentObligated。
指定できるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

blindBasisSelling

Text
(テキスト)

いいえ

指定できる値： GuaranteedImpressions、NoGuaranteedImpressions
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

sponsorships

Text
(テキスト)

いいえ

指定できる値： Permitted、Prohibited、PermittedWithRestrictions。
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

sponsorshipsRestrictions

Text
(テキスト)

条件付き

自由形式のテキスト
この属性を使用する必要があるのは、スポンサーがAllowedWithRestrictionsに設定されている場合のみです。

EMAでは使用できません

talentAndAmazonAdGuidelines

Text
(テキスト)

いいえ

指定できる値： NoRestrictions。ConsultationRequired
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

talentRestrictions

Text
(テキスト)

条件付き

自由形式のテキスト
この属性を使用する必要があるのは、talentAndAmazonAdGuidelinesがConsultationRequiredに設定されている場合のみです。

EMAでは使用できません

adLoadLimit

Text
(テキスト)

いいえ

1時間あたりの広告の分数。値は有効な整数でなければなりません。
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

AdKey

Text
(テキスト)

いいえ

自由形式のテキスト
コンテンツを広告管理サーバーにマッピングするための一意の識別子。

EMAでは使用できません

CompleteYourBundleDiscountPercentage

Number
(数値)

いいえ

購入者がまだ所有していない残りのタイトルを購入してバンドルを完成させると、パーセント割引が適用されます。たとえば、20%割引の場合、2シーズン構成のバンドルでシーズン1を所有しているお客様はシーズン2を20%割引で購入できます。

EMAでは使用できません

ExcludedFromBundleDiscount

Boolean
(ブーリアン)

いいえ

trueに設定すると、この利用可能状況枠をバンドル割引の対象から除外します。プレミアム価格期間 (例：新作リリース時) や、定価を維持する必要があるタイトルに使用します。設定なしまたはfalseの場合、当該タイトルはバンドル割引の対象となります。

EMAでは使用できません

値

説明

TVOD

TVODは購入またはレンタルを意味します。関連するライセンスタイプ： EST、VOD、POEST

PRIME_SUBSCRIPTION

AmazonプライムまたはAmazon Kids+のチャンネル登録。関連するライセンスタイプ： SVOD

CHANNELS

サードパーティのチャンネル登録。関連するライセンスタイプ： SVOD

FVOD

無料コンテンツ。関連するライセンスタイプ： FVOD